hook_views_api

Register View API information. This is required for your module to have its include files loaded; for example, when implementing hook_views_default_views().

Return value

An array with the following possible keys:

• api: (required) The version of the Views API the module implements.
• path: (optional) If includes are stored somewhere other than within the root module directory or a subdirectory called includes, specify its path here.
• template path: (optional) A path where the module has stored it's views template files. When you have specificed this key views automatically uses the template files for the views. You can use the same naming conventions like for normal views template files.

Related topics

Views' hooks

Hooks that can be implemented by other modules in order to implement the Views API.

265 functions implement hook_views_api()

File

contributions/views/docs/docs.php, line 286

This file contains no working PHP code; it exists to provide additional documentation for doxygen as well as to document hooks in the standard Drupal manner.

Code

<?php
function hook_views_api() {
  return array(
    'api' => 2, 
    'path' => drupal_get_path('module', 'example') . '/includes/views', 
    'template path' => drupal_get_path('module', 'example') . 'themes',
  );
}
?>