Hooks in Drupal 9
Same name and namespace in other branches
- 8 core/core.api.php \hooks
- 4 includes/module.inc \hooks
- 5 includes/module.inc \hooks
- 6 includes/module.inc \hooks
- 7 includes/module.inc \hooks
- 10 core/core.api.php \hooks
Define functions that alter the behavior of Drupal core.
One way for modules to alter the core behavior of Drupal (or another module) is to use hooks. Hooks are specially-named functions that a module defines (this is known as "implementing the hook"), which are discovered and called at specific times to alter or add to the base behavior or data (this is known as "invoking the hook"). Each hook has a name (example: hook_batch_alter()), a defined set of parameters, and a defined return value. Your modules can implement hooks that are defined by Drupal core or other modules that they interact with. Your modules can also define their own hooks, in order to let other modules interact with them.
To implement a hook:
- Locate the documentation for the hook. Hooks are documented in *.api.php files, by defining functions whose name starts with "hook_" (these files and their functions are never loaded by Drupal -- they exist solely for documentation). The function should have a documentation header, as well as a sample function body. For example, in the core file form.api.php, you can find hooks such as hook_batch_alter(). Also, if you are viewing this documentation on an API reference site, the Core hooks will be listed in this topic.
- Copy the function to your module's .module file.
- Change the name of the function, substituting your module's short name (name of the module's directory, and .info.yml file without the extension) for the "hook" part of the sample function name. For instance, to implement hook_batch_alter(), you would rename it to my_module_batch_alter().
- Edit the documentation for the function (normally, your implementation should just have one line saying "Implements hook_batch_alter().").
- Edit the body of the function, substituting in what you need your module to do.
To define a hook:
- Choose a unique name for your hook. It should start with "hook_", followed by your module's short name.
- Provide documentation in a *.api.php file in your module's main directory. See the "implementing" section above for details of what this should contain (parameters, return value, and sample function body).
- Invoke the hook in your module's code.
To invoke a hook, use methods on \Drupal\Core\Extension\ModuleHandlerInterface such as alter(), invoke(), and invokeAll(). You can obtain a module handler by calling \Drupal::moduleHandler(), or getting the 'module_handler' service on an injected container.
See also
\Drupal\Core\Extension\ModuleHandlerInterface
File
- core/
core.api.php, line 1594 - Documentation landing page and topics, plus core library hooks.
Functions
Name |
Location | Description |
|---|---|---|
| hook_aggregator_fetcher_info_alter |
core/ |
Perform alterations on the available fetchers. |
| hook_aggregator_parser_info_alter |
core/ |
Perform alterations on the available parsers. |
| hook_aggregator_processor_info_alter |
core/ |
Perform alterations on the available processors. |
| hook_ajax_render_alter |
core/ |
Alter the Ajax command data that is sent to the client. |
| hook_archiver_info_alter |
core/ |
Alter archiver information declared by other modules. |
| hook_batch_alter |
core/ |
Alter batch information before a batch is processed. |
| hook_block_access |
core/ |
Control access to a block instance. |
| hook_block_alter |
core/ |
Allow modules to alter the block plugin definitions. |
| hook_block_build_alter |
core/ |
Alter the result of \Drupal\Core\Block\BlockBase::build(). |
| hook_block_build_BASE_BLOCK_ID_alter |
core/ |
Provide a block plugin specific block_build alteration. |
| hook_block_view_alter |
core/ |
Alter the result of \Drupal\Core\Block\BlockBase::build(). |
| hook_block_view_BASE_BLOCK_ID_alter |
core/ |
Provide a block plugin specific block_view alteration. |
| hook_cache_flush |
core/ |
Flush all persistent and static caches. |
| hook_ckeditor_css_alter |
core/ |
Modify the list of CSS files that will be added to a CKEditor instance. |
| hook_ckeditor_plugin_info_alter |
core/ |
Modify the list of available CKEditor plugins. |
| hook_comment_links_alter |
core/ |
Alter the links of a comment. |
| hook_config_import_steps_alter |
core/ |
Alter the configuration synchronization steps. |
| hook_config_schema_info_alter |
core/ |
Alter config typed data definitions. |
| hook_config_translation_info |
core/ |
Introduce dynamic translation tabs for translation of configuration. |
| hook_config_translation_info_alter |
core/ |
Alter existing translation tabs for translation of configuration. |
| hook_contextual_links_alter |
core/ |
Alter contextual links before they are rendered. |
| hook_contextual_links_plugins_alter |
core/ |
Alter the plugin definition of contextual links. |
| hook_contextual_links_view_alter |
core/ |
Alter a contextual links element before it is rendered. |
| hook_countries_alter |
core/ |
Alter the default country list. |
| hook_cron |
core/ |
Perform periodic actions. |
| hook_css_alter |
core/ |
Alter CSS files before they are output on the page. |
| hook_data_type_info_alter |
core/ |
Alter available data types for typed data wrappers. |
| hook_display_variant_plugin_alter |
core/ |
Alter display variant plugin definitions. |
| hook_editor_info_alter |
core/ |
Performs alterations on text editor definitions. |
| hook_editor_js_settings_alter |
core/ |
Modifies JavaScript settings that are added for text editors. |
| hook_editor_xss_filter_alter |
core/ |
Modifies the text editor XSS filter that will used for the given text format. |
| hook_element_info_alter |
core/ |
Alter the element type information returned from modules. |
| hook_element_plugin_alter |
core/ |
Alter Element plugin definitions. |
| hook_entity_access |
core/ |
Control entity operation access. |
| hook_entity_base_field_info |
core/ |
Provides custom base field definitions for a content entity type. |
| hook_entity_base_field_info_alter |
core/ |
Alter base field definitions for a content entity type. |
| hook_entity_build_defaults_alter |
core/ |
Alter entity renderable values before cache checking in drupal_render(). |
| hook_entity_bundle_create |
core/ |
Act on entity_bundle_create(). |
| hook_entity_bundle_delete |
core/ |
Act on entity_bundle_delete(). |
| hook_entity_bundle_field_info |
core/ |
Provides field definitions for a specific bundle within an entity type. |
| hook_entity_bundle_field_info_alter |
core/ |
Alter bundle field definitions. |
| hook_entity_bundle_info |
core/ |
Describe the bundles for entity types. |
| hook_entity_bundle_info_alter |
core/ |
Alter the bundles for entity types. |
| hook_entity_create |
core/ |
Acts when creating a new entity. |
| hook_entity_create_access |
core/ |
Control entity create access. |
| hook_entity_delete |
core/ |
Respond to entity deletion. |
| hook_entity_display_build_alter |
core/ |
Alter the render array generated by an EntityDisplay for an entity. |
| hook_entity_extra_field_info |
core/ |
Exposes "pseudo-field" components on content entities. |
| hook_entity_extra_field_info_alter |
core/ |
Alter "pseudo-field" components on content entities. |
| hook_entity_field_access |
core/ |
Control access to fields. |
| hook_entity_field_access_alter |
core/ |
Alter the default access behavior for a given field. |
| hook_entity_field_storage_info |
core/ |
Provides field storage definitions for a content entity type. |
| hook_entity_field_storage_info_alter |
core/ |
Alter field storage definitions for a content entity type. |
| hook_entity_field_values_init |
core/ |
Acts when initializing a fieldable entity object. |
| hook_entity_form_display_alter |
core/ |
Alter the settings used for displaying an entity form. |
| hook_entity_form_mode_alter |
core/ |
Change the form mode used to build an entity form. |
| hook_entity_insert |
core/ |
Respond to creation of a new entity. |
| hook_entity_load |
core/ |
Act on entities when loaded. |
| hook_entity_operation |
core/ |
Declares entity operations. |
| hook_entity_operation_alter |
core/ |
Alter entity operations. |
| hook_entity_predelete |
core/ |
Act before entity deletion. |
| hook_entity_preload |
core/ |
Act on an array of entity IDs before they are loaded. |
| hook_entity_prepare_form |
core/ |
Acts on an entity object about to be shown on an entity form. |
| hook_entity_prepare_view |
core/ |
Act on entities as they are being prepared for view. |
| hook_entity_presave |
core/ |
Act on an entity before it is created or updated. |
| hook_entity_revision_create |
core/ |
Respond to entity revision creation. |
| hook_entity_revision_delete |
core/ |
Respond to entity revision deletion. |
| hook_entity_storage_load |
core/ |
Act on content entities when loaded from the storage. |
| hook_entity_translation_create |
core/ |
Acts when creating a new entity translation. |
| hook_entity_translation_delete |
core/ |
Respond to entity translation deletion. |
| hook_entity_translation_insert |
core/ |
Respond to creation of a new entity translation. |
| hook_ENTITY_TYPE_access |
core/ |
Control entity operation access for a specific entity type. |
| hook_entity_type_alter |
core/ |
Alter the entity type definitions. |
| hook_entity_type_build |
core/ |
Add to entity type definitions. |
| hook_ENTITY_TYPE_build_defaults_alter |
core/ |
Alter entity renderable values before cache checking in drupal_render(). |
| hook_ENTITY_TYPE_create |
core/ |
Acts when creating a new entity of a specific type. |
| hook_ENTITY_TYPE_create_access |
core/ |
Control entity create access for a specific entity type. |
| hook_ENTITY_TYPE_delete |
core/ |
Respond to entity deletion of a particular type. |
| hook_ENTITY_TYPE_field_values_init |
core/ |
Acts when initializing a fieldable entity object. |
| hook_ENTITY_TYPE_insert |
core/ |
Respond to creation of a new entity of a particular type. |
| hook_ENTITY_TYPE_load |
core/ |
Act on entities of a specific type when loaded. |
| hook_ENTITY_TYPE_predelete |
core/ |
Act before entity deletion of a particular entity type. |
| hook_ENTITY_TYPE_prepare_form |
core/ |
Acts on a particular type of entity object about to be in an entity form. |
| hook_ENTITY_TYPE_presave |
core/ |
Act on a specific type of entity before it is created or updated. |
| hook_ENTITY_TYPE_revision_create |
core/ |
Respond to entity revision creation. |
| hook_ENTITY_TYPE_revision_delete |
core/ |
Respond to entity revision deletion of a particular type. |
| hook_ENTITY_TYPE_storage_load |
core/ |
Act on content entities of a given type when loaded from the storage. |
| hook_ENTITY_TYPE_translation_create |
core/ |
Acts when creating a new entity translation of a specific type. |
| hook_ENTITY_TYPE_translation_delete |
core/ |
Respond to entity translation deletion of a particular type. |
| hook_ENTITY_TYPE_translation_insert |
core/ |
Respond to creation of a new entity translation of a particular type. |
| hook_ENTITY_TYPE_update |
core/ |
Respond to updates to an entity of a particular type. |
| hook_ENTITY_TYPE_view |
core/ |
Act on entities of a particular type being assembled before rendering. |
| hook_ENTITY_TYPE_view_alter |
core/ |
Alter the results of the entity build array for a particular entity type. |
| hook_entity_update |
core/ |
Respond to updates to an entity. |
| hook_entity_view |
core/ |
Act on entities being assembled before rendering. |
| hook_entity_view_alter |
core/ |
Alter the results of the entity build array. |
| hook_entity_view_display_alter |
core/ |
Alter the settings used for displaying an entity. |
| hook_entity_view_mode_alter |
core/ |
Change the view mode of an entity that is being displayed. |
| hook_entity_view_mode_info_alter |
core/ |
Alter the view modes for entity types. |
| hook_extension |
core/ |
Declare a template file extension to be used with a theme engine. |
| hook_field_formatter_info_alter |
core/ |
Perform alterations on Field API formatter types. |
| hook_field_info_alter |
core/ |
Perform alterations on Field API field types. |
| hook_field_info_max_weight |
core/ |
Returns the maximum weight for the entity components handled by the module. |
| hook_field_purge_field |
core/ |
Acts when a field is being purged. |
| hook_field_purge_field_storage |
core/ |
Acts when a field storage definition is being purged. |
| hook_field_storage_config_update_forbid |
core/ |
Forbid a field storage update from occurring. |
| hook_field_ui_preconfigured_options_alter |
core/ |
Perform alterations on preconfigured field options. |
| hook_field_views_data |
core/ |
Override the default Views data for a Field API field. |
| hook_field_views_data_alter |
core/ |
Alter the Views data for a single Field API field. |
| hook_field_views_data_views_data_alter |
core/ |
Alter the Views data on a per field basis. |
| hook_field_widget_complete_form_alter |
core/ |
Alter the complete form for field widgets provided by other modules. |
| hook_field_widget_complete_WIDGET_TYPE_form_alter |
core/ |
Alter the complete form for a specific widget provided by other modules. |
| hook_field_widget_form_alter Deprecated |
core/ |
Alter forms for field widgets provided by other modules. |
| hook_field_widget_info_alter |
core/ |
Perform alterations on Field API widget types. |
| hook_field_widget_multivalue_form_alter Deprecated |
core/ |
Alter forms for multi-value field widgets provided by other modules. |
| hook_field_widget_multivalue_WIDGET_TYPE_form_alter Deprecated |
core/ |
Alter multi-value widget forms for a widget provided by another module. |
| hook_field_widget_single_element_form_alter |
core/ |
Alter forms for field widgets provided by other modules. |
| hook_field_widget_single_element_WIDGET_TYPE_form_alter |
core/ |
Alter widget forms for a specific widget provided by another module. |
| hook_field_widget_WIDGET_TYPE_form_alter Deprecated |
core/ |
Alter widget forms for a specific widget provided by another module. |
| hook_filetransfer_info |
core/ |
Register information about FileTransfer classes provided by a module. |
| hook_filetransfer_info_alter |
core/ |
Alter the FileTransfer class registry. |
| hook_file_copy |
core/ |
Respond to a file that has been copied. |
| hook_file_download |
core/ |
Control access to private file downloads and specify HTTP headers. |
| hook_file_mimetype_mapping_alter |
core/ |
Alter MIME type mappings used to determine MIME type from a file extension. |
| hook_file_move |
core/ |
Respond to a file that has been moved. |
| hook_file_url_alter |
core/ |
Alter the URL to a file. |
| hook_file_validate |
core/ |
Check that files meet a given criteria. |
| hook_filter_format_disable |
core/ |
Perform actions when a text format has been disabled. |
| hook_filter_info_alter |
core/ |
Perform alterations on filter definitions. |
| hook_filter_secure_image_alter |
core/ |
Alters images with an invalid source. |
| hook_form_alter |
core/ |
Perform alterations before a form is rendered. |
| hook_form_BASE_FORM_ID_alter |
core/ |
Provide a form-specific alteration for shared ('base') forms. |
| hook_form_FORM_ID_alter |
core/ |
Provide a form-specific alteration instead of the global hook_form_alter(). |
| hook_form_system_theme_settings_alter |
core/ |
Allow themes to alter the theme-specific settings form. |
| hook_hal_relation_uri_alter |
core/ |
Alter the HAL relation URI. |
| hook_hal_type_uri_alter |
core/ |
Alter the HAL type URI. |
| hook_help |
core/ |
Provide online user help. |
| hook_help_section_info_alter |
core/ |
Perform alterations on help page section plugin definitions. |
| hook_help_topics_info_alter |
core/ |
Perform alterations on help topic definitions. |
| hook_hook_info |
core/ |
Defines one or more hooks that are exposed by a module. |
| hook_image_effect_info_alter |
core/ |
Alter the information provided in \Drupal\image\Annotation\ImageEffect. |
| hook_image_style_flush |
core/ |
Respond to image style flushing. |
| hook_install |
core/ |
Perform setup tasks when the module is installed. |
| hook_install_tasks |
core/ |
Return an array of tasks to be performed by an installation profile. |
| hook_install_tasks_alter |
core/ |
Alter the full list of installation tasks. |
| hook_jsonapi_entity_field_filter_access |
core/ |
Restricts filtering access to the given field. |
| hook_jsonapi_entity_filter_access |
core/ |
Controls access when filtering by entity data via JSON:API. |
| hook_jsonapi_ENTITY_TYPE_filter_access |
core/ |
Controls access to filtering by entity data via JSON:API. |
| hook_js_alter |
core/ |
Perform necessary alterations to the JavaScript before it is presented on the page. |
| hook_js_settings_alter |
core/ |
Perform necessary alterations to the JavaScript settings (drupalSettings). |
| hook_js_settings_build |
core/ |
Modify the JavaScript settings (drupalSettings). |
| hook_language_fallback_candidates_alter |
core/ |
Allow modules to alter the language fallback candidates. |
| hook_language_fallback_candidates_OPERATION_alter |
core/ |
Allow modules to alter the fallback candidates for specific operations. |
| hook_language_negotiation_info_alter |
core/ |
Perform alterations on language negotiation methods. |
| hook_language_switch_links_alter |
core/ |
Perform alterations on language switcher links. |
| hook_language_types_info |
core/ |
Define language types. |
| hook_language_types_info_alter |
core/ |
Perform alterations on language types. |
| hook_layout_alter |
core/ |
Allow modules to alter layout plugin definitions. |
| hook_library_info_alter |
core/ |
Alter libraries provided by an extension. |
| hook_library_info_build |
core/ |
Add dynamic library definitions. |
| hook_link_alter |
core/ |
Alter the parameters for links. |
| hook_locale_translation_projects_alter |
core/ |
Alter the list of projects to be updated by locale's interface translation. |
| hook_local_tasks_alter |
core/ |
Alter local tasks plugins. |
| hook_mail |
core/ |
Prepares a message based on parameters. |
| hook_mail_alter |
core/ |
Alter an email message created with MailManagerInterface->mail(). |
| hook_mail_backend_info_alter |
core/ |
Alter the list of mail backend plugin definitions. |
| hook_media_source_info_alter |
core/ |
Alters the information provided in \Drupal\media\Annotation\MediaSource. |
| hook_menu_links_discovered_alter |
core/ |
Alters all the menu links discovered by the menu link plugin manager. |
| hook_menu_local_actions_alter |
core/ |
Alter local actions plugins. |
| hook_menu_local_tasks_alter |
core/ |
Alter local tasks displayed on the page before they are rendered. |
| hook_migrate_MIGRATION_ID_prepare_row |
core/ |
Allows adding data to a row for a migration with the specified ID. |
| hook_migrate_prepare_row |
core/ |
Allows adding data to a row before processing it. |
| hook_migration_plugins_alter |
core/ |
Allows altering the list of discovered migration plugins. |
| hook_modules_installed |
core/ |
Perform necessary actions after modules are installed. |
| hook_modules_uninstalled |
core/ |
Perform necessary actions after modules are uninstalled. |
| hook_module_implements_alter |
core/ |
Alter the registry of modules implementing a hook. |
| hook_module_preinstall |
core/ |
Perform necessary actions before a module is installed. |
| hook_module_preuninstall |
core/ |
Perform necessary actions before a module is uninstalled. |
| hook_node_access_records |
core/ |
Set permissions for a node to be written to the database. |
| hook_node_access_records_alter |
core/ |
Alter permissions for a node before it is written to the database. |
| hook_node_grants |
core/ |
Inform the node access system what permissions the user has. |
| hook_node_grants_alter |
core/ |
Alter user access rules when trying to view, edit or delete a node. |
| hook_node_links_alter |
core/ |
Alter the links of a node. |
| hook_node_search_result |
core/ |
Act on a node being displayed as a search result. |
| hook_node_update_index |
core/ |
Act on a node being indexed for searching. |
| hook_oembed_resource_url_alter |
core/ |
Alters an oEmbed resource URL before it is fetched. |
| hook_options_list_alter |
core/ |
Alters the list of options to be displayed for a field. |
| hook_page_attachments |
core/ |
Add attachments (typically assets) to a page before it is rendered. |
| hook_page_attachments_alter |
core/ |
Alter attachments (typically assets) to a page before it is rendered. |
| hook_page_bottom |
core/ |
Add a renderable array to the bottom of the page. |
| hook_page_top |
core/ |
Add a renderable array to the top of the page. |
| hook_plugin_filter_TYPE_alter |
core/ |
Alter the filtering of plugin definitions for a specific plugin type. |
| hook_plugin_filter_TYPE__CONSUMER_alter |
core/ |
Alter the filtering of plugin definitions for a specific type and consumer. |
| hook_post_update_NAME |
core/ |
Executes an update which is intended to update data, like entities. |
| hook_preprocess |
core/ |
Preprocess theme variables for templates. |
| hook_preprocess_HOOK |
core/ |
Preprocess theme variables for a specific theme hook. |
| hook_query_alter |
core/ |
Perform alterations to a structured query. |
| hook_query_TAG_alter |
core/ |
Perform alterations to a structured query for a given tag. |
| hook_queue_info_alter |
core/ |
Alter cron queue information before cron runs. |
| hook_quickedit_editor_alter |
core/ |
Allow modules to alter in-place editor plugin metadata. |
| hook_quickedit_render_field |
core/ |
Returns a renderable array for the value of a single field in an entity. |
| hook_ranking |
core/ |
Provide additional methods of scoring for core search results for nodes. |
| hook_rdf_namespaces |
core/ |
Allow modules to define namespaces for RDF mappings. |
| hook_rebuild |
core/ |
Rebuild data based upon refreshed caches. |
| hook_removed_post_updates |
core/ |
Return an array of removed hook_post_update_NAME() function names. |
| hook_render_template |
core/ |
Render a template using the theme engine. |
| hook_requirements |
core/ |
Check installation requirements and do status reporting. |
| hook_rest_resource_alter |
core/ |
Alter the resource plugin definitions. |
| hook_schema |
core/ |
Define the current version of the database schema. |
| hook_search_plugin_alter |
core/ |
Alter search plugin definitions. |
| hook_search_preprocess |
core/ |
Preprocess text for search. |
| hook_shortcut_default_set |
core/ |
Return the name of a default shortcut set for the provided user account. |
| hook_system_breadcrumb_alter |
core/ |
Perform alterations to the breadcrumb built by the BreadcrumbManager. |
| hook_system_info_alter |
core/ |
Alter the information parsed from module and theme .info.yml files. |
| hook_system_themes_page_alter |
core/ |
Alters theme operation links. |
| hook_template_preprocess_default_variables_alter |
core/ |
Alter the default, hook-independent variables for all templates. |
| hook_theme |
core/ |
Register a module or theme's theme implementations. |
| hook_themes_installed |
core/ |
Respond to themes being installed. |
| hook_themes_uninstalled |
core/ |
Respond to themes being uninstalled. |
| hook_theme_registry_alter |
core/ |
Alter the theme registry information returned from hook_theme(). |
| hook_theme_suggestions_alter |
core/ |
Alters named suggestions for all theme hooks. |
| hook_theme_suggestions_HOOK |
core/ |
Provides alternate named suggestions for a specific theme hook. |
| hook_theme_suggestions_HOOK_alter |
core/ |
Alters named suggestions for a specific theme hook. |
| hook_tokens |
core/ |
Provide replacement values for placeholder tokens. |
| hook_tokens_alter |
core/ |
Alter replacement values for placeholder tokens. |
| hook_token_info |
core/ |
Provide information about available placeholder tokens and token types. |
| hook_token_info_alter |
core/ |
Alter the metadata about available placeholder tokens and token types. |
| hook_toolbar |
core/ |
Add items to the toolbar menu. |
| hook_toolbar_alter |
core/ |
Alter the toolbar menu after hook_toolbar() is invoked. |
| hook_tour_tips_alter |
core/ |
Allow modules to alter tour items before render. |
| hook_tour_tips_info_alter |
core/ |
Allow modules to alter tip plugin definitions. |
| hook_transliteration_overrides_alter |
core/ |
Provide language-specific overrides for transliteration. |
| hook_uninstall |
core/ |
Remove any information that the module sets. |
| hook_updater_info |
core/ |
Provide information on Updaters (classes that can update Drupal). |
| hook_updater_info_alter |
core/ |
Alter the Updater information array. |
| hook_update_dependencies |
core/ |
Return an array of information about module update dependencies. |
| hook_update_last_removed |
core/ |
Return a number which is no longer available as hook_update_N(). |
| hook_update_N |
core/ |
Perform a single update between minor versions. |
| hook_update_projects_alter |
core/ |
Alter the list of projects before fetching data and comparing versions. |
| hook_update_status_alter |
core/ |
Alter the information about available updates for projects. |
| hook_user_cancel |
core/ |
Act on user account cancellations. |
| hook_user_cancel_methods_alter |
core/ |
Modify account cancellation methods. |
| hook_user_format_name_alter |
core/ |
Alter the username that is displayed for a user. |
| hook_user_login |
core/ |
The user just logged in. |
| hook_user_logout |
core/ |
The user just logged out. |
| hook_validation_constraint_alter |
core/ |
Alter validation constraint plugin definitions. |
| hook_verify_update_archive |
core/ |
Verify an archive after it has been downloaded and extracted. |
| hook_views_analyze |
core/ |
Analyze a view to provide warnings about its configuration. |
| hook_views_data |
core/ |
Describe data tables and fields (or the equivalent) to Views. |
| hook_views_data_alter |
core/ |
Alter the table and field information from hook_views_data(). |
| hook_views_form_substitutions |
core/ |
Replace special strings when processing a view with form elements. |
| hook_views_invalidate_cache |
core/ |
Allow modules to respond to the invalidation of the Views cache. |
| hook_views_plugins_access_alter |
core/ |
Modify the list of available views access plugins. |
| hook_views_plugins_area_alter |
core/ |
Modify the list of available views area handler plugins. |
| hook_views_plugins_argument_alter |
core/ |
Modify the list of available views argument handler plugins. |
| hook_views_plugins_argument_default_alter |
core/ |
Modify the list of available views default argument plugins. |
| hook_views_plugins_argument_validator_alter |
core/ |
Modify the list of available views argument validation plugins. |
| hook_views_plugins_cache_alter |
core/ |
Modify the list of available views cache plugins. |
| hook_views_plugins_display_alter |
core/ |
Modify the list of available views display plugins. |
| hook_views_plugins_display_extenders_alter |
core/ |
Modify the list of available views display extender plugins. |
| hook_views_plugins_exposed_form_alter |
core/ |
Modify the list of available views exposed form plugins. |
| hook_views_plugins_field_alter |
core/ |
Modify the list of available views field handler plugins. |
| hook_views_plugins_filter_alter |
core/ |
Modify the list of available views filter handler plugins. |
| hook_views_plugins_join_alter |
core/ |
Modify the list of available views join plugins. |
| hook_views_plugins_pager_alter |
core/ |
Modify the list of available views pager plugins. |
| hook_views_plugins_query_alter |
core/ |
Modify the list of available views query plugins. |
| hook_views_plugins_relationship_alter |
core/ |
Modify the list of available views relationship handler plugins. |
| hook_views_plugins_row_alter |
core/ |
Modify the list of available views row plugins. |
| hook_views_plugins_sort_alter |
core/ |
Modify the list of available views sort handler plugins. |
| hook_views_plugins_style_alter |
core/ |
Modify the list of available views style plugins. |
| hook_views_plugins_wizard_alter |
core/ |
Modify the list of available views wizard plugins. |
| hook_views_post_build |
core/ |
Act on the view immediately after the query is built. |
| hook_views_post_execute |
core/ |
Act on the view immediately after the query has been executed. |
| hook_views_post_render |
core/ |
Post-process any rendered data. |
| hook_views_preview_info_alter |
core/ |
Alter the view preview information. |
| hook_views_pre_build |
core/ |
Act on the view before the query is built, but after displays are attached. |
| hook_views_pre_execute |
core/ |
Act on the view after the query is built and just before it is executed. |
| hook_views_pre_render |
core/ |
Act on the view immediately before rendering it. |
| hook_views_pre_view |
core/ |
Alter a view at the very beginning of Views processing. |
| hook_views_query_alter |
core/ |
Alter the query before it is executed. |
| hook_views_query_substitutions |
core/ |
Replace special strings in the query before it is executed. |
| hook_views_ui_display_tab_alter |
core/ |
Alter the renderable array representing the edit page for one display. |
| hook_views_ui_display_top_alter |
core/ |
Alter the top of the display for the Views UI. |
| hook_views_ui_display_top_links_alter |
core/ |
Alter the links displayed at the top of the view edit form. |
Sub-Topics
|
Name |
Location | Description |
|---|---|---|
| Field Formatter API |
core/ |
Define Field API formatter types. |
| Field Types API |
core/ |
Defines field, widget, display formatter, and storage types. |
| Field Widget API |
core/ |
Define Field API widget types. |