Разработка модулей Drupal

Материал из Newman's WiKi.

Общая информация

Основная функциональность Drupal выполняется с помощью модулей. Модули бывают системные, или так называемые модули ядра -- core и дополнительные -- core-optional. Распологаться модули могут либо непосредственно в папке modules внутри framework'а либо в папке modules относительно сайтов работающих на данной установке. Имя модуля определяет имя папки внутри которой находятся все необходимые файлы. Так для модуля modulename все файлы будут находиться в папке modules/modulename. К выбору названия модуля следует относится с осторожностью. Это должно быть уникальное (по крайней мере для данной системы) имя и в нем могут быть использованы только символы латиницы и цифры.

В простейшем случае для работы модуля Drupal необходимо два файла:

• modulename.info - файл описания модуля
• modulename.module - файл с кодом модуля

Грабли: без вышеуказанных файлов Drupal даже не определит папку как модуль.

Также могут потребоваться следующие файлы:

• modulename.install - файл установки и инициализации
• ...

Файл описания модуля Drupal

В каждой папке с модулем должен находится файл modulename.info. Этот файл описывает параметры модуля и его взаимодействие с Drupal. Так же там находится информация для администратора сайта на Drupal.

Этот файл имеет следующий формат:

name = modulename
description = Description of module.
package = Core - optional
version = VERSION
core = 6.x

Параметры name и description могут содержать произвольный текст и отображаются в списке модулей, который видит администратор сайта.

package задает тим модуля. Либо это системный модуль Drupal (Core), либо это дополнительный модуль (Core - optional)

core определяет версию ядра Drupal с которой может работать данный модуль.

Еще может присутствовать информация о зависимости модулей. Указываются модули от которых зависит создаваемый модуль. Ниже приведена строка указывающая что создаваемый модуль требует для своей работы модуль комментариев.

dependencies[] = comment

Помимо этих строк могут быть строки добавленные системой версий и другая служебная информация.

Установка и инициализация модуля

Функции для установки и деинсталяции модуля указываются в файле modules/modulename/modulename.install.

При отладке возможны грабли. Функция установки может не сработать если до этого не была проведена корректное отключение модуля. В этом случае Drupal клинит и он считает что install вызывать не надо. Лечится удалением соответствующей строки из таблицы system.