Règles de nommage et d’emplacement de votre module Drupal 8
Avant de commencer
Si vous souhaitez que PHP vous aide à détecter vos erreurs sur un site de test, essayez les réglages décrits ici : Afficher toutes les erreurs en développement.
Nommez votre module
La première étape dans la création d’un module est de choisir un « nom machine » court. Ce nom machine sera utilisé dans plusieurs fichiers et fonctions de votre module, et le noyau Drupal l’utilisera pour identifier votre module en programmation.
Voici quelques règles importantes à suivre lors du choix du nom machine :
- Il doit commencer par une lettre.
- Il ne doit contenir que des lettres minuscules et des underscores.
- Il ne doit pas contenir d’espaces.
- Il doit être unique. Votre module ne doit pas avoir le même nom machine qu’un autre module, thème ou profil d’installation que vous utiliserez sur le site.
- Il ne doit pas contenir de termes réservés :
src,lib,vendor,assets,css,files,images,js,misc,templates,includes,fixtures,Drupal
Dans cet exemple, nous choisirons « hello_world » comme nom machine.
Note importante : n’utilisez pas de majuscules dans le nom machine de votre module, car Drupal ne reconnaîtra pas vos implémentations de hooks. Voir Comprendre le système de hooks dans Drupal.
Créez un dossier pour votre module
Puisque nous avons choisi « hello_world », créez un dossier dans votre installation Drupal à l’un des chemins suivants : /modules/custom/hello_world ou /sites/all/modules/hello_world. Vous pouvez omettre le sous-dossier /custom et placer directement votre module dans /modules/hello_world, mais il est souvent préférable d’avoir un emplacement dédié pour vos modules personnalisés afin de ne pas les confondre avec ceux téléchargés depuis Drupal.org.
Notez qu’il n’est pas nécessaire que le nom du dossier soit identique au nom machine. Vous pouvez nommer le dossier HelloWorld, mais il faut impérativement utiliser le nom machine dans le code et les fichiers du module.
Les versions précédentes de Drupal exigeaient que les modules personnalisés soient placés dans /sites/all/modules tandis que les modules principaux étaient dans /modules. Avec Drupal 8, /modules est désormais libéré pour vos modules personnalisés et contribué, tandis que tous les modules de base et bibliothèques sont dans /core. Vous pouvez continuer à suivre les bonnes pratiques Drupal 7/6 en plaçant vos modules dans /sites/all/modules, ou simplement utiliser /modules, les deux fonctionnent.
Notre exemple de module ne fonctionne pas encore, il nous faut d’abord un fichier .info.yml. Pour en savoir plus, consultez Comment déclarer votre module Drupal 8 avec un fichier .info.yml. Nous activerons le module plus tard dans le guide.
Standards de codage
Nous recommandons vivement de respecter les standards de codage Drupal lors de l’écriture de modules personnalisés. C’est une exigence pour toute contribution au noyau Drupal et une recommandation pour le code publié sur drupal.org.