WordPress garantiscono coerenza e manutenibilità attraverso la vasta base di codice della piattaforma. Queste linee guida meticolosamente realizzate distillano i suggerimenti di sviluppo di WordPress , promuovendo chiarezza ed efficienza.
Seguendo queste di manutenzione di WordPress , gli sviluppatori in tutto il mondo contribuiscono in modo armonioso, comprendendo il lavoro reciproco senza soluzione di continuità. Chiedi al tuo di sviluppo di WordPress di seguire diligentemente gli standard di codifica WordPress per garantire soluzioni di alta qualità, scalabili e mantenebili a lungo termine.
Perché attenersi agli standard di codifica WordPress?
Gli standard di codifica WordPress mirano a garantire la coerenza del codice tra progetti e collaboratori. Migliora la leggibilità e la manutenibilità per lo sviluppo collaborativo e facilita le revisioni del codice e l'adesione alle migliori pratiche in tutto l'ecosistema di WordPress.
Cosa sono gli standard di codifica WordPress?
Gli standard di codifica WordPress forniscono una base per la collaborazione e la coerenza attraverso il progetto e la comunità di WordPress, dal codice principale a temi e plugin. Questi standard, sviluppati dalla comunità di WordPress, in consultazione con WordPress Support Foums servono come migliori pratiche che gli sviluppatori e i collaboratori di WordPress dovrebbero seguire.
Scopri 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. Adependo a loro, il codice appare come scritto da una sola persona, rendendo più facile per chiunque comprendere e modificare.
Contributo a wordpress core
Se contribuire a WordPress Core, è cruciale familiarizzare con questi standard, poiché il codice inviato deve essere conforme.
Hai difficoltà a mantenere gli standard di codifica per il tuo unico sito WordPress?
Lascia che i nostri sviluppatori di WordPress esperti gestiscano il mal di testa!
Componenti degli standard di codifica WordPress
Gli standard coprono le linee guida specifiche del linguaggio per CSS, HTML, JavaScript e PHP, nonché le linee guida di accessibilità allineate a WCAG AA.
Leggi anche: come convertire HTML in 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 WordPress
Esploriamo gli standard di codifica WordPress attraverso vari esempi per comprendere la loro applicazione in scenari del mondo reale. Questi esempi illustrano le migliori pratiche raccomandate per scrivere codice chiaro e mantenebile in WordPress.
PHP in WordPress
WordPress utilizza gli aggiornamenti PHP come linguaggio di programmazione principale. L'adesione agli standard di codifica PHP è cruciale per il codice mantenibile e coerente in WordPress. Ecco perché gli standard di codifica PHP contano:
Pause di linea
WordPress non specifica molto sulle interruzioni della linea, ma è comune aggiungerne una dopo la maggior parte delle dichiarazioni. Inoltre, si consiglia di mettere definizioni variabili, se blocchi e elementi di array su righe separate.
Rientro
Per semplificare la lettura del codice, utilizzare il rientro per mostrare la sua struttura logica. Le schede devono essere utilizzate all'inizio delle linee, mentre gli spazi vengono utilizzati per il rientro della linea media.
Utilizzo dello spazio
Rendi la lettura più facile da leggere il tuo codice rimuovendo eventuali spazi extra alla fine delle righe. Inoltre, elimina le linee vuote con schede o spazi non di rottura. Usa gli spazi tra parentesi per chiarezza. Aggiungi una pausa di riga dopo un tutore di apertura e prima di un tutore di chiusura, ad eccezione di Typecasting.
Citazioni
In WordPress, la regola principale è quella di utilizzare le citazioni singole per le stringhe a meno che tu non stia valutando qualcosa all'interno. Se hai bisogno di citazioni all'interno di una stringa, alternate tra citazioni singole e doppie. Le citazioni di fuga sono consentite ma raramente necessarie.
Bretelle
Il modo più semplice è usare sempre le parentesi graffe. Mentre gli standard consentono di saltare le parentesi graffe per le istruzioni "if" a linea singola senza blocchi multi-line nella stessa struttura, ciò non è consentito per i loop a linea singola. Preferisco sempre usare le parentesi graffe per la chiarezza. Inoltre, gli standard specificano il posizionamento del tutore di apertura sulla stessa riga dell'istruzione iniziale, non sotto di essa come nella documentazione PHP.
Formattazione di query SQL
Quando si scrive query SQL, ricordati di capitalizzare le parole chiave. Le query complesse dovrebbero essere divise in più righe. È importante comprendere bene le domande, in particolare i loro aspetti di sicurezza, che discuteremo più avanti. Gli attacchi di iniezione SQL si verificano a causa di errori di sicurezza di WordPress , consentendo agli hacker di accedere e manipolare direttamente il database dietro un sito WordPress.
Convenzioni di denominazione
Nel codice WordPress, evita la camelca per i nomi. Le funzioni dovrebbero usare caratteri minuscolati, con sottolinei se necessario. I nomi delle classi dovrebbero capitalizzare la prima lettera di ciascuna parola, separata da sottoti.
I nomi dei file dovrebbero essere tutti minuscoli, con trattini tra le parti. Se un file contiene una singola classe, nominalo dopo la classe, prefisso da "classe-".
Utilizzare i valori stringa per gli argomenti della funzione anziché i booleani per la chiarezza. La regola più importante è rendere i nomi descrittivi. In un ambiente collaborativo, mira ad 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 dimentichi un segno uguale, causerà un errore anziché valutare a True. Se ti piace usare gli operatori ternari, è consentito, ma si consiglia di verificare la verità per rendere le cose più chiare. Un'eccezione è quando si verifica le variabili non vuote usando! vuoto().
Formattazione HTML
Secondo il codice WordPress, è importante convalidare tutto il codice HTML utilizzando il validatore W3C. Tuttavia, il codice valido non significa sempre che sia un buon codice, sebbene esista una connessione chiara tra i due.
Doctype
WordPress segue la specifica XHTML 1.0 raccomandata dal W3C nel 2000. Nonostante ciò, il tema di venti undici, un default in WordPress, utilizza HTML5. Non esiste un vero conflitto perché HTML5 include la serializzazione XML, che consente l'uso di "XHTML5".
Usando citazioni
In HTML, le citazioni sono utilizzate principalmente per gli attributi e i loro valori. Puoi scegliere citazioni singole o doppie, ma attenersi a un tipo in modo coerente. Personalmente, uso citazioni singole ove possibile, come faccio in PHP, per coerenza. Questo mi aiuta a individuare rapidamente tutti i casi speciali in una linea solo guardando le citazioni.
Tag di chiusura
La specifica XHTML impone la chiusura di tutti i tag. Gli elementi vuoti devono essere chiusi con una barra in avanti appena prima dell'ultima fascia d'angolo. Assicurati che ci sia uno spazio prima della barra in avanti, come specificato.
Rientro
Rientra il tuo html seguendo le stesse regole di PHP. Punta a una struttura logica con il tuo rientro. Quando si combinano PHP e HTML, rientrano i blocchi PHP in base al solito flusso di rientro.
Formattazione CSS
La formattazione di CSS prevede l'organizzazione e lo styling della presentazione dei contenuti Web, garantendo coerenza e leggibilità su diversi dispositivi e browser. CSS formattato correttamente migliora la struttura e il fascino visivo dei siti Web, contribuendo a una migliore esperienza utente.
Per saperne di più: come rimuovere CSS inutilizzati in WordPress?
Rientro e struttura
Il tuo CSS dovrebbe seguire questo schema approssimativo: scrivi ogni selettore su una riga separata, anche se si elenca più selettori per un set di regole. Inoltre, ogni coppia di valore di proprietà dovrebbe sedersi sulla propria linea. Metti il tutore di apertura sulla linea del selettore e metti il tutore di chiusura su una linea separata con la stessa rientranza del selettore di apertura.
Convenzioni di denominazione
Usa solo caratteri minuscoli. Parole separate all'interno di un selettore con un trattino. Dai ai tuoi selettori i nomi leggibili dall'uomo.
Proprietà e valori
Ci sono alcune regole per scrivere proprietà e valori. Utilizzare le versioni shorthand di proprietà ove possibile, tranne quando si sovrascrive una proprietà precedentemente definita. Usa il codice esagonale minuscolo per i colori ove possibile. Se appropriato, utilizzare la versione più breve. Inserire uno spazio dopo il colon seguendo una proprietà. Usa sempre i caratteri minuscola, tranne quando è richiesto un carattere maiuscolo, ad esempio con nomi di carattere e proprietà specifiche del fornitore. Organizzare le proprietà CSS in ordine alfabetico, con le proprietà specifiche del fornitore di eccezione, che dovrebbero sempre precedere la loro controparte generale e le proprietà dimensionali, che dovrebbero essere raggruppate insieme. Se sono specificate la larghezza e l'altezza, scrivere prima la larghezza.
Commentando
CSS supporta solo un tipo di commento: stile a blocchi; Non ha una notazione separata per i commenti in linea. Scrivi brevi commenti su una riga, senza interruzione di riga di seguito. Per commenti che si estendono su più righe, inserire una rottura di riga subito dopo la sintassi di apertura e un'interruzione di linea appena prima della sintassi di chiusura. Se si utilizzano i commenti per delineare le sezioni del codice, utilizzare la seguente notazione:
Utilizzo dei preprocessori CSS
L'uso di preprocessori CSS come SASS e meno rende molto più facili le nostre vite come sviluppatori, ma non sono privi di svantaggi. Il codice prodotto da questi strumenti è generalmente valido ma non si può dire che sia molto pulito. Un foglio di stile prodotto manualmente (e pensieroso) sarà molto più leggibile di quello prodotto automaticamente da meno. Dipende da cosa stai facendo. Se il tuo prodotto è commerciale, l'obiettivo finale è una buona esperienza utente, con codice valido e ottimizzato. In questo caso, utilizzare l'output del preprocessore come CSS principale, ma includi il file originale per gli sviluppatori. Mentre il tuo CSS non si conformerà agli standard di WordPress, incluso il file originale colpa il divario leggermente fino a quando WordPress non assume una posizione ufficiale. Sacrificare gli standard di codifica CSS al fine di semplificare il processo di sviluppo (con l'obiettivo di una migliore esperienza utente) è OK. Sacrificare la validità del codice non lo è.
Come puoi contribuire agli standard di codifica WordPress?
Il codice è come scrivere: ognuno ha il proprio stile unico. Il tuo HTML potrebbe apparire diverso dal mio, il mio JavaScript potrebbe far sanguinare gli occhi e il tuo CSS potrebbe essere una vita bella. Ma quando si tratta di collaborare a un progetto come WordPress, è cruciale avere standard di codifica coerenti.
Gli standard di codifica WordPress esistono per garantire che chiunque contribuisca alla base di codice possa facilmente leggere, comprendere e basarsi sul lavoro degli altri. Adepando a questi standard, stai essenzialmente parlando della stessa lingua di altri collaboratori. È come accettare di utilizzare coerenti regole di grammatica e formattazione in modo che tutti possano collaborare perfettamente allo stesso libro.
Se vuoi contribuire a WordPress, è fondamentale familiarizzare e seguire gli standard di codifica. Permette al tuo stile di codifica individuale di mesh perfettamente con la base di codice WordPress più grande.
Conclusioni
Attenersi agli standard di codifica WordPress è essenziale per mantenere una base di codice coesa e collaborativa. Queste linee guida, sviluppate dalla comunità di WordPress, fungono da linguaggio comune per i collaboratori in 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 mantenibile.
Mentre WordPress continua a evolversi, questi standard di codifica svolgeranno un ruolo cruciale nel promuovere un ambiente di sviluppo armonioso ed efficiente per l'intera comunità.
