Правила наименования и размещения вашего модуля Drupal 8

Прежде чем вы начнете

Если вы хотите, чтобы PHP помог выявить ваши ошибки на сайте тестирования, попробуйте настройки, описанные здесь: Отображение всех ошибок при разработке.

Назовите свой модуль

Первый шаг в создании модуля - выбрать для него «короткое имя» или имя машины. Это имя машины будет использоваться в нескольких файлах и функциях вашего модуля, а ядро Drupal используется программно для обозначения вашего модуля.

Есть несколько важных правил, которым нужно следовать при выборе имени машины:

• Оно должно начинаться с буквы.
• Оно должен содержать только строчные буквы и подчеркивания.
• Оно не должен содержать пробелов.
• Оно должно быть уникальным. Ваш модуль не должен иметь такое же короткое имя, как любой другой модуль, тема или профиль установки, который вы будете использовать на сайте.
• Не должно быть каких-либо зарезервированных терминов: src, lib, vendor, assets, css, files, images, js, misc, templates, includes, fixtures, Drupal

Для этого случая мы выберем «hello_world» в качестве имени машины.

Важное примечание: не используйте заглавные буквы в имени компьютера вашего модуля, так как Drupal не распознает ваши реализации ловушек. См. Понимание системы хуков для модулей Drupal.

Создайте папку для вашего модуля

Учитывая, что мы выбираем имя машины «hello_world», запустите модуль, создав папку в вашей установке Drupal по пути: /modules/custom/hello_world или /sites/all/modules/hello_world. Вы можете опустить /custom/subfolder и поместить свой модуль в /modules/hello_worldfolder, но часто неплохо иметь выделенное место для ваших собственных модулей, поэтому вам не придется искать их среди других, загруженных из Drupal. орг.

Обратите внимание, что нет необходимости использовать то же имя для папки вашего модуля, что и имя вашего компьютера. Вместо этого вы можете использовать имя папки HelloWorld. Однако вы должны не забывать использовать имя компьютера программно в коде и именах файлов вашего модуля.

Предыдущие версии Drupal требовали, чтобы пользовательские модули были расположены в /sites/all/modules, так как основные модули были расположены в /modules. Тем не менее, в Drupal 8 /modules теперь освобожден для ваших пользовательских и дополнительных модулей. Все основные модули и файлы библиотек теперь находятся в каталоге /core. В Drupal 8 вы все еще можете использовать лучшие практики Drupal 7/6 по размещению своих пользовательских и Drupal.org, добавленных (загруженных) модулей в /sites/all/modules, но вы также можете просто поместить их в каталог / modules, который имеет тот же эффект.

Наш пример модуля еще не работает, сначала нам понадобится файл .info.yml. Узнайте больше о том, как сообщить Drupal 8 о вашем модуле с помощью файла .info.yml. Мы активируем модуль позже в руководстве.

Стандарты кодирования

Мы настоятельно рекомендуем вам придерживаться стандартов кодирования Drupal при написании собственных пользовательских модулей. Это требование для любых предложений по изменению кода ядра Drupal, а также рекомендация для размещенного кода на drupal.org.

Смотрите также

• Отображение всех ошибок при разработке
• Стандарты кодирования