Gli standard di codifica di WordPress riunire tutto insieme

Quando si tratta di scrivere una serie di post sul blog, uno degli aspetti più stimolanti di un lettore è in realtà tenere il passo con ogni post pubblicato.

Anche se riesci a cercare di tenere il passo, i post che superano le 1.000 parole - specialmente quelli che includono il codice - possono richiedere del tempo che molti di noi non hanno, specialmente quando si tratta di destreggiarsi tra le nostre vite lavorative, vite domestiche, hobby e altre cose.

Quindi, per assicurarmi che le informazioni presentate in questa serie siano ancora presentate in modo digeribile, ho pensato di sperimentare un riassunto dell'intera serie. In questo modo, per quelli di voi che hanno perso un articolo o non hanno avuto il tempo di sedersi e passare attraverso ogni articolo, può ancora ottenere il succo di ogni punto menzionato in tutti gli articoli.

Detto questo, diamo un'occhiata a tutto ciò che abbiamo esaminato durante la revisione degli standard di codifica di WordPress.

Gli standard di codifica di WordPress

In generale, lo scopo di questa intera serie è quello di aiutare a portare luce agli standard di codifica di WordPress in modo che coloro che non ne hanno mai sentito parlare, coloro che non ne sono a conoscenza o che non li hanno seguiti sono meglio attrezzati per scrivere Temi, plugin e applicazioni WordPress.

Per fare questo, abbiamo approfondito una serie di aspetti diversi degli standard di codifica in sei diversi articoli, evidenziando i principi, le migliori pratiche e le cose da evitare.

Di seguito, abbiamo riepilogato ciascuno degli articoli, nonché i punti elenco che sono punti chiave e che vale la pena notare per l'argomento in questione. Ovviamente, se ti manca più informazioni, puoi tornare all'articolo della serie (collegato all'inizio di questo post) per leggerlo per intero.

1. Convenzioni di denominazione e argomenti di funzione

Convenzioni di denominazione

Quando lavori con classi, funzioni, variabili, attributi o argomenti, le convenzioni di denominazione dovrebbero aiutare a spiegare lo scopo che servono.

Ad esempio, le classi sono generalmente nomi e i nomi di funzioni sono normalmente verbi. In definitiva, si tratta di assicurarsi che il codice sia leggibile e mantenibile.

Direttamente dagli standard di codifica:

Non abbreviare i nomi delle variabili non necessariamente; lascia che il codice sia inequivocabile e auto-documentante.

Ma questo particolare principio vale la pena di seguirlo senza riguardo di dove nel codice stai lavorando.

Argomenti della funzione

Ricorda che quando si tratta di passare argomenti di funzione, è importante ricordare che se un nome di funzione descrive l'azione che prende nel contesto della classe, allora l'argomento dovrebbe rappresentare su ciò che la funzione sta effettivamente operando.

Preferisci valori di stringa a solo vero e falso quando si chiamano funzioni.

Ciò significa che gli argomenti della funzione dovrebbero essere valori chiari - stringhe o numeri - poiché i valori booleani sono spesso poco chiari e non indicano necessariamente quale azione verrà eseguita dalla funzione.

2. L'uso di singole virgolette e doppie virgolette

Quando si tratta di lavorare con le stringhe in WordPress, si tratta in genere di lavorare all'interno delle sfumature della manipolazione delle stringhe di PHP. Pertanto, in questo articolo abbiamo esaminato il modo in cui PHP gestisce le virgolette (sia singole che doppie) e il modo in cui influisce sul nostro sviluppo di WordPress.

Citazioni singole

Il modo più semplice per definire una stringa in PHP è racchiuderlo tra virgolette singole (cioè il 'carattere').

Come con la maggior parte dei linguaggi di programmazione, lì siamo modi per sfuggire ai caratteri in modo da poter scrivere una stringa letterale. Ad esempio, se si desidera scrivere: "String's in PHP is easy", come stringa, è possibile eseguire questa operazione:

'String \' s in PHP sono facili. '

I backslash istruiranno PHP a scrivere la singola virgoletta anziché terminare la stringa vera e propria. La seconda cosa da notare è che se si dispone di una variabile, lo sarà non sostituito quando citato tra virgolette singole.

Virgolette

Le virgolette funzionano in modo leggermente diverso all'interno di PHP. In particolare:

Se la stringa è racchiusa tra virgolette ("), PHP interpreterà più sequenze di escape per caratteri speciali.

Ciò significa che se si incorpora una variabile all'interno di una stringa PHP con virgolette doppie, la variabile verrà interpretata e il suo valore verrà inserito al posto della variabile prima di visualizzarlo sullo schermo.

Archi e WordPress

Poiché gran parte del lavoro svolto in WordPress include anche la scrittura del markup entro una stringa PHP, è meglio posizionare tali stringhe tra virgolette singole in modo che gli attributi dell'elemento HTML possano essere racchiusi tra virgolette doppie.

Ma ci sono momenti in cui è preferibile usare le virgolette doppie particolarmente quando hai bisogno di valutare una variabile.

Il miglior consiglio che può essere offerto qui è sapere come le virgolette singole e le doppie virgolette funzionano in PHP, e quindi usarle in modo appropriato in base al tuo caso d'uso.

3. Spazi di indentazione, spazio utilizzabile e finali

Ricorda: lo spazio bianco migliora la leggibilità del codice e, come sviluppatori, uno dei nostri obiettivi principali dovrebbe essere quello di assicurarsi che il codice che stiamo scrivendo non stia solo seguendo uno standard predefinito, ma sia adatto anche ad altri sviluppatori per facilità di leggibilità e manutenibilità.

dentellatura

Per quanto riguarda l'indentazione, non c'è nulla di veramente nuovo, specialmente se si ha familiarità con i linguaggi in stile C. La maggior parte delle volte, indentri ogni volta che inizi un nuovo blocco.

• Le tue funzioni saranno rientrate all'interno della classe
• I tuoi condizionali e interruttore / casi e altri blocchi saranno rientrati nelle loro funzioni
• I tuoi loop saranno rientrati all'interno delle loro funzioni, all'interno dei loro condizionali e così via

Si noti che gli standard di codifica fare avere regole su schede e spazi:

La tua indentazione dovrebbe sempre riflettere la struttura logica. Uso schede reali e non spazi, in quanto ciò consente la massima flessibilità tra i clienti.

Questo è particolarmente utile nella comunità open source.

Utilizzo dello spazio

Gli spazi devono essere collocati nei seguenti luoghi:

• Dopo le virgole
• Da entrambi i lati degli operatori logici (cioè, ||, &&, e !)
• Da entrambi i lati degli operatori di confronto (ovvero, <, >, ==, ===, eccetera.)
• Su entrambi i lati degli operatori incaricati (vale a dire =)
• Su entrambi i lati della parentesi aperta e chiusa di funzioni, condizionali, cicli e così via.
• Quando una variabile viene passata come indice di un array, ma non quando un valore letterale (come una stringa o un intero)

Trailing Spaces

Questa è una delle più semplici convenzioni da seguire. Onestamente, è probabile che il tuo IDE o editor di scelta abbia questa funzione integrata, oppure è disponibile un plug-in che ti permetterà di farlo automaticamente.

In caso contrario, dovresti essere in grado di attivare la possibilità di visualizzare schede, spazi, ritorni a capo e così via in modo da poter identificare facilmente dove gli spazi finali sono. E quando li vedi, eliminali.

4. Stile di parentesi, espressioni regolari e tag PHP

In questa sezione, abbiamo dato un'occhiata al motivo per cui lo stile è importante. Abbiamo anche definito esattamente come si definiscono gli standard di codifica e le convenzioni Come modelliamo il nostro codice.

Brace Style

In generale, le regole sono semplici:

• I blocchi a riga singola possono tralasciare le parentesi
• I blocchi multilineari devono sempre includere parentesi graffe
• Quando si dispone di condizionali multilinea eccessivi, prendere in considerazione la possibilità di suddividere i condizionali nelle proprie funzioni per minimizzare il blocco

Sono particolarmente comuni se provieni da altri linguaggi in stile C; tuttavia, proprio come WordPress ha sfumature sottili che altri linguaggi no, vale la pena evidenziarli qui.

Espressioni regolari

PHP offre una varietà di modi per lavorare con le espressioni regolari, anche se WordPress raccomanda di utilizzare solo una manciata delle funzioni disponibili.

Le regole per lavorare con le espressioni regolari in PHP in WordPress sono le seguenti:

• Utilizzare il preg funzioni che PHP offre
• Non usare il \ e switch che viene offerto da PHP - usa preg_replace_callback anziché.

In particolare, consiglio di conoscere le seguenti funzioni:

• preg_replace
• preg_match
• preg_match_all

Inoltre, si noti che preg_replace_callback è un modo per chiamare una funzione quando un'espressione regolare ha trovato una corrispondenza.

Tag PHP

C'è una semplice regola empirica per l'utilizzo di tag PHP all'interno dello sviluppo di WordPress:

• Non usare mai tag PHP abbreviati

Ciò significa che non devi mai aprire un file o un'istruzione PHP in linea con  o con . Naturalmente, tutte le istruzioni PHP inline devono essere terminate con ?> tag di chiusura.

 $ uses_gasoline = 'hybrid' == $ car_type? falsa verità; echo $ uses_gasoline;