Cum să faci un plugin WordPress gata pentru traducere?

1. Scrieți cu localizarea în minte

Nu folosiți echo sau print() pentru a afișa text, în schimb utilizați funcțiile WordPress __() și _e():

/** Nu este prietenos cu localizarea */
echo "Bun venit la pluginul meu";    
// SAU
print("Bun venit la pluginul meu");

/** Prietenos cu localizarea */
_e('Bun venit la pluginul meu', 'my-plugin');
// SAU
$my_text = __('Bun venit la pluginul meu', 'my-plugin');
echo $my_text;

_e() și __() vor furniza traducerea — în limba curentă — a textului furnizat ca prim parametru. _e() va afișa textul, în timp ce __() îl va returna.

Al doilea parametru este domeniul textului, îl veți folosi pentru a-i spune WordPress că textul furnizat ca prim parametru aparține acestui plugin, puteți folosi orice nume doriți, dar eu prefer să folosesc același nume ca cel al fișierului sau directorului pluginului, mi se pare mai intuitiv.

Cum să afișați text dinamic precum: "Salut <username>"?

Cu __() și sprintf():

/** Obține numele de utilizator */
$username = 'Magictrick';

/** Nu este prietenos cu localizarea */
echo "Salut $username";     

/** Prietenos cu localizarea */
printf(__('Salut %s', 'my-plugin'), $username);
// SAU 
$my_text = sprintf(__('Salut %s', 'my-plugin'), $username);
echo $my_text;

2. Pregătiți fișierele .pot/.po/.mo

Definiții

• Fișierul .pot: este pus la dispoziție de dezvoltatorul pluginului și este folosit ca punct de plecare pentru a crea noi traduceri, WordPress nu îl folosește.
• Un fișier .po: este un fișier de traducere pe care tu sau altcineva l-a început și poate l-a și finalizat, WordPress nu îl folosește.
• Un fișier .mo: este creat automat de Poedit ori de câte ori salvezi un fișier .po, tot ce poți face cu aceste fișiere este să le încarci sau să le reîncarci ori de câte ori creezi sau actualizezi un fișier .po. WordPress obține traducerile din fișierele .mo.

Deschideți Poedit și creați un nou catalog (File › New Catallog...) cu aceste setări:

• Informații proiect: Folosiți informațiile dumneavoastră (sau ale echipei), limba și țara ar trebui să corespundă limbii implicite a pluginului
• Căi:
  • Cale de bază: .
  • Căi: eliminați toate și adăugați .., (vom stoca fișierul de limbă într-un subdirector al pluginului numit languages)
• Cuvinte cheie: eliminați toate și adăugați __ și _e

Salvați catalogul ca /my_wordpress_blog/wp-content/plugins/my-plugin/languages/<strong>my-plugin.pot</strong> și scanați fișierele pluginului pentru text traducibil apăsând butonul de actualizare. Când actualizarea este finalizată, închideți acel catalog, nu va trebui să actualizați acel fișier decât dacă adăugați noi șiruri traducibile (adică încadrate în __() sau _e()) în pluginul dumneavoastră.

Acum să creăm prima traducere (voi folosi fr_FR):

Folosind Podeit, creați un catalog dintr-un fișier POT (File › New catalog from POT file...):

• Informații proiect: Folosiți informațiile dumneavoastră (sau ale echipei), schimbați limba și țara, eu voi folosi franceză și Franța
• Căi: Nu modificați
• Cuvinte cheie: Nu modificați

Salvați catalogul ca /my_wordpress_blog/wp-content/plugins/my-plugin/languages/<strong>my-plugin-fr_FR.po</strong>. Traduceți unele sau toate șirurile, salvați din nou fișierul .po, încărcați atât fișierul .po cât și .mo.

Rețineți că ori de câte ori salvați un fișier .po, un fișier .mo este generat cu același nume, numele fișierului .po este crucial, este compus din concatenarea domeniului textului pluginului (my-plugin) și a localizării limbii (fr_FR), numiți întotdeauna fișierele .po pentru pluginuri astfel: [textdomain]-[locale].po, iată câteva exemple:

• Italiană/Italia: wpcf7-it_IT.po
• Portugheză/Brazilia: wpcf7-pt_BR.po
• Arabă: wpcf7-ar.po... Da!

Ori de câte ori pluginul este actualizat cu text nou, actualizați fișierul po, traduceți șirurile noi și reîncărcați fișierele .po și .mo

3. Instruiți pluginul să încarce textul tradus pentru limba curentă

Undeva în pluginul dumneavoastră, trebuie să-i spuneți WordPress să folosească fișierul .mo, puteți face asta folosind acest cod la începutul fișierului pluginului:

function my_plugin_init() {
  load_plugin_textdomain( 'my-plugin', false, 'my-plugin/languages' );
}
add_action('init', 'my_plugin_init');

Înlocuiți my-plugin cu numele pluginului dumneavoastră în primul și al treilea parametru al funcției load_plugin_textdomain.

4. Testați și depanare

Câteva motive pentru care poate să nu funcționeze:

• Șirurile nu sunt importate în fișierul .pot sau .po
  • → Setări incorecte ale catalogului (cale sau cuvinte cheie sau ambele)
• Textul nu este tradus pe site-ul WordPress
  • → Fișierul .mo pentru acea limbă lipsește sau are un nume incorect
  • → Domeniul textului nu este folosit (înlocuiți _e('my text') cu _e('my text', 'my-plugin'))
  • → Domeniul textului nu este încărcat (folosiți exemplul de mai sus cu parametrii corecți, WordPress nu vă va avertiza despre greșeli)