Quali sono gli standard di codifica PHP di WordPress?

Quali sono gli standard di codifica PHP di WordPress? In questo video del mio corso, Impara PHP per WordPress, imparerai tutto sugli standard di codifica e sul perché sono importanti.

Gli standard di codifica PHP di WordPress

 

Quali sono gli standard di codifica PHP di WordPress?

Puoi trovare gli standard completi di codifica PHP di WordPress nel manuale ufficiale di WordPress.

Sono essenzialmente un insieme di best practice su come usare PHP in WordPress. Analizzeremo alcuni esempi di ciò che questo significa in pratica nel resto di questo tutorial.

Come puoi vedere, esistono standard non solo per PHP ma anche per l'accessibilità e per le altre lingue che utilizzeresti all'interno di WordPress. 

Perché gli standard di codifica PHP sono importanti?

Perché è importante aderire a questi standard? 

Bene, ci sono due ragioni. Uno di questi riguarda la qualità del codice e l'altro riguarda la coerenza. 

Quindi, in primo luogo, la qualità è importante perché significa che chiunque codifica in WordPress sta creando codice che funzionerà, che farà il suo lavoro e che sarà scritto in modo aggiornato e di alta qualità.

Il secondo, che riguarda la coerenza, è altrettanto importante. È molto probabile che lavorerai di volta in volta con il codice di altre persone. Ad esempio, se stai creando un tema figlio, potresti dover copiare parte del codice dal tema principale. E se stai creando un plugin, quel plugin potrebbe essere un fork di un plugin di terze parti esistente che stai copiando e aggiungendo funzionalità extra a. È molto importante che il modo in cui si codifica sia coerente con il modo in cui tutti gli altri che codificano PHP per WordPress scrivono il codice da soli. 

Esempi di standard di codifica PHP per WordPress

Diamo un'occhiata ad alcuni degli standard di codifica PHP. E ho intenzione di mostrarvi esempi di questi in alcuni dei file nel mio tema.

Convenzioni e casi di denominazione

Iniziamo con le convenzioni e i casi di denominazione. Quando stai pensando alle convenzioni di denominazione, ci sono quattro cose a cui pensare:

  1. le funzioni all'interno del tema o il tuo plugin
  2. i file e il modo in cui li chiami
  3. tutte le classi che scrivi
  4. qualsiasi variabile che si crea

Quindi iniziamo con le funzioni. Ecco il file functions.php nel mio tema come esempio. 

Puoi vedere che ho una funzione che ho definito chiamata rachelmcc_register_widgets. Questo è tutto scritto in minuscolo e sto usando i trattini bassi tra le parole, che è come dovresti scrivere sempre una funzione in WordPress.

Come vedrai, ho usato un prefisso. Questo per garantire che questa funzione non sia in conflitto con altre funzioni che potrebbero essere fornite dal mio tema o da un altro plugin. Quindi se scrivessi una funzione che è stata appena chiamata register_widgets e uno dei miei plugin aveva anche una funzione chiamata register_widgets, loro due potrebbero scontrarsi. Potresti scoprire che uno di essi sovrascrive l'altro o che il plug-in non funziona. 

Quindi, invece, sto usando una funzione unica che è rilevante per il mio tema. Il mio tema è chiamato rachelmccollin, quindi le mie funzioni lo sono rachelmcc come prefisso. Ed è anche importante usare i caratteri di sottolineatura per le tue funzioni e non usare i trattini.

tu fare usare i trattini in due punti. In primo luogo, si utilizzano i trattini quando si definiscono le classi CSS. Quindi puoi vedere che all'interno dei miei widget sto definendo le classi CSS per il mio h3 elemento e anche per il id di quell'area del widget. E qui, usi i trattini.

L'altro posto in cui si usano i trattini si trova nei nomi dei file. Quindi questo è front-page.php. 

Dovresti sempre usare i trattini nei nomi dei file all'interno dei tuoi temi e dei tuoi plugin; non usare caratteri di sottolineatura. Quindi qui c'è una chiamata usando locate_template. E loop-frontpage.php è un file, una parte di modello che sto chiamando, e puoi vedere che ha un trattino e non un trattino basso. 

D'altra parte, il mio ID tipo di post, che è un tipo di post personalizzato che ho registrato, utilizza un trattino basso: rmcc_blurb

Ora potrebbe anche essere necessario pensare a variabili all'interno del tema. Diamo un'occhiata a loop-frontpage.php:

All'interno di questo particolare file, che è quello che stavo chiamando da quel file precedente, ho definito alcune variabili, una chiamata contare e uno chiamato titolo. E puoi vedere che sto usando lettere minuscole per entrambi. 

L'altro posto in cui devi pensare ai caratteri di sottolineatura e alla maiuscola è quando stai usando una classe. Torniamo a front-page.php:

E puoi vedere qui, sto usando il WP_Query classe. Quindi una classe ha una lettera maiuscola dopo il carattere di sottolineatura, così come all'inizio. Ecco dove usi le maiuscole quando definisci una classe. Aiuta le persone che lavorano con il tuo codice a identificare immediatamente che si tratta di una classe e non di una funzione.

Utilizzo di virgolette singole e doppie

Ora diamo un'occhiata a come useresti virgolette singole e doppie in PHP per WordPress. 

Puoi utilizzare virgolette singole o doppie virgolette, a seconda di quale funziona meglio per il codice specifico con cui stai lavorando.

La ragione per cui le doppie virgolette possono a volte essere più utili è che rendono più facile lavorare con caratteri speciali. Ecco un esempio:

Di 'che stavi scrivendo un file modello di ricerca, search.php. E al suo interno, se non fosse stato trovato nulla, avresti messo un paragrafo che diceva: "Mi dispiace, la tua ricerca non ha trovato nulla. Perché non provi ancora?"

L'ho messo tra virgolette doppie perché il testo contiene apostrofi. Lascia che ti mostri come funzionerebbe se lo facessimo tra virgolette. 

È necessario inserire una barra rovesciata prima degli apostrofi affinché possano essere emessi correttamente all'interno dell'HTML, altrimenti ti daranno degli errori. Ora non so voi, ma preferisco scriverlo normalmente tra virgolette doppie piuttosto che racchiuderlo tra virgolette singole.

L'altra cosa che devi ricordare è che se hai bisogno di mettere le virgolette tra virgolette, puoi mettere virgolette singole tra virgolette doppie o viceversa. Non importa in quale direzione, ma non puoi inserire virgolette singole tra virgolette singole o virgolette tra virgolette doppie.

Quindi ecco un esempio che ritorna al mio file functions.php. 

All'interno di qui ho le virgolette singole per il valore di before_widget, e poi dentro, ho le doppie virgolette per l'ID e la classe di quello. Non potrei usare le doppie virgolette qui e quindi inserire le virgolette al suo interno, ecco perché sto usando le virgolette singole lì, perché è meglio usare le virgolette doppie con il tuo CSS. 

dentellatura

Ora, guardiamo all'indentazione. E continuiamo a guardare il file functions.php, che è un buon esempio perché ho indentato un numero di linee di codice al suo interno. 

Puoi vedere che il nome della funzione è a sinistra, e quindi all'interno di esso register_sidebar la funzione è rientrata a un livello. E il contenuto di quello è rientrato di nuovo. 

Quindi ogni volta che inserisci contenuti tra parentesi graffe o parentesi graffe, tutto ciò che è all'interno dovrebbe essere rientrato. E anche per il rientro, dovresti usare le interruzioni di riga. 

Diamo un'occhiata a un altro file in cui ci sono linee singole e doppie linee. 

Quindi qui puoi vedere che ho un Se dichiarazione che contiene due righe di codice al suo interno. Quindi ho inserito un'interruzione di riga sopra e sotto quelle due righe di codice.

Se all'interno ci fosse solo una riga di codice, non dovrei mettere quegli spazi lineari - lo metterei semplicemente dritto dentro le mie parentesi graffe. 

L'utilizzo di spaziature come questa aiuta a chiarire dove sono i blocchi di codice. E puoi vedere anche che il rientro è stato usato. Quindi ci sono più livelli di indentazione. 

L'altra cosa che devi tenere a mente è dove apri e chiudi il tuo tag PHP e se è sulla stessa linea del tuo codice o di una linea diversa. E questo dipende anche dal fatto che stai codificando un blocco di codice o una singola riga.

Dove hai un blocco di codice, metti il ​​tuo tag di apertura su una riga e il tuo tag di chiusura su un'altra riga. Questo aiuta a rendere ovvio che è un blocco di PHP e che tutto all'interno di quei tag è PHP.

L'altra cosa che devi fare è usare un tag PHP ad apertura completa. Quindi non usare solo un punto interrogativo, come avresti potuto fare in altri sistemi che usano PHP, perché in WordPress devi usare il tag PHP completo. 

Se scrivessi del PHP che era solo su una riga, inserivo i tag PHP di apertura e chiusura sulla stessa riga.

Potete vedere che abbiamo un po 'di PHP che è tutto in una riga, e dopo ho l'HTML. Quindi i tag di apertura e chiusura vanno sulla stessa riga del mio codice. 

Conclusione

Questa è un'introduzione ad alcuni degli elementi degli standard di codifica PHP di WordPress, e vi ho mostrato alcuni esempi nei miei file e ne ho cambiati alcuni come ho fatto per mostrarvi come sono fatte le cose correttamente. 

Se vuoi saperne di più sugli standard di codifica, c'è la documentazione sul sito Web di WordPress. E puoi anche dare un'occhiata a questa serie di Enunti Tuts +, che include in dettaglio tutti gli elementi degli standard di codifica.

Guarda il corso completo

Nel corso completo, Impara PHP per WordPress, imparerai tutto su PHP, il linguaggio di programmazione in cui WordPress è integrato.  

Ti darò una panoramica di ciò che è PHP e di come viene utilizzato per temi e plug-in di WordPress, con esempi. Imparerai come creare un file PHP e usarlo per l'output HTML. Quindi imparerai a utilizzare funzioni, cicli e istruzioni per la codifica di temi e plug-in personalizzati per WordPress.

Puoi seguire questo corso subito con un abbonamento a Envato Elements. Con una sola tariffa mensile bassa, puoi accedere non solo a questo corso, ma anche alla nostra libreria in crescita di oltre 1.000 corsi video e eBook leader del settore su Envato Tuts+. 

Inoltre ora ottieni download illimitati dall'enorme libreria Envato Elements con oltre 580.000 asset creativi. Crea con caratteri, foto, grafica e modelli univoci e realizza progetti migliori più velocemente.