In questo articolo tratteremo delle convenzioni stilistiche per la scrittura del codice funzionale nei temi di WordPress.
Organizzazione dei file
Sebbene WordPress di fatto consenta di scrivere il nostro intero codice nel file functions.php di un tema, la pratica corrente prevede invece la creazione di un insieme di file contenenti le nostre funzioni.
Tale insieme va sempre creato al di sotto della directory principale del tema. Una buona pratica è quella di raggruppare insieme le funzioni che svolgono compiti analoghi.
Ecco un esempio di questo insieme:
- /inc/
- /shortcodes.php
- /post-types.php
- /widgets.php
- /theme-settings.php
I nomi dei file dovranno essere autoesplicativi nel senso che assegnare nomi abbreviati o quantomeno criptici ai file renderà la manutenzione futura molto più difficile. Inoltre se avete intenzione di rivendere il vostro lavoro sul mercato tenete presente che una struttura chiara dei file vi eviterà spesso di dover rispondere alle classiche richieste di supporto del tipo "dove trovo il codice X?".
Scrittura del codice
WordPress dispone di uno standard ben definito per la scrittura del codice PHP. Questo standard, tuttavia, si applica per quegli sviluppatori che intendono contribuire al Core del CMS.
Ad un'attenta lettura, come del resto accade anche per molti altri CMS, solo alcune di queste pratiche raccomandate trova un riscontro universale nell'ambito generale di PHP.
Per esempio l'uso delle virgolette è una pratica condivisa, mentre l'uso dei tab al posto degli spazi non lo è.
Sicuramente una pratica molto utile è la spaziatura intorno alle parentesi tonde dei blocchi. Quindi:
foreach($foo as $bar) {
...
}
è sconsigliato mentre:
foreach( $foo as $bar ) {
...
}
lo è, perché la spaziatura facilita la lettura e la comprensione del codice.
WordPress insiste molto sul fatto che le parti del nome di una funzione debbano essere separati da underscore:
function my_function( $param1 = 'foo', $param2 = 'bar' ) { ...}
È consigliato usare sempre un prefisso per i nomi delle funzioni utilizzando ad esempio il nome abbreviato del tema.
Se i vostri file contengono solo codice PHP, allora potete omettere il tag PHP di chiusura, stando bene attenti che il vostro file non contenga spazi alla fine. Questa pratica ci permette di evitare il tristemente noto errore Headers already sent quando includiamo il nostro codice nel flusso di WordPress.