Regole di denominazione e posizionamento del vostro modulo Drupal 8
Prima di iniziare
Se volete che PHP vi aiuti a individuare gli errori sul sito di test, provate le impostazioni descritte qui: Visualizzare tutti gli errori durante lo sviluppo.
Nominate il vostro modulo
Il primo passo nella creazione di un modulo è scegliere per esso un “nome breve” o nome macchina. Questo nome macchina verrà utilizzato in diversi file e funzioni del vostro modulo, e il core di Drupal lo utilizza a livello programmatico per identificare il vostro modulo.
Ci sono alcune regole importanti da seguire quando si sceglie un nome macchina:
- Deve iniziare con una lettera.
- Deve contenere solo lettere minuscole e underscore.
- Non deve contenere spazi.
- Deve essere univoco. Il vostro modulo non deve avere lo stesso nome breve di qualsiasi altro modulo, tema o profilo di installazione che userete nel sito.
- Non deve contenere termini riservati:
src,lib,vendor,assets,css,files,images,js,misc,templates,includes,fixtures,Drupal
Per questo esempio, sceglieremo “hello_world” come nome macchina.
Nota importante: non utilizzate lettere maiuscole nel nome macchina del vostro modulo, poiché Drupal non riconoscerà le vostre implementazioni dei hook. Consultate Comprendere il sistema di hook dei moduli Drupal.
Create una cartella per il vostro modulo
Poiché abbiamo scelto “hello_world” come nome macchina, iniziate creando una cartella nella vostra installazione Drupal nel percorso: /modules/custom/hello_world oppure /sites/all/modules/hello_world. Potete omettere la sottocartella /custom e collocare il modulo direttamente in /modules/hello_world, ma è spesso una buona pratica avere uno spazio dedicato per i vostri moduli personalizzati, così da non doverli cercare tra quelli scaricati da Drupal.org.
Notate che non è necessario usare lo stesso nome per la cartella del modulo e per il nome macchina. Potete, ad esempio, chiamare la cartella HelloWorld. Tuttavia dovete ricordare di usare il nome macchina nel codice e nei nomi dei file del modulo.
Le versioni precedenti di Drupal richiedevano che i moduli personalizzati fossero collocati in /sites/all/modules, poiché i moduli core si trovavano in /modules. In Drupal 8, tuttavia, la cartella /modules è ora riservata ai vostri moduli personalizzati e aggiuntivi. Tutti i moduli core e le librerie sono ora nel percorso /core. In Drupal 8 potete ancora seguire le buone pratiche di Drupal 7/6 collocando i vostri moduli personalizzati e quelli scaricati da Drupal.org in /sites/all/modules, ma potete anche metterli direttamente in /modules, con lo stesso effetto.
Il nostro modulo di esempio non è ancora funzionante: per prima cosa ci serve un file .info.yml. Scoprite di più su come informare Drupal 8 del vostro modulo tramite un file .info.yml. Attiveremo il modulo più avanti nella guida.
Standard di codifica
Raccomandiamo vivamente di seguire gli standard di codifica di Drupal quando scrivete i vostri moduli personalizzati. È un requisito per qualsiasi proposta di modifica al core di Drupal ed è una raccomandazione per qualsiasi codice ospitato su drupal.org.