Ogni plugin WordPress inizia con un singolo file PHP. Man mano che il tuo plugin cresce, quel singolo file diventa ingestibile. Le funzioni sono sparse, le convenzioni di denominazione sono incoerenti e trovare la riga di codice giusta richiede più tempo del dovuto. Un plugin ben strutturato è più facile da mantenere, meno incline ai bug e più semplice da capire per altri sviluppatori.
Questa guida copre la struttura boilerplate che usano i plugin WordPress professionali, dall'organizzazione dei file all'autoloading fino all'iniezione delle dipendenze.
La Struttura dei File
Un plugin ben organizzato segue una struttura prevedibile. Il file radice è il tuo file principale del plugin con l'header del plugin. La directory /includes contiene le tue classi PHP. La directory /admin contiene il codice specifico dell'admin. La directory /public contiene il codice frontend. La directory /languages contiene i file di traduzione. La directory /assets contiene i file CSS e JavaScript.
Questa separazione degli ambiti rende chiaro dove trovare codice specifico e impedisce al codice admin di caricarsi nel frontend e viceversa.
Dai Namespace al Tuo Codice
I namespace PHP prevengono le collisioni di denominazione tra il tuo codice e altri plugin. Usa un namespace unico basato sul nome del tuo plugin: YourPlugin\Admin, YourPlugin\Frontend, YourPlugin\Api. WordPress non richiede i namespace, ma sono considerati buona pratica per qualsiasi plugin che definisca classi o funzioni.
Usa la parola chiave namespace in cima a ogni file PHP. Importa le classi con la parola chiave use invece di fare riferimento a nomi completamente qualificati in tutto il codice. Questo mantiene il codice pulito e rende facile vedere quali dipendenze esterne usa un file.
Autoloading con Composer
Le dichiarazioni manuali require_once sono soggette a errori e difficili da mantenere. L'autoloader di Composer gestisce il caricamento delle classi automaticamente in base alla tua struttura di directory e alle convenzioni di namespace.
Definisci il tuo autoloading in composer.json usando lo standard PSR-4. Mappa il prefisso del tuo namespace alla directory del sorgente. Esegui composer dump-autoload per generare l'autoloader. Includi il file vendor/autoload.php generato nel tuo file principale del plugin.
La Classe Principale del Plugin
La classe principale del plugin è il punto di ingresso per la funzionalità del tuo plugin. Definisce costanti, carica le dipendenze, registra gli hook e inizializza i sottocomponenti. Usa un pattern singleton o l'iniezione delle dipendenze per gestire l'istanza della classe principale.
Mantieni la classe principale focalizzata sull'orchestrazione. Non dovrebbe contenere logica di business: quella appartiene a classi specializzate. La classe principale sa quali classi caricare e quando, ma non come funzionano internamente.
Separare Codice Admin e Frontend
Il codice admin - pagine di impostazioni, registrazione di custom post type, handler AJAX admin - non dovrebbe caricarsi nel frontend. Allo stesso modo, il codice frontend - shortcode rivolti al pubblico, template, script frontend - non dovrebbe caricarsi nell'admin.
Usa directory separate e classi loader separate per il codice admin e frontend. WordPress fornisce is_admin() per controllare il contesto corrente, ma non affidarti a blocchi if-else in un singolo file. Usa classi separate che vengono istanziate condizionatamente.
Registrare Hook in un Plugin Basato su Classi
In un plugin basato su classi, gli hook vengono registrati chiamando add_action() e add_filter() nel costruttore o in un metodo init. Conserva le registrazioni degli hook in un metodo dedicato invece di spargerle nella classe. Questo rende facile vedere tutti gli hook a colpo d'occhio.
Usa $this per fare riferimento al metodo quando la callback dell'hook è un metodo di classe. Passa un array con [$this, 'method_name'] come callback. Per i metodi statici, usa ['ClassName', 'method_name'].
Il punto fondamentale
Un plugin ben strutturato è un investimento che paga dividendi per tutta la vita del plugin. Dai namespace al tuo codice, usa l'autoloading di Composer, separa gli ambiti in classi dedicate e mantieni la classe principale focalizzata sull'orchestrazione. Il te del futuro - e qualsiasi sviluppatore che lavori sul tuo codice - ti ringrazierà.
