Урок - Хук hook_views_api()

Обучающий онлайн курс
Drupal 6, Разработка модулей.

Лицензия: Копирование запрещено.

Хук hook_views_api() - регистрация во Views

hook_views_api() - сообщает параметры для связи с модулем Views. hook_views_api должен вернуть массив данных о поддерживаемой модулем версии Views API.

hook_views_api() необходимо хранить в файле модуля *.module (ramech.module).

/**
* hook_views_api - регистрирует модуль во Views API
*/
function ramech_views_api() {
  return array(
    'api' => 2,
    'path' => drupal_get_path('module', 'ramech') .'/views',
  );
}

В данном примере мы сообщаем Views, что необходимо использовать API версии 2, а файлы взаимодействия с модулем Views хранятся в папке 'views' нашего модуля (папка ramech/views).

  • в api(обязательный параметр) указывается версия Views API, с которой будем работать.
  • в pathможет быть указано расположение исходных кодов для взаимодействия с моделум Views. Если path не задан, то модуль Views, будет искать файл <имя_модуля>.views.inc (ramech.views.inc) в папке самого модуля:
    /**
    * hook_views_api - регистрирует модуль во Views API
    */
    function ramech_views_api() {
      return array(
        'api' => 2,
      );
    }

    в этом случае файл <имя_модуля>.views.inc (ramech.views.inc) ищеся по пути <имя_модуля>.<имя_модуля>.views.inc (ramech/ramech.views.inc)