Ghidul începătorului pentru a scrie propriul cod scurt personalizat

Shortcodes sunt o caracteristică populară inclusă în multe plugin-uri și teme. Cu toate acestea, dacă nu v-ați construit niciodată propriile shortcodes înainte, este posibil să nu aveți nicio idee despre cum să le adăugați la propriile proiecte WordPress.

Din fericire, API-ul Shortcode al WordPress face destul de simplă crearea propriilor shortcodes. Făcând acest lucru le va permite utilizatorilor să profite de caracteristicile plugin-ului sau temei dvs. din orice zonă bazată pe text de pe site-ul lor WordPress. Includerea shortcodes în proiectele dvs. este o modalitate ușoară de a vă baza pe funcționalitatea pe care ați creat-o deja, astfel încât să obțineți cel mai mult pentru banii dvs..

În acest articol, vom vorbi un pic mai mult despre cum funcționează shortcodes. Apoi, vă vom arăta cât de simplu poate fi să vă programați unul propriu în trei pași. Să începem!

O introducere în Shortcodes și Shortcode API

The WordPress Shortcode API este un instrument la îndemână pentru dezvoltatori.

Shortcodes arată ca niște mici bucăți de text între paranteze pătrate, ca acesta: . Fiecare dintre ele reprezintă o execuție unică de cod predefinit, care este declanșată la cerere. Le puteți utiliza aproape oriunde se poate adăuga text în WordPress.

În timp ce majoritatea codurilor scurte sunt adăugate de teme și pluginuri, nucleul WordPress are câteva coduri scurte implicite pe care le puteți utiliza. Câteva exemple dintre acestea sunt audio, gallery și caption.

De exemplu, atunci când adăugați o imagine cu o legendă, WordPress generează un anumit shortcode:

Când vizualizați acest lucru în partea frontală, veți vedea o imagine cu o legendă:

Din fericire, Shortcode API face relativ simplă crearea de coduri scurte personalizate pentru propriile proiecte WordPress. Aceasta este adesea o idee inteligentă, deoarece ușurează viața utilizatorilor dumneavoastră, permițându-le să utilizeze funcționalități complexe cu doar câteva apăsări de taste.

Cum să scrieți propriul shortcode personalizat (în 3 pași simpli)

Acum că ați înțeles cum funcționează shortcodes, haideți să învățăm cum să adăugăm unul la propria temă sau plugin! Bineînțeles, ceea ce face shortcode-ul tău va depinde de tine. În acest exemplu, vom folosi o simplă funcție „Hello world!” pentru a începe.

Scrieți funcția shortcode

Prima dată, veți dori să deschideți un nou fișier într-un editor de text. Apoi, scrieți o funcție cu un nume unic, care va executa codul pe care doriți ca shortcode-ul să îl declanșeze:

function torque_hello_world_shortcode() { return 'Hello world!';}

Dacă ar fi să folosim această funcție în mod normal, aceasta ar returna Hello world! ca un șir de caractere care ar putea fi ieșit în HTML. Această funcție poate primi, de asemenea, parametri personalizați. De exemplu, dacă doriți ca cineva să poată să o facă să spună în schimb Hello Bob! în loc de Hello Bob, ați putea adăuga un parametru nume. Acești parametri se numesc atribute și toți sunt gestionați folosind o singură matrice predefinită ca $atts de către WordPress.

Iată un exemplu de utilizare a funcției shortcode $atts pentru a gestiona corect atributele shortcode în WordPress. Puteți afla mai multe despre cum funcționează acest lucru pentru propriile nevoi în codexul WordPress:

function torque_hello_world_shortcode( $atts ) { $a = shortcode_atts( array( 'name' => 'world' ), $atts ); return 'Hello ' . $a . !';}

Aceasta definește implicit atributul name la world dacă nu este disponibil alt nume. Dacă este furnizat un nume, funcția îl va afișa în locul acestuia. Iată un exemplu de cum ar fi executat acest lucru cu un shortcode:

// Outputs "Hello world!" // Outputs "Hello Bob!"

După ce ați terminat, aceasta poate fi utilizată în toate zonele bazate pe text de pe un site WordPress în care este instalat pluginul sau tema care conține acest shortcode.

Salvați fișierul și adăugați-l la proiectul dvs.

După ce shortcode-ul dvs. este gata, puteți crea un nou fișier în tema sau plugin-ul dvs. personalizat pentru a salva funcția. Un nume descriptiv vă va ajuta să găsiți acest fișier mai târziu (de exemplu: shortcode-function-hello-world.php).

Acum, este timpul să spuneți restului proiectului dvs. despre acest nou fișier. Dacă lucrați cu o temă, veți dori să îl includeți în fișierul functions.php. Dacă construiți un plugin, îl puteți include în orice fișier deja încărcat în proiect.

Iată un exemplu despre cum ați putea încărca fișierul într-o temă folosind get_stylesheet_directory(). Asigurați-vă că editați calea fișierului pentru a se potrivi cu structura dosarelor din interiorul temei dvs.:

include( get_stylesheet_directory() . 'path/to/shortcode-function-hello-world.php' );

Pe de altă parte, iată cum arată încărcarea fișierului într-un plugin, folosind plugin_dir_url(). Din nou, editați calea către fișier pentru a se potrivi cu structura folderului plugin-ului dvs.:

include( plugin_dir_url( __FILE__ ) . 'path/to/shortcode-function-hello-world.php' );

În acest punct, funcția dvs. este acum disponibilă pentru utilizare! Tot ce a mai rămas este să înregistrați activ codul scurt în WordPress.

Înregistrați codul scurt

Ultimul pas este să înregistrați noul dvs. cod scurt cu Shortcode API. Acest lucru se face cu ajutorul funcției add_shortcode. Aceasta necesită două argumente:

  1. Eticheta shortcode care urmează să fie utilizată în cadrul editorului de text
  2. Numele funcției care se ocupă de execuția shortcode-ului

Desubtul funcției shortcode, includeți această linie de cod și actualizați-o pentru a se potrivi cu propriile valori:

add_shortcode( 'helloworld', 'torque_hello_world_shortcode' );

Prima valoare va merge între paranteze pătrate în editorul de text. A doua se va potrivi cu numele funcției pe care l-ați scris în cei doi pași anteriori. Ambele ar trebui să fie suficient de unice, astfel încât să nu interfereze cu alte shortcodes incluse de nucleul WordPress, teme sau pluginuri.

După ce ați terminat, tot ce a mai rămas este să îl testați. Conectați-vă la administratorul WordPress și încercați să adăugați codul scurt la o postare:

Asta este tot ce trebuie făcut! Codul dvs. scurt poate fi oricât de complicat sau de simplu doriți – ceea ce decideți să construiți folosind această putere depinde de dvs. Pentru situații avansate în care ați dori să modificați ieșirea pentru diferite situații, ar putea merita să scrieți o clasă PHP unică pentru a gestiona noul dvs. shortcode.

Concluzie

Adaugarea de funcționalități complexe la postările și paginile WordPress este ușoară cu shortcodes. Acestea sunt simplu de programat și adaugă valoare proiectului dvs. existent prin dinamizarea conținutului simplu.

În acest articol, ați învățat că este nevoie doar de trei pași simpli pentru a crea un shortcode:

  1. Scrieți o funcție obișnuită care execută codul personalizat dorit.
  2. Salvați codul în pluginul sau tema WordPress.
  3. Înregistrați shortcode-ul în WordPress.

.

Lasă un comentariu