di WordPress garantiscono coerenza e manutenibilità nell'ampia base di codice della piattaforma. Queste linee guida, meticolosamente elaborate, sintetizzano i consigli di sviluppo di WordPress , promuovendo chiarezza ed efficienza.
Seguendo queste alla manutenzione di WordPress , gli sviluppatori di tutto il mondo contribuiscono in modo armonioso, comprendendo perfettamente il lavoro degli altri. Fai in modo che il tuo di sviluppo WordPress segua scrupolosamente gli standard di programmazione di WordPress per garantire soluzioni di alta qualità, scalabili e manutenibili a lungo termine.
Perché attenersi agli standard di codifica di WordPress?
Gli standard di codifica di WordPress mirano a garantire la coerenza del codice tra progetti e collaboratori. Migliorano la leggibilità e la manutenibilità per lo sviluppo collaborativo e facilitano la revisione del codice e l'aderenza alle best practice nell'intero ecosistema WordPress.
Cosa sono gli standard di codifica di WordPress?
Gli standard di codifica di WordPress forniscono una base per la collaborazione e la coerenza all'interno del progetto e della community di WordPress, dal codice core ai temi e ai plugin. Questi standard, sviluppati dalla community di WordPress in collaborazione con i forum di supporto di WordPress rappresentano le best practice che sviluppatori e collaboratori di WordPress dovrebbero seguire.
Per saperne di più : Come ridurre l'impatto del codice di terze parti?
Importanza degli standard di codifica
Gli standard di codifica aiutano a prevenire errori comuni, migliorare la leggibilità del codice e semplificare le modifiche. Rispettandoli, il codice appare come se fosse stato scritto da una singola persona, rendendolo più facile da comprendere e modificare per chiunque.
Contributo a WordPress Core
Se si contribuisce al core di WordPress, è fondamentale familiarizzare con questi standard, poiché il codice inviato deve essere conforme.
Hai difficoltà a mantenere gli standard di codifica per il tuo esclusivo sito WordPress?
Lascia che i nostri esperti sviluppatori WordPress si occupino del tuo mal di testa!
Componenti degli standard di codifica di WordPress
Gli standard coprono le linee guida specifiche per ogni linguaggio per CSS, HTML, JavaScript e PHP, nonché le linee guida sull'accessibilità allineate con WCAG AA.
Leggi anche: Come convertire HTML in un tema WordPress?
Eccezione per le librerie di terze parti
Tuttavia, le librerie di terze parti incorporate in WordPress sono esenti da questi standard.
Esempi di standard di codifica di WordPress
Esploriamo gli standard di codifica di WordPress attraverso vari esempi per comprenderne l'applicazione in scenari reali. Questi esempi illustrano le best practice consigliate per scrivere codice chiaro e manutenibile in WordPress.
PHP IN WORDPRESS
WordPress utilizza gli aggiornamenti PHP come linguaggio di programmazione principale. Il rispetto degli standard di programmazione PHP è fondamentale per un codice manutenibile e coerente in WordPress. Ecco perché gli standard di programmazione PHP sono importanti:
Interruzioni di riga
WordPress non specifica molto sulle interruzioni di riga, ma è comune aggiungerne una dopo la maggior parte delle istruzioni. Inoltre, si consiglia di inserire le definizioni delle variabili, i blocchi if e gli elementi degli array su righe separate.
Rientro
Per rendere il codice più facile da leggere, usa l'indentazione per mostrarne la struttura logica. Le tabulazioni dovrebbero essere usate all'inizio delle righe, mentre gli spazi sono usati per l'indentazione a metà riga.
Utilizzo dello spazio
Rendi il tuo codice più facile da leggere rimuovendo eventuali spazi extra alla fine delle righe. Inoltre, elimina le righe vuote con tabulazioni o spazi unificatori. Utilizza spazi tra parentesi per maggiore chiarezza. Aggiungi un'interruzione di riga dopo una parentesi graffa di apertura e prima di una parentesi graffa di chiusura, tranne che per il typecasting.
Citazioni
In WordPress, la regola principale è quella di utilizzare gli apici singoli per le stringhe, a meno che non si voglia valutare qualcosa al loro interno. Se si hanno bisogno di virgolette all'interno di una stringa, alternare tra virgolette singole e doppie. L'escape delle virgolette è consentito, ma raramente necessario.
Bretelle
Il modo più semplice è usare sempre le parentesi graffe. Mentre gli standard consentono di saltare le parentesi graffe per le istruzioni "if" a riga singola senza blocchi multiriga nella stessa struttura, questo non è consentito per i cicli a riga singola. Preferisco usare sempre le parentesi graffe per chiarezza. Inoltre, gli standard specificano di posizionare la parentesi graffa di apertura sulla stessa riga dell'istruzione iniziale, non sotto come nella documentazione PHP.
Formattazione delle query SQL
Quando si scrivono query SQL, ricordarsi di scrivere le parole chiave in maiuscolo. Le query complesse dovrebbero essere suddivise in più righe. È importante comprendere bene le query, in particolare i loro aspetti di sicurezza, di cui parleremo più avanti. Gli attacchi SQL injection si verificano a causa di errori di sicurezza di WordPress , consentendo agli hacker di accedere direttamente al database di un sito WordPress e manipolarlo.
Convenzioni di denominazione
Nel codice WordPress, evitate il CamelCase per i nomi. Le funzioni dovrebbero usare caratteri minuscoli, con trattini bassi se necessario. I nomi delle classi dovrebbero scrivere in maiuscolo la prima lettera di ogni parola, separate da trattini bassi.
I nomi dei file devono essere tutti in minuscolo, con trattini tra le parti. Se un file contiene una sola classe, assegnagli il nome della classe, preceduto dal prefisso "class-".
Per maggiore chiarezza, usa valori stringa anziché booleani per gli argomenti delle funzioni. La regola più importante è usare nomi descrittivi. In un ambiente collaborativo, cerca di aiutare tutti a comprendere il tuo codice.
Dichiarazioni di confronto
Una buona pratica, non solo per WordPress, è quella di posizionare sempre la variabile sul lato destro di un confronto. In questo modo, se si dimentica un segno di uguale, verrà generato un errore anziché essere valutato come vero. Se si preferisce utilizzare operatori ternari, è consentito, ma è consigliabile verificare la correttezza per rendere le cose più chiare. Un'eccezione si verifica quando si controllano variabili non vuote utilizzando !empty().
FORMATTAZIONE HTML
Secondo il WordPress Codex, è importante convalidare tutto il codice HTML utilizzando il W3C Validator. Tuttavia, un codice valido non significa sempre che sia buono, sebbene esista una chiara correlazione tra i due.
Tipo di documento
WordPress segue la specifica XHTML 1.0 raccomandata dal W3C nel 2000. Nonostante ciò, il tema Twenty Eleven, predefinito in WordPress, utilizza HTML5. Non c'è un vero conflitto perché HTML5 include la serializzazione XML, consentendo l'uso di "XHTML5"
Utilizzo delle virgolette
In HTML, le virgolette vengono utilizzate principalmente per gli attributi e i loro valori. È possibile scegliere tra virgolette singole o doppie, ma è sempre consigliabile utilizzare un solo tipo di virgolette. Personalmente, uso le virgolette singole quando possibile, come faccio in PHP, per coerenza. Questo mi aiuta a individuare rapidamente eventuali casi particolari in una riga semplicemente guardando le virgolette.
Tag di chiusura
Le specifiche XHTML impongono la chiusura di tutti i tag. Gli elementi void devono essere chiusi con una barra (/) subito prima dell'ultima parentesi angolare. Assicurarsi che ci sia uno spazio prima della barra (/), come specificato.
Rientro
Rientra il codice HTML seguendo le stesse regole di PHP. Cerca di creare una struttura logica per l'indentazione. Quando combini PHP e HTML, rientri i blocchi PHP seguendo il consueto flusso di indentazione.
FORMATTAZIONE CSS
La formattazione CSS implica l'organizzazione e la definizione dello stile della presentazione dei contenuti web, garantendo coerenza e leggibilità su diversi dispositivi e browser. Un CSS formattato correttamente migliora la struttura e l'aspetto visivo dei siti web, contribuendo a una migliore esperienza utente.
Per saperne di più: Come rimuovere i CSS inutilizzati in WordPress?
Indentazione e struttura
Il tuo CSS dovrebbe seguire questo schema approssimativo: scrivi ogni selettore su una riga separata, anche se stai elencando più selettori per un set di regole. Inoltre, ogni coppia proprietà-valore dovrebbe trovarsi su una riga separata. Inserisci la parentesi graffa di apertura sulla riga del selettore e quella di chiusura su una riga separata con la stessa indentazione del selettore di apertura.
Convenzioni di denominazione
Utilizza solo caratteri minuscoli. Separa le parole all'interno di un selettore con un trattino. Assegna ai selettori nomi leggibili.
Proprietà e valori
Esistono diverse regole per la scrittura di proprietà e valori. Utilizzare versioni abbreviate delle proprietà ove possibile, tranne quando si sovrascrive una proprietà definita in precedenza. Utilizzare codice HEX minuscolo per i colori ove possibile. Se appropriato, utilizzare la versione più breve. Inserire uno spazio dopo i due punti che seguono una proprietà. Utilizzare sempre caratteri minuscoli, tranne quando è richiesto un carattere maiuscolo, ad esempio con i nomi dei font e le proprietà specifiche del fornitore. Organizzare le proprietà CSS in ordine alfabetico, con l'eccezione delle proprietà specifiche del fornitore, che devono sempre precedere la loro controparte generale, e delle proprietà dimensionali, che devono essere raggruppate. Se vengono specificate larghezza e altezza, scrivere prima la larghezza.
Commentando
CSS supporta un solo tipo di commento: lo stile a blocco; non ha una notazione separata per i commenti in linea. Scrivete commenti brevi su una sola riga, senza un'interruzione di riga. Per commenti che si estendono su più righe, inserite un'interruzione di riga subito dopo la sintassi di apertura e un'interruzione di riga subito prima della sintassi di chiusura. Se utilizzate i commenti per delimitare sezioni del codice, utilizzate la seguente notazione:
Utilizzo dei preprocessori CSS
L'utilizzo di preprocessori CSS come SASS e Less semplifica notevolmente la nostra vita di sviluppatori, ma non è privo di inconvenienti. Il codice prodotto da questi strumenti è solitamente valido, ma non si può dire che sia molto pulito. Un foglio di stile prodotto manualmente (e con attenzione) sarà molto più leggibile di uno prodotto automaticamente da Less. Dipende da cosa si sta facendo. Se il prodotto è commerciale, l'obiettivo finale è una buona esperienza utente, con codice valido e ottimizzato. In questo caso, utilizzate l'output del preprocessore come CSS principale, ma includete il file originale per gli sviluppatori. Anche se il vostro CSS non sarà conforme agli standard di WordPress, includere il file originale colma in qualche modo il divario fino a quando WordPress non prenderà una posizione ufficiale. Sacrificare gli standard di codifica CSS per semplificare il processo di sviluppo (con l'obiettivo di una migliore esperienza utente) è accettabile. Sacrificare la validità del codice no.
Come puoi contribuire agli standard di codifica di WordPress?
Scrivere codice è come scrivere: ognuno ha il suo stile unico. Il tuo HTML potrebbe essere diverso dal mio, il mio JavaScript potrebbe farti sanguinare gli occhi e il tuo CSS potrebbe essere incredibilmente bello. Ma quando si tratta di collaborare a un progetto come WordPress, avere standard di programmazione coerenti è fondamentale.
Gli standard di codifica di WordPress esistono per garantire che chiunque contribuisca al codice sorgente possa facilmente leggere, comprendere e sviluppare il lavoro altrui. Aderendo a questi standard, si parla essenzialmente la stessa lingua degli altri collaboratori. È come accettare di utilizzare regole grammaticali e di formattazione coerenti in modo che tutti possano collaborare senza problemi allo stesso libro.
Se vuoi contribuire a WordPress, familiarizzare con gli standard di programmazione e seguirli è fondamentale. Questo permette al tuo stile di programmazione di integrarsi perfettamente con la più ampia base di codice di WordPress.
Conclusioni
Rispettare gli standard di codifica di WordPress è essenziale per mantenere una base di codice coesa e collaborativa. Queste linee guida, sviluppate dalla community di WordPress, fungono da linguaggio comune per i contributori di tutto il mondo. Seguendo gli standard per PHP, HTML, CSS, JavaScript e accessibilità, gli sviluppatori possono garantire che il loro codice sia coerente, leggibile e manutenibile.
Con la continua evoluzione di WordPress, questi standard di codifica svolgeranno un ruolo cruciale nel promuovere un ambiente di sviluppo armonioso ed efficiente per l'intera community.
