Gli standard di codifica di WordPress garantiscono la coerenza e la manutenibilità della vasta base di codice della piattaforma. Queste linee guida meticolosamente realizzate distillano i suggerimenti per lo sviluppo di WordPress, favorendo chiarezza ed efficienza.
Seguendo queste guide alla manutenzione di WordPress, gli sviluppatori di tutto il mondo contribuiscono armoniosamente, comprendendo il lavoro dell'altro senza problemi. Fate in modo che il vostro team di sviluppo di WordPress segua diligentemente gli standard di codifica 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 le revisioni del codice e l'adesione alle migliori pratiche in tutto l'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 comunità di WordPress, dal codice principale ai temi e ai plugin. Questi standard, sviluppati dalla comunità di WordPress, in consultazione con il supporto di WordPress, rappresentano le migliori pratiche che gli sviluppatori e i 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 gli errori più comuni, a migliorare la leggibilità del codice e a semplificare le modifiche. Rispettandoli, il codice appare come se fosse stato scritto da un'unica persona, rendendo più facile la comprensione e la modifica da parte di chiunque.
Contributo al nucleo di WordPress
Se si contribuisce al core di WordPress, è fondamentale conoscere questi standard, poiché il codice inviato deve essere conforme.
Avete difficoltà a mantenere gli standard di codifica per il vostro sito WordPress?
Lasciate che i nostri esperti sviluppatori di WordPress si occupino del mal di testa!
Componenti degli standard di codifica di WordPress
Gli standard comprendono linee guida specifiche per i linguaggi CSS, HTML, JavaScript e PHP, nonché linee guida sull'accessibilità allineate alle WCAG AA.
Leggete anche: Come convertire l'HTML in un tema WordPress?
Eccezione per le biblioteche 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 migliori pratiche consigliate per scrivere codice chiaro e manutenibile in WordPress.
PHP IN WORDPRESS
WordPress utilizza gli aggiornamenti PHP come linguaggio di programmazione principale. L'aderenza agli standard di codifica PHP è fondamentale per mantenere il codice di WordPress inalterato e coerente. Ecco perché gli standard di codifica PHP sono importanti:
Interruzioni di linea
WordPress non specifica molto sulle interruzioni di riga, ma è comune aggiungerne una dopo la maggior parte delle dichiarazioni. Inoltre, si raccomanda di mettere le definizioni delle variabili, i blocchi if e gli elementi degli array su righe separate.
Indentazione
Per rendere il codice più facile da leggere, utilizzare l'indentazione per mostrarne la struttura logica. Le tabulazioni devono essere usate all'inizio delle righe, mentre gli spazi sono usati per l'indentazione a metà riga.
Utilizzo dello spazio
Per facilitare la lettura del codice, eliminare gli spazi aggiuntivi alla fine delle righe. Inoltre, eliminate le righe vuote con tabulazioni o spazi non spezzati. Usate gli spazi all'interno delle parentesi per maggiore chiarezza. Aggiungete un'interruzione di riga dopo una parentesi graffa di apertura e prima di una parentesi graffa di chiusura, tranne che nel caso di battitura.
Citazioni
In WordPress, la regola principale è quella di utilizzare gli apici singoli per le stringhe, a meno che non si stia valutando qualcosa all'interno. Se è necessario usare le virgolette all'interno di una stringa, alternare tra apici singoli e doppi. L'escape delle virgolette è consentito ma raramente necessario.
Apparecchio per i denti
Il modo più semplice è quello di usare sempre le parentesi graffe. Mentre gli standard consentono di saltare le parentesi graffe per le dichiarazioni "if" a riga singola senza blocchi a più righe nella stessa struttura, ciò non è consentito per i loop a riga singola. Preferisco usare sempre le parentesi graffe per chiarezza. Inoltre, gli standard specificano di mettere la parentesi graffa di apertura sulla stessa riga dell'istruzione iniziale, non sotto di essa come nella documentazione di PHP.
Formattazione delle query SQL
Quando si scrivono le query SQL, ricordarsi di mettere in maiuscolo le parole chiave. 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, che consentono agli hacker di accedere e manipolare direttamente il database di un sito WordPress.
Convenzioni di denominazione
Nel codice di WordPress, evitare il CamelCase per i nomi. Le funzioni devono utilizzare caratteri minuscoli, con sottolineature se necessario. I nomi delle classi devono avere la prima lettera di ogni parola in maiuscolo, separata da trattini bassi.
I nomi dei file devono essere tutti minuscoli, con i trattini tra le parti. Se un file contiene una sola classe, il nome deve essere quello della classe stessa, preceduto da "class-".
Per chiarezza, utilizzare valori stringa per gli argomenti delle funzioni anziché booleani. La regola più importante è che i nomi siano descrittivi. In un ambiente collaborativo, cercate di aiutare tutti a capire il vostro codice.
Dichiarazioni a 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 il segno di uguale, la variabile causerà un errore invece di essere valutata come vera. Se vi piace usare gli operatori ternari, è consentito, ma si raccomanda di controllare la verità per rendere le cose più chiare. Un'eccezione è rappresentata dal controllo di variabili non vuote tramite ! empty().
FORMATTAZIONE HTML
Secondo il Codex di WordPress, è importante convalidare tutto il codice HTML utilizzando il Validatore W3C. Tuttavia, un codice valido non significa sempre che sia un buon codice, anche se c'è una chiara connessione tra le due cose.
Tipo di documento
WordPress segue le specifiche XHTML 1.0 raccomandate dal W3C nel 2000. Tuttavia, 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 citazioni
In HTML, le virgolette sono utilizzate principalmente per gli attributi e i loro valori. Si possono scegliere apici singoli o doppi, ma è bene attenersi a un solo tipo. Personalmente, uso le virgolette singole dove 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 richiedono la chiusura di tutti i tag. Gli elementi vuoti devono essere chiusi con una barra in avanti subito prima dell'ultima parentesi angolare. Assicurarsi che ci sia uno spazio prima della barra in avanti, come specificato.
Indentazione
Indentare l'HTML seguendo le stesse regole del PHP. Cercate di ottenere una struttura logica con l'indentazione. Quando si combinano PHP e HTML, indentare i blocchi PHP in base al flusso di indentazione abituale.
FORMATTARE I CSS
La formattazione dei CSS comporta l'organizzazione e lo styling della presentazione dei contenuti web, garantendo coerenza e leggibilità su diversi dispositivi e browser. Una corretta formattazione dei CSS migliora la struttura e l'aspetto visivo dei siti web, contribuendo a migliorare l'esperienza dell'utente.
Per saperne di più: Come rimuovere i CSS inutilizzati in WordPress?
Indentazione e struttura
Il vostro CSS dovrebbe seguire questo schema approssimativo: Scrivere ogni selettore su una riga separata, anche se si elencano più selettori per un insieme di regole. Inoltre, ogni coppia proprietà-valore deve stare sulla propria riga. Mettete la parentesi graffa di apertura sulla riga del selettore e la parentesi graffa di chiusura su una riga separata con la stessa indentazione del selettore di apertura.
Convenzioni di denominazione
Utilizzare solo caratteri minuscoli. Separare le parole all'interno di un selettore con un trattino. Dare ai selettori nomi leggibili.
Proprietà e valori
Esistono alcune regole per la scrittura di proprietà e valori. Usare versioni abbreviate delle proprietà ogni volta che è possibile, tranne quando si sovrascrive una proprietà precedentemente definita. Usare il codice HEX minuscolo per i colori, quando possibile. Se opportuno, utilizzare la versione più breve. Inserire uno spazio dopo i due punti che seguono una proprietà. Usare sempre caratteri minuscoli, tranne quando è richiesto un carattere maiuscolo, come nel caso dei nomi dei font e delle proprietà specifiche del fornitore. Organizzare le proprietà CSS in ordine alfabetico, con l'eccezione delle proprietà specifiche del fornitore, che dovrebbero sempre precedere la loro controparte generale, e delle proprietà dimensionali, che dovrebbero essere raggruppate. Se vengono specificate larghezza e altezza, scrivere prima la larghezza.
Commenti
I CSS supportano solo un tipo di commento - lo stile a blocchi; non hanno una notazione separata per i commenti in linea. Scrivere commenti brevi su una riga, senza interruzione di riga sottostante. Per i commenti che si estendono su più righe, inserire un'interruzione di riga subito dopo la sintassi di apertura e un'interruzione di riga subito prima della sintassi di chiusura. Se si utilizzano i commenti per delineare sezioni di codice, si utilizza la seguente notazione:
Utilizzo dei preprocessori CSS
L'uso di preprocessori CSS come SASS e Less rende la nostra vita di sviluppatori molto più facile, ma non sono privi 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 vostro 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, l'inclusione del file originale colma il divario in attesa che WordPress prenda una posizione ufficiale. Sacrificare gli standard di codifica dei CSS per semplificare il processo di sviluppo (con l'obiettivo di migliorare l'esperienza dell'utente) va bene. Sacrificare la validità del codice non lo è.
Come potete contribuire agli standard di codifica di WordPress?
Il codice è come la scrittura: ognuno ha il suo stile unico. Il vostro HTML potrebbe sembrare diverso dal mio, il mio JavaScript potrebbe farvi sanguinare gli occhi e il vostro CSS potrebbe essere di una bellezza che cambia la vita. Ma quando si tratta di collaborare a un progetto come WordPress, avere standard di codifica coerenti è fondamentale.
Gli standard di codifica di WordPress esistono per garantire che chiunque contribuisca alla base di codice possa facilmente leggere, comprendere e costruire sul lavoro degli altri. 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 volete contribuire a WordPress, è fondamentale conoscere e seguire gli standard di codifica. Ciò consente al vostro stile di codifica individuale di integrarsi perfettamente con la più ampia base di codice di WordPress.
Conclusioni
Attenersi agli standard di codifica di WordPress è essenziale per mantenere una base di codice coesa e collaborativa. Queste linee guida, sviluppate dalla comunità di WordPress, servono come linguaggio comune per i collaboratori 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 comunità.
