Practici Objektive Recomandate pentru Dezvoltarea de Plugin-uri?

Testează-ți pluginul

Ar trebui să avem cu siguranță câteva instrumente de testare în mediul de dezvoltare al pluginului nostru.

Bazat pe acest răspuns al lui Ethan Seifert la o întrebare despre testare, acestea sunt bune practici de urmat:

• Testele Unitare ar trebui să testeze cea mai mică cantitate de comportament pe care o poate realiza o clasă.
• Când ajungi la nivelul testării funcționale, aici poți testa codul cu dependențele WordPress.
• În funcție de ce face pluginul tău – ia în considerare utilizarea testelor bazate pe Selenium care verifică prezența datelor în DOM folosind ID-uri

Grijă pentru versiunile viitoare de WordPress și teme

Notă: După ce am recitit acest sfat, acum mă distanțez de această practică, deoarece verificarea fiecărei funcții pentru existență poate încetini site-ul tău.

Verifică dacă funcțiile sunt învechite direct în tema ta.

Acesta este un exemplu "care ar putea arăta așa".

if ( ! function_exists( 'wp_some_fn' ) ) 
{
    $theme_data = wp_get_theme();
    $error = new WP_Error( 'wp_some_fn', sprintf( __( 'Funcția %1$s este învechită. Te rugăm să informezi autorul', TEXTDOMAIN ), "Tema: {$theme_data->Name}: Versiunea {$theme_data->Version}" );

    // întrerupe
    if ( is_wp_error( $error ) )
        return print $error->get_error_message();
} 
// altfel dacă nu există eroare - funcția funcționează și există
wp_some_fn();

Pentru gestionarea corectă/cea mai bună practică a erorilor, vezi acest răspuns: link

Poți adăuga chiar și $cause în funcție. Acest lucru te va ajuta pe tine și utilizatorii tăi să țină pasul cu funcțiile sau clasele din tema ta care s-ar putea schimba.

Folosește Denumiri Adecvate

Denumește hook-urile și filtrele (clasele, funcțiile și variabilele), astfel încât oamenii să le poată identifica chiar și peste un an, când nu-și mai amintesc de unde vine acea bucățică de cod. Nu contează dacă numele hook-urilor/filtrelor devin lungi. Ex. numeletauunic_hook/filter_ceface.

• Dacă fișierul tău conține o clasă numită "dbdbInit", atunci fișierul care conține clasa ar trebui să se numească "dbdbInit.class.php".
• Dacă ai în interiorul clasei dbdbInit o funcție care înregistrează, de exemplu, custom_post_types, atunci numește-o register_custom_post_types().
• Dacă ai un array care conține numele pentru custom_post_types, atunci numește variabila în care este asignat array-ul $custom_post_type_names.
• Dacă ai o funcție care gestionează un array, scrie function array_handler( $array ) { // gestionează array-ul}..
• Încearcă pur și simplu să denumești lucrurile într-un mod în care să știi ce face semnul/unde aparține după numele său.

Alt lucru: Dacă trebuie să debug-uiți, atunci, în 99% din cazuri, veți primi toate mesajele nu doar pentru codul vostru, ci și pentru WordPress. Așadar, încercați să folosiți același prefix, de exemplu "dbdb", pentru clasele, funcțiile publice și variabilele/obiectele voastre. Astfel, le puteți găsi cu ușurință între sute de fișiere. (WordPress încarcă 64 de fișiere înaintea temei tale și aproximativ 1.550 de funcții, fără a vorbi despre hook-uri și filtre.)

Decuplează-te de codul de bază al WordPress

Un Plugin ar trebui să reducă impactul API-ului WordPress la minimul necesar pentru a separa codul plugin-ului de cel al WordPress. Acest lucru reduce impactul modificărilor din codul de bază al WordPress asupra plugin-ului. În plus, îmbunătățește compatibilitatea între versiuni a codului plugin-ului tău.

Acest lucru nu înseamnă să nu folosești funcțiile WordPress (folosește-le, așa cum sugerează Reutilizează funcțiile existente), ci să nu-ți împletești codul prea mult cu funcțiile WordPress, ci să separi logica de afaceri a plugin-ului tău de funcționalitățile WordPress.

Folosește opțiunile WordPress pentru șirurile de ieșire ale pluginului

Pentru a face pluginul ușor de utilizat și personalizat, toate șirurile de ieșire ar trebui să fie modificabile. Cea mai bună metodă pentru a realiza acest lucru este utilizarea opțiunilor WordPress pentru a stoca șirurile de ieșire și a oferi o interfață de administrare pentru a modifica valorile implicite. Pluginul nu ar trebui să utilizeze șiruri afișate care nu pot fi ușor schimbate folosind panoul de administrare al pluginului.

De exemplu: Sociable - îți oferă posibilitatea de a schimba fraza care apare înaintea părții cu iconițe "împărtășește și bucură-te:"

Folosește hook-uri pentru dezinstalare, activare și dezactivare

Există trei hook-uri diferite pentru aceasta:

• Dezinstalare register_uninstall_hook();
• Dezactivare register_deactivation_hook();
• Activare register_activation_hook();

O instrucțiune detaliată cu un exemplu funcțional poate fi găsită aici..