Home » Articole » RO » Calculatoare » Dezvoltarea web » WordPress » API pentru scurtături în WordPress

API pentru scurtături în WordPress

postat în: WordPress 0

ShortcodeAPI

API pentru scurtături este un simplu set de funcții pentru crearea de scurtături WordPress pentru utilizare în mesaje și pagini. De exemplu, următoarea scurtătură (în corpul unui post sau pagină) ar adăuga o galerie foto de imagini atașate la acest post sau pagină:

[gallery]

API permite dezvoltatorilor de module să creeze tipuri speciale de conținut (de exemplu, forme, generatoare de conținut) pe care utilizatorii le pot atașa la anumite pagini prin adăugarea de scurtături corespunzătoare în textul paginii.

API pentru scurtături ușurează crearea de scurtături care suportă atribute ca acesta:

[gallery id="123" size="medium"]

API gestionează toate situațiile, eliminând nevoia de a scrie o expresie obișnuită personalizat pentru fiecare scurtătură. Funcțiile ajutătoare sunt incluse pentru stabilirea și preluarea atributelor implicite. API suportă atât auto-închiderea și includerea scurtăturilor.

Aici e un exemplu minimal de cod PHP necesar pentru a crea o scurtătură:

//[foobar] function foobar_func( $atts ){
return „foo and bar”;
}
add_shortcode( ‘foobar’, ‘foobar_func’ );

Acesta va crea [foobar] un cod scurt care se întoarce ca: foo și bar

Cu atribute:

// [bartag foo=”foo-value”] function bartag_func( $atts ) {
$a = shortcode_atts( array(
‘foo’ => ‘ceva’,
‘bar’ => ‘altceva’,
), $atts );

return „foo = {$a[‘foo’]}”;
}
add_shortcode( ‘bartag’, ‘bartag_func’ );

Acesta creează o scurtătură „[bartag]” care acceptă două atribute: [„foo” și „bar”]. Ambele atribute sunt opționale și vor lua pe opțiunile implicite [foo = „ceva” bar = „altceva”], dacă acestea nu sunt furnizate. Scurtătura va întoarce foo = {valoarea atributului foo}.

Prezentare generală

Scurtăturile sunt scrise prin furnizarea unei funcții de manipulare (handler). Manipulatoarele de scurtătură sunt în mare parte similare cu filtrele WordPress: acceptă parametri (atribute) și returnează un rezultat (ieșirea scurtăturii).

Numele scurtăturilor ar trebui să fie toate cu litere mici și să folosească toate literele, dar numerele și liniuțele de subliniere ar trebui să fie acceptate și ele. Este recomandabil să nu fie folosite liniuțe de unire.

Funcția add_shortcode este folosită pentru a înregistra un manipulator. Este nevoie de doi parametri: numele scurtăturii (șirul folosit într-un corp de postare), și numele funcției de apel invers.

Trei parametri sunt trecuți la funcția de apel invers de scurtătură. Puteți alege să utilizați oricâte din ele, inclusiv niciunul.

  • $atts – un tablou asociativ de atribute, sau un șir gol dacă nu este dat niciun atribut
  • $content – conținutul inclus (în cazul în care scurtătura este utilizată în forma sa de includere)
  • $tag – eticheta scurtăturii, utilă pentru funcții de apel invers partajate.

Apelul API pentru înregistrarea manipulatorului de scurtătură ar arăta ceva de genul acesta:

add_shortcode( ‘myshortcode’, ‘my_shortcode_handler’ );

Când este afișat the_content, API pentru scurtătură va analiza toate scurtăturile înregistrate, cum ar fi „[myshortcode]”, va separa și analiza atributele și conținutul, dacă există, și le va trece funcția de manipulare de scurtătură corespunzătoare. Orice șir returnat (nu ecou) de către manipulatorul de scurtătură va fi introdus în corpul postării în locul scurtăturii în sine.

Atributele scurtăturii sunt introduse în felul următor:

[[myshortcode foo=”bar” bar=”bing”]]

Aceste atribute vor fi convertite într-o matrice asociativă, trecută funcției manipulatoare ca parametrul $atts:

array( ‘foo’ => ‘bar’, ‘bar’ => ‘bing’ )

Cheile matricei sunt numele de atribute; valorile matricei sunt valorile atributelor corespunzătoare. În plus, intrarea ($atts[0]) va reține șirul care corespunde scurtăturii, dar NUMAI DACĂ aceasta este diferită de numele de apel invers.

Traducere din wordpress.org

Lasă un răspuns

Adresa ta de email nu va fi publicată. Câmpurile obligatorii sunt marcate cu *