Il codice Boilerplate come termine è spesso usato in modo dispregiativo poiché a nessuno sembra particolarmente piacere scriverlo (compresi gli sviluppatori di WordPress). Si riferisce al codice che viene ripetuto in molti punti senza alterazioni come un'impalcatura, prima di scrivere codice che effettivamente fa qualcosa. Alcuni linguaggi come Java e C++ sono stati criticati per essere così. Ma tutta questa impalcatura, tuttavia, c'è per una ragione. Cioè, fornire e far rispettare i principi di buona organizzazione nella struttura del codice (Best practices).

Nel contesto dei temi e dei plugin di WordPress, i vantaggi dell'utilizzo del codice boilerplate sono dimostrati in modo più chiaro e diretto. Esistono diversi progetti WordPress che forniscono una raccolta di codice boilerplate ben congegnato, che può aiutarti a organizzare il tuo codice ed evitare errori.

Cos'è il codice boilerplate?

Il codice Boilerplate è fondamentalmente uno scheletro di directory e file di codice sorgente che puoi utilizzare nello sviluppo del tuo progetto. Le directory aiutano a organizzare i vari file di codice sorgente nella posizione corretta e di solito la struttura rispecchia quella sulla piattaforma di sviluppo.

Nel caso dei plugin di WordPress, i file del codice sorgente di solito contengono definizioni, valori e commenti delle funzioni segnaposto che descrivono quale parte del codice va dove. I temi Boilerplate WordPress forniscono anche una struttura di directory con js scheletro organizzato e annotato e file CSS.

Vantaggi di boilerplate nello sviluppo di WordPress

Tutti i plugin di WordPress hanno alcune funzioni comuni come l'attivazione, la disattivazione, così come i vari hook che devono implementare. Un codice standard può fornire una struttura comune, ben progettata e che applica buone pratiche software. Ci sono tre risultati positivi che si ottengono utilizzando il codice standard: migliore qualità del codice, manutenzione più semplice e sviluppo più rapido. E questi, a loro volta, ti rendono uno sviluppatore WordPress migliore.

Migliore qualità del codice

Sebbene la qualità del codice del core di WordPress sia ottima, di solito non è il caso dei plugin di WordPress. Una conseguenza naturale dell'utilizzo di boilerplate è la standardizzazione. Plugin conformi a uno standard che applica le buone pratiche, hanno un codice più pulito e, soprattutto, nel posto giusto. Boilerplate incoraggia inoltre gli sviluppatori a implementare l'interfaccia e la funzionalità del plugin nella sua interezza. Fornendo quell'impalcatura, ti aiuta a non tralasciare qualcosa o implementarlo male da qualche parte sbagliata.

È anche un grande aiuto per gli sviluppatori WordPress principianti perché tutto è disposto correttamente e annotato con commenti.

Manutenzione più facile

Tutto quanto sopra comporta una manutenzione più semplice. Il codice scritto utilizzando boilerplate è più facile da leggere, comprendere e risolvere i problemi. Con la standardizzazione, uno sviluppatore può prendere il tuo codice e sapere esattamente dove cercare. Tuttavia, non è solo per gli altri sviluppatori di WordPress, ma anche per te stesso. Il codice che è stato scritto una settimana fa ed è ancora fresco nella tua mente, diventerà rapidamente incomprensibile tra qualche mese.

Sviluppo più veloce

Il codice Boilerplate aiuta anche ad accelerare i tempi di sviluppo. Fornendoti uno scheletro di lavoro completo del progetto, ti consente di iniziare a scrivere codice e design nei luoghi che contano. Non è necessario perdere tempo a organizzare il codice o a capire quali funzioni predefinite o componenti CSS sono necessari e quindi scriverli.

Ma il vantaggio più grande è quando crei i tuoi pacchetti standard più avanzati. Se di solito crei determinati tipi di siti WordPress, come e-commerce o pagine personali, allora accade la magia. Puoi scrivere un pacchetto con file scheletro che contengono codice segnaposto e caratteristiche del tema comuni a tutti i progetti di un certo tipo. In questo modo, decomprimi il pacchetto e inizi a riempirlo solo con le specifiche del progetto.

Ospita il tuo sito web con Pressidium

GARANZIA DI RIMBORSO DI 60 GIORNI

GUARDA I NOSTRI PIANI

Se sei un cliente di Pressidium, puoi utilizzare il nostro strumento di clonazione che è stato creato pensando a questo semplice concetto. Ad esempio, supponiamo che tu abbia creato un sito WordPress di e-commerce standard sulla piattaforma Pressidium. Lo cloni con un solo clic e poi inizi a lavorare sulle specifiche, invece di ricominciare da zero ogni volta.

Utilizzo di boilerplate nei progetti WordPress

Esistono diversi "sistemi" standard per WordPress. Ma in questo articolo, ci concentreremo su due che sono sia ben noti che documentati: The WordPress Plugin Boilerplate e roots.io.

Il plug-in Boilerplate di WordPress si pubblicizza come una "base standardizzata, organizzata e orientata agli oggetti per la creazione di plug-in WordPress di alta qualità" e sicuramente offre. Segue l'API di WordPress e gli standard di documentazione, è basato sull'API del plugin di WordPress e fornisce un modo semplice per la localizzazione. Diamo un'occhiata al suo contenuto:

Changelog.md
Questo è il file Changelog in Markdown.

plugin-name/
La cartella principale che contiene tutto il resto.

admin/
Tutte le funzionalità relative all'amministrazione sono collocate qui. Include tre cartelle rilevanti, css , js e partials per questo.

includes/
Questa directory include classi per la funzionalità di attivazione/disattivazione, localizzazione i18n e la classe loader per definire tutte le funzioni/hook.

• class-plugin-name-activator.php
• class-plugin-name-deactivator.php
• class-plugin-name-i18n.php
• class-plugin-name-loader.php
• class-plugin-name.php
• index.php

languages/plugin-name.pot
Un file .pot boilerplate che contiene le stringhe localizzate per il tuo plugin.

public/
Qui inserisci tutto il codice del plug-in relativo al pubblico. Anche in questo caso hai le cartelle css , js e partials pertinenti.

NOTA : prima di iniziare, non dimenticare di rinominare tutte le occorrenze di "nome plug-in" con il nome del tuo plug-in.

Il nostro secondo sistema boilerplate scelto è molto più complesso e quindi non è possibile trattarlo nella sua interezza in questo articolo. Tuttavia, ha un'eccellente documentazione online. Gli sviluppatori hanno anche scritto una serie di e-book per ogni componente che puoi acquistare dal sito ufficiale!

Roots.io è un sistema boilerplate avanzato che offre tre componenti (Trellis, Bedrock e Sage) che possono essere utilizzati separatamente o insieme. È progettato per essere utilizzato per progetti WordPress e non solo plugin o temi. Dispone di funzionalità avanzate come il provisioning di macchine virtuali tramite Vagrant, la gestione delle dipendenze con Composer, il supporto Sass per la scrittura di fogli di stile, la correzione automatica degli errori Javascript, il test del browser, l'ottimizzazione delle immagini e altro ancora. Si basa sul boilerplate HTML5 e viene fornito con l'ultima versione di Bootstrap.

In chiusura

Ci sono molti sistemi boilerplate là fuori, ognuno dei quali soddisfa esigenze diverse. Scegli Roots.io se sei uno sviluppatore WordPress avanzato che necessita di una soluzione standard completa per progetti WordPress insieme a funzionalità di integrazione e toolchain. Se sei uno sviluppatore WordPress principiante o hai solo bisogno di un semplice boilerplate per iniziare a sviluppare il tuo plugin o tema, allora The WordPress Plugin Boilerplate è più adatto alle tue esigenze.