Migliori Pratiche Oggettive per lo Sviluppo di Plugin?

Testa il tuo plugin

Dovremmo assolutamente avere alcuni strumenti di test nel nostro ambiente di sviluppo plugin.

Basandoci su questa risposta di Ethan Seifert a una domanda sui test, queste sono le buone pratiche da seguire:

• Il tuo Unit Testing dovrebbe testare la quantità più piccola di comportamento che una classe può eseguire.
• Quando arrivi al livello di functional testing è qui che puoi testare il tuo codice con le dipendenze di Wordpress.
• A seconda di cosa fa il tuo plugin - considera l'uso di test basati su Selenium che verificano la presenza di dati nel DOM utilizzando gli ID

Preoccupati delle future versioni di WordPress e del tema

Nota: Dopo aver riletto questo consiglio, ora mi dissocio da questa pratica poiché controllare ogni funzione per verificarne l'esistenza potrebbe rallentare il tuo sito.

Verifica se le funzioni sono deprecate direttamente nel tuo tema.

Questo è un esempio di "potrebbe essere così".

if ( ! function_exists( 'wp_some_fn' ) ) 
{
    $theme_data = wp_get_theme();
    $error = new WP_Error( 'wp_some_fn', sprintf( __( 'La funzione %1$s è deprecata. Si prega di informare l\'autore', TEXTDOMAIN ), "Tema: {$theme_data->Name}: Versione {$theme_data->Version}" );

    // interrompi
    if ( is_wp_error( $error ) )
        return print $error->get_error_message();
} 
// altrimenti se nessun errore - la funzione esiste e funziona
wp_some_fn();

Per una gestione degli errori corretta/migliore pratica vedi questa risposta: link

Potresti inserire anche il $cause nella funzione. Questo ti aiuterà, insieme ai tuoi utenti, a tenere traccia delle funzioni o classi nel tuo tema che potrebbero cambiare.

Usa Nomi Appropriati

Dai nomi significativi a hook e filtri (classi, funzioni e variabili), in modo che le persone possano identificarli anche dopo un anno, quando non ricordano più da dove proviene quel pezzo di codice. Non importa se i nomi degli hook/filtri diventano lunghi. Es. tuonomeunico_hook/filter_cosafa.

• Se il tuo file contiene una classe chiamata "dbdbInit", allora il file che contiene la classe dovrebbe chiamarsi "dbdbInit.class.php".
• Se all'interno della tua classe dbdbInit hai una funzione che registra ad es. custom_post_types, chiamala register_custom_post_types().
• Se hai un array che contiene i nomi per i custom_post_types, chiama la variabile a cui è assegnato l'array $custom_post_type_names.
• Se hai una funzione che gestisce un array scrivi function array_handler( $array ) { // gestisci l'array}..
• Cerca semplicemente di nominare le cose in modo che tu sappia cosa fa un elemento/a cosa appartiene dal suo nome.

Un'altra cosa: Se devi eseguire il debug, nel 99% dei casi ricevi tutti i messaggi non solo per il tuo codice, ma anche per WordPress. Quindi cerca di usare lo stesso prefisso, ad es. "dbdb", per le tue classi, funzioni pubbliche e variabili/oggetti. In questo modo puoi trovarle facilmente tra centinaia di file. (WordPress carica 64 file prima del tuo tema e circa 1.550 funzioni, senza contare hook e filtri.)

Disaccoppiare dal codice core di WordPress

Un Plugin dovrebbe ridurre al minimo necessario l'impatto delle API di WordPress per separare il codice del plugin dal codice di WordPress. Questo riduce l'impatto dei cambiamenti all'interno del codice base di WordPress sul plugin. Inoltre, migliora la compatibilità cross-version del codice del tuo plugin.

Questo non significa non usare le funzioni di WordPress (usale, come suggerisce Riutilizza le funzioni esistenti), ma evitare di intrecciare troppo il tuo codice con le funzioni di WordPress, separando invece la logica di business del tuo plugin dalla funzionalità di WordPress.

Utilizza le opzioni di WordPress per le stringhe di output del plugin

Per rendere il plugin facilmente utilizzabile e personalizzabile, tutte le stringhe di output dovrebbero essere modificabili. Il modo migliore per farlo è utilizzare le opzioni di WordPress per memorizzare le stringhe di output e fornire un backend per modificare i valori predefiniti. Il plugin non dovrebbe utilizzare stringhe visualizzate che non possono essere facilmente modificate tramite il backend del plugin.

Ad esempio: Sociable - ti dà la possibilità di cambiare la frase che appare prima della parte delle icone "condividi e divertiti:"

Utilizza gli hook di disinstallazione, attivazione e disattivazione

Ci sono tre hook diversi per questo:

• Disinstallazione register_uninstall_hook();
• Disattivazione register_deactivation_hook();
• Attivazione register_activation_hook();

Qui puoi trovare un'istruzione dettagliata con un esempio funzionante.