Same name and namespace in other branches
  1. 7.x-3.x views.api.php \views_hooks

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

File

docs/docs.php, line 56
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.

Functions

Namesort descending Location Description
hook_views_admin_links_alter docs/docs.php This hook should be placed in MODULENAME.views.inc and it will be auto-loaded. This must either be in the same directory as the .module file or in a subdirectory named 'includes'.
hook_views_api docs/docs.php Register View API information. This is required for your module to have its include files loaded; for example, when implementing hook_views_default_views().
hook_views_convert docs/docs.php Stub hook documentation
hook_views_data docs/docs.php Describe table structure to Views.
hook_views_data_alter docs/docs.php Alter table structure.
hook_views_default_views docs/docs.php This hook allows modules to provide their own views which can either be used as-is or as a "starter" for users to build from.
hook_views_default_views_alter docs/docs.php Alter default views defined by other modules.
hook_views_form_submit docs/docs.php Views form (View with form elements) submit handler. Called for all steps ($form_state['storage']['step']) of the multistep form.
hook_views_form_substitutions docs/docs.php This hook is called to get a list of placeholders and their substitutions, used when preprocessing a View with form elements.
hook_views_form_validate docs/docs.php Views form (View with form elements) validate handler. Called for all steps ($form_state['storage']['step']) of the multistep form.
hook_views_handlers docs/docs.php Register handler, file and parent information so that handlers can be loaded only on request.
hook_views_plugins docs/docs.php The full documentation for this hook is now in the advanced help.
hook_views_plugins_alter docs/docs.php Alter existing plugins data, defined by modules.
hook_views_post_build docs/docs.php This hook is called right after the build process. The query is now fully built, but it has not yet been run through db_rewrite_sql.
hook_views_post_execute docs/docs.php This hook is called right after the execute process. The query has been executed, but the pre_render() phase has not yet happened for handlers.
hook_views_post_render docs/docs.php Post process any rendered data.
hook_views_preview_info_alter docs/docs.php This hook should be placed in MODULENAME.views.inc and it will be auto-loaded. This must either be in the same directory as the .module file or in a subdirectory named 'includes'.
hook_views_pre_build docs/docs.php This hook is called right before the build process, but after displays are attached and the display performs its pre_execute phase.
hook_views_pre_execute docs/docs.php This hook is called right before the execute process. The query is now fully built, but it has not yet been run through db_rewrite_sql.
hook_views_pre_render docs/docs.php This hook is called right before the render process. The query has been executed, and the pre_render() phase has already happened for handlers, so all data should be available.
hook_views_pre_view docs/docs.php This hook is called at the very beginning of views processing, before anything is done.
hook_views_query_alter docs/docs.php Stub hook documentation
hook_views_query_substitutions docs/docs.php Stub hook documentation