Allow modules to interact with the Backdrop core.
Backdrop's module system is based on the concept of "hooks". A hook is simply a PHP function that is named foo_bar(), where "foo" is the name of the module (whose filename is thus foo.module) and "bar" is the name of the hook. Each hook has a defined set of parameters and a specified result type.
To extend Backdrop, a module needs to implement a hook. When Backdrop wishes to allow intervention from modules, it determines which modules implement a hook and calls that hook in all enabled modules that implement it.
The available hooks to implement are explained here in the Hooks section of the developer documentation. The string "hook" is used as a placeholder for the module name in the hook definitions. For example, if the module file is called example.module, then hook_menu() as implemented by that module would be defined as example_menu().
The example functions included are not part of the Backdrop core, they are just models that you can modify. Only the hooks implemented within modules are executed when running Backdrop.
See also
File
- core/
includes/ module.inc, line 631 - API for loading and interacting with Backdrop modules.
Functions
Name |
Location | Description |
|---|---|---|
| module_invoke_all |
core/ |
Invokes a hook in all enabled modules that implement it. |
| module_invoke |
core/ |
Invokes a hook in a particular module. |
| module_implements_write_cache |
core/ |
Writes the hook implementation cache. |
| module_implements_reset |
core/ |
Regenerate the stored list of hook implementations. |
| module_implements |
core/ |
Determines which modules are implementing a hook. |
| module_hook_info |
core/ |
Retrieves a list of hooks that are declared through hook_hook_info(). |
| module_hook |
core/ |
Determines whether a module implements a hook. |
| hook_watchdog |
core/ |
Log an event message. |
| hook_view |
core/ |
Display a node. |
| hook_verify_update_archive |
core/ |
Verify an archive after it has been downloaded and extracted. |
| hook_validate |
core/ |
Perform node validation before a node is created or updated. |
| hook_user_view_alter |
core/ |
The user was built; the module may modify the structured content. |
| hook_user_view |
core/ |
The user's account information is being displayed. |
| hook_user_update |
core/ |
Respond to updates to a user account. |
| hook_user_role_update |
core/ |
Respond to updates to a user role. |
| hook_user_role_presave |
core/ |
Act on a user role being inserted or updated. |
| hook_user_role_insert |
core/ |
Respond to creation of a new user role. |
| hook_user_role_delete |
core/ |
Respond to user role deletion. |
| hook_user_presave |
core/ |
Act on a user account being inserted or updated. |
| hook_user_predelete |
core/ |
Act before user deletion. |
| hook_user_password_reject_weak_alter |
core/ |
Alter the requirement for rejecting weak passwords. |
| hook_user_logout |
core/ |
The user just logged out. |
| hook_user_login_paths_alter |
core/ |
Redefine user login paths defined by other modules. |
| hook_user_login_paths |
core/ |
Define paths related to the user login process. |
| hook_user_login |
core/ |
The user just logged in. |
| hook_user_load |
core/ |
Act on user objects when loaded from the database. |
| hook_user_insert |
core/ |
Respond to creation of a new user account. |
| hook_user_format_name_alter |
core/ |
Alter the username that is displayed for a user. |
| hook_user_flood_control |
core/ |
Respond to user flood control events. |
| hook_user_delete |
core/ |
Respond to user deletion. |
| hook_user_cancel_methods_alter |
core/ |
Modify account cancellation methods. |
| hook_user_cancel |
core/ |
Act on user account cancellations. |
| hook_url_outbound_alter |
core/ |
Alters outbound URLs. |
| hook_url_inbound_alter |
core/ |
Alters inbound URL requests. |
| hook_update_status_alter |
core/ |
Alter the information about available updates for projects. |
| hook_update_projects_alter |
core/ |
Alter the list of projects before fetching data and comparing versions. |
| hook_update_N |
core/ |
Perform a single update. |
| hook_update_last_removed |
core/ |
Return a number which is no longer available as hook_update_N(). |
| hook_update_index |
core/ |
Update the search index for this module. |
| hook_update_dependencies |
core/ |
Return an array of information about module update dependencies. |
| hook_updater_info_alter |
core/ |
Alter the Updater information array. |
| hook_updater_info |
core/ |
Provide information on Updaters (classes that can update Backdrop). |
| hook_update |
core/ |
Respond to updates to a node. |
| hook_uninstall |
core/ |
Remove any information that the module sets. |
| hook_translated_menu_link_alter |
core/ |
Alter a menu link after it has been translated and before it is rendered. |
| hook_token_info_alter |
core/ |
Alter the metadata about available placeholder tokens and token types. |
| hook_token_info |
core/ |
Provide information about available placeholder tokens and token types. |
| hook_tokens_alter |
core/ |
Alter replacement values for placeholder tokens. |
| hook_tokens |
core/ |
Provide replacement values for placeholder tokens. |
| hook_timezone_countries_alter |
core/ |
Alter the default timezone country list. |
| hook_theme_registry_alter |
core/ |
Alter the theme registry information returned from hook_theme(). |
| hook_theme |
core/ |
Register a module (or theme's) theme implementations. |
| hook_test_group_started |
core/ |
A test group has started. |
| hook_test_group_finished |
core/ |
A test group has finished. |
| hook_test_finished |
core/ |
An individual test has finished. |
| hook_telemetry_info_alter |
core/ |
Alter the list of data collected by Telemetry. |
| hook_telemetry_info |
core/ |
Provides information about data collected by this module. |
| hook_telemetry_data_alter |
core/ |
Alter the complete list of values collected by Telemetry before sending. |
| hook_telemetry_data |
core/ |
Populates the telemetry data from this module. |
| hook_taxonomy_vocabulary_update |
core/ |
Act on taxonomy vocabularies when updated. |
| hook_taxonomy_vocabulary_presave |
core/ |
Act on taxonomy vocabularies before they are saved. |
| hook_taxonomy_vocabulary_predelete |
core/ |
Act before taxonomy vocabulary deletion. |
| hook_taxonomy_vocabulary_load |
core/ |
Act on taxonomy vocabularies when loaded. |
| hook_taxonomy_vocabulary_insert |
core/ |
Act on taxonomy vocabularies when inserted. |
| hook_taxonomy_vocabulary_delete |
core/ |
Respond to taxonomy vocabulary deletion. |
| hook_taxonomy_term_view_alter |
core/ |
Alter the results of taxonomy_term_view(). |
| hook_taxonomy_term_view |
core/ |
Act on a taxonomy term that is being assembled before rendering. |
| hook_taxonomy_term_update |
core/ |
Act on taxonomy terms when updated. |
| hook_taxonomy_term_presave |
core/ |
Act on taxonomy terms before they are saved. |
| hook_taxonomy_term_predelete |
core/ |
Act before taxonomy term deletion. |
| hook_taxonomy_term_page_alter |
core/ |
Alter the results of taxonomy_term_page(). |
| hook_taxonomy_term_load |
core/ |
Act on taxonomy terms when loaded. |
| hook_taxonomy_term_insert |
core/ |
Act on taxonomy terms when inserted. |
| hook_taxonomy_term_delete |
core/ |
Respond to taxonomy term deletion. |
| hook_system_theme_info |
core/ |
Return additional themes provided by modules. |
| hook_system_themes_page_alter |
core/ |
Alters theme operation links. |
| hook_system_info_alter |
core/ |
Alter the information parsed from module and theme .info files |
| hook_stream_wrappers_alter |
core/ |
Alters the list of PHP stream wrapper implementations. |
| hook_stream_wrappers |
core/ |
Registers PHP stream wrapper implementations associated with a module. |
| hook_simpletest_alter |
core/ |
Alter the list of tests. |
| hook_search_status |
core/ |
Report the status of indexing. |
| hook_search_reset |
core/ |
Take action when the search index is going to be rebuilt. |
| hook_search_preprocess |
core/ |
Preprocess text for search. |
| hook_search_page |
core/ |
Override the rendering of search results. |
| hook_search_info |
core/ |
Define a custom search type. |
| hook_search_execute |
core/ |
Execute a search for a set of key words. |
| hook_search_admin |
core/ |
Add elements to the search settings form. |
| hook_search_access |
core/ |
Define access to a custom search routine. |
| hook_schema_alter |
core/ |
Perform alterations to existing database schemas. |
| hook_schema_0 |
core/ |
Define the database schema to use when a module is installed during updates. |
| hook_schema |
core/ |
Define the current version of the database schema. |
| hook_requirements |
core/ |
Check installation requirements and do status reporting. |
| hook_redirect_validate |
core/ |
Perform redirect validation before a redirect is created or updated. |
| hook_redirect_update |
core/ |
Respond to updates to a redirect. |
| hook_redirect_presave |
core/ |
Act on a redirect being inserted or updated. |
| hook_redirect_prepare |
core/ |
Act on a redirect object about to be shown on the add/edit form. |
| hook_redirect_operations |
core/ |
Provide additional operations that may be done on redirects. |
| hook_redirect_load_by_source_alter |
core/ |
Alter the list of redirects matching a certain source. |
| hook_redirect_load |
core/ |
Act on redirects being loaded from the database. |
| hook_redirect_insert |
core/ |
Respond to creation of a new redirect. |
| hook_redirect_delete |
core/ |
Respond to redirect deletion. |
| hook_redirect_alter |
core/ |
Act on a redirect being redirected. |
| hook_redirect_access |
core/ |
Control access to a redirect. |
| hook_ranking |
core/ |
Provide additional methods of scoring for core search results for nodes. |
| hook_query_TAG_alter |
core/ |
Perform alterations to a structured query for a given tag. |
| hook_query_alter |
core/ |
Perform alterations to a structured query. |
| hook_prepare |
core/ |
Act on a node object about to be shown on the add/edit form. |
| hook_permission |
core/ |
Define user permissions. |
| hook_path_update |
core/ |
Respond to a path being updated. |
| hook_path_insert |
core/ |
Respond to a path being inserted. |
| hook_path_delete |
core/ |
Respond to a path being deleted. |
| hook_page_delivery_callback_alter |
core/ |
Alters the delivery callback used to send the result of the page callback to the browser. |
| hook_node_view_alter |
core/ |
Alter the results of node_view(). |
| hook_node_view |
core/ |
Act on a node that is being assembled before rendering. |
| hook_node_validate |
core/ |
Perform node validation before a node is created or updated. |
| hook_node_update_index |
core/ |
Act on a node being indexed for searching. |
| hook_node_update |
core/ |
Respond to updates to a node. |
| hook_node_type_update |
core/ |
Respond to node type updates. |
| hook_node_type_load |
core/ |
Respond to the loading of node types. |
| hook_node_type_insert |
core/ |
Respond to node type creation. |
| hook_node_type_delete |
core/ |
Respond to node type deletion. |
| hook_node_submit |
core/ |
Act on a node after validated form values have been copied to it. |
| hook_node_search_result |
core/ |
Act on a node being displayed as a search result. |
| hook_node_revision_delete |
core/ |
Respond to deletion of a node revision. |
| hook_node_presave |
core/ |
Act on a node being inserted or updated. |
| hook_node_prepare |
core/ |
Act on a node object about to be shown on the add/edit form. |
| hook_node_predelete |
core/ |
Act before node deletion. |
| hook_node_load |
core/ |
Act on arbitrary nodes being loaded from the database. |
| hook_node_insert |
core/ |
Respond to creation of a new node. |
| hook_node_grants_alter |
core/ |
Alter user access rules when trying to view, edit or delete a node. |
| hook_node_grants |
core/ |
Inform the node access system what permissions the user has. |
| hook_node_delete |
core/ |
Respond to node deletion. |
| hook_node_access_records_alter |
core/ |
Alter permissions for a node before it is written to the database. |
| hook_node_access_records |
core/ |
Set permissions for a node to be written to the database. |
| hook_node_access |
core/ |
Controls access to a node. |
| hook_module_implements_alter |
core/ |
Alter the registry of modules implementing a hook. |
| hook_modules_uninstalled |
core/ |
Perform necessary actions after modules are uninstalled. |
| hook_modules_preinstall |
core/ |
Perform necessary actions before modules are installed. |
| hook_modules_preenable |
core/ |
Perform necessary actions before modules are enabled. |
| hook_modules_installed |
core/ |
Perform necessary actions after modules are installed. |
| hook_modules_enabled |
core/ |
Perform necessary actions after modules are enabled. |
| hook_modules_disabled |
core/ |
Perform necessary actions after modules are disabled. |
| hook_menu_update |
core/ |
Respond to a custom menu update. |
| hook_menu_site_status_alter |
core/ |
Control site status before menu dispatching. |
| hook_menu_local_tasks_alter |
core/ |
Alter tabs and actions displayed on the page before they are rendered. |
| hook_menu_link_update |
core/ |
Inform modules that a menu link has been updated. |
| hook_menu_link_insert |
core/ |
Inform modules that a menu link has been created. |
| hook_menu_link_delete |
core/ |
Inform modules that a menu link has been deleted. |
| hook_menu_link_alter |
core/ |
Alter the data being saved to the {menu_links} table by menu_link_save(). |
| hook_menu_insert |
core/ |
Respond to a custom menu creation. |
| hook_menu_get_item_alter |
core/ |
Alter a menu router item right after it has been retrieved from the database or cache. |
| hook_menu_delete |
core/ |
Respond to a custom menu deletion. |
| hook_menu_contextual_links_alter |
core/ |
Alter contextual links before they are rendered. |
| hook_menu_breadcrumb_alter |
core/ |
Alter links in the active trail before it is rendered as the breadcrumb. |
| hook_menu_alter |
core/ |
Alter the data being saved to the {menu_router} table after hook_menu is invoked. |
| hook_menu |
core/ |
Define menu items and page callbacks. |
| hook_mail_alter |
core/ |
Alter an email message created with the backdrop_mail() function. |
| hook_mail |
core/ |
Prepare a message based on parameters; called from backdrop_mail(). |
| hook_locale_language_update |
core/ |
React to a language that was just updated in the system. |
| hook_locale_language_presave |
core/ |
React to a language about to be added or updated in the system. |
| hook_locale_language_insert |
core/ |
React to a language that was just added to the system. |
| hook_locale_language_delete |
core/ |
Allow modules to react before the deletion of a language. |
| hook_load |
core/ |
Act on nodes being loaded from the database. |
| hook_library_info_alter |
core/ |
Alters the JavaScript/CSS library registry. |
| hook_library_info |
core/ |
Registers JavaScript/CSS libraries associated with a module. |
| hook_layout_update |
core/ |
Respond to updates to a layout. |
| hook_layout_template_info |
core/ |
Provides a list of layout templates that can be used within the Layout module. |
| hook_layout_style_info |
core/ |
Provides information on rendering styles that can be used by layouts. |
| hook_layout_revert |
core/ |
Respond to a layout being reverted. |
| hook_layout_renderer_info |
core/ |
Returns information about Layout renderers. |
| hook_layout_presave |
core/ |
Act on a layout being inserted or updated. |
| hook_layout_load_by_router_item_alter |
core/ |
Perform alterations to the list of layouts that match the path of a router item. |
| hook_layout_insert |
core/ |
Respond to initial creation of a layout. |
| hook_layout_info Deprecated |
core/ |
Deprecated. Now replaced by hook_layout_template_info(). |
| hook_layout_enable |
core/ |
Respond to a layout being enabled. |
| hook_layout_disable |
core/ |
Respond to a layout being disabled. |
| hook_layout_delete |
core/ |
Respond to a layout being deleted. |
| hook_layout_context_info |
core/ |
Provides a list of all "contexts" available to Layout module. |
| hook_language_update |
core/ |
React to a language that was just updated in the system. |
| hook_language_types_info_alter |
core/ |
Perform alterations on language types. |
| hook_language_types_info |
core/ |
Define language types. |
| hook_language_switch_links_alter |
core/ |
Perform alterations on language switcher links. |
| hook_language_presave |
core/ |
React to a language about to be added or updated in the system. |
| hook_language_negotiation_info_alter |
core/ |
Perform alterations on language negotiation providers. |
| hook_language_negotiation_info |
core/ |
Define language negotiation providers. |
| hook_language_insert |
core/ |
React to a language that was just added to the system. |
| hook_language_init |
core/ |
Allows modules to act after language initialization has been performed. |
| hook_language_fallback_candidates_alter |
core/ |
Perform alterations on the language fallback candidates. |
| hook_language_delete |
core/ |
Allow modules to react before the deletion of a language. |
| hook_js_alter |
core/ |
Perform necessary alterations to the JavaScript before it is presented on the page. |
| hook_install_tasks_alter |
core/ |
Alter the full list of installation tasks. |
| hook_install_tasks |
core/ |
Return an array of tasks to be performed by an installation profile. |
| hook_install |
core/ |
Perform setup tasks when the module is installed. |
| hook_insert |
core/ |
Respond to creation of a new node. |
| hook_init |
core/ |
Perform setup tasks for non-cached page requests. |
| hook_image_toolkits |
core/ |
Define image toolkits provided by this module. |
| hook_image_supported_extensions_alter |
core/ |
Modify the array of supported image extensions. |
| hook_image_style_save |
core/ |
Respond to image style updating. |
| hook_image_style_flush |
core/ |
Respond to image style flushing. |
| hook_image_style_delete |
core/ |
Respond to image style deletion. |
| hook_image_styles_alter |
core/ |
Modify any image styles provided by other modules or the user. |
| hook_image_effect_info_alter |
core/ |
Alter the information provided in hook_image_effect_info(). |
| hook_image_effect_info |
core/ |
Define information about image effects provided by a module. |
| hook_icon_info_alter |
core/ |
Modify the list of icons provided by other modules. |
| hook_icon_info |
core/ |
Provides reusable icons from a module. |
| hook_html_head_alter |
core/ |
Alter XHTML HEAD tags before they are rendered by backdrop_get_html_head(). |
| hook_hook_info_alter |
core/ |
Alter information from hook_hook_info(). |
| hook_hook_info |
core/ |
Defines one or more hooks that are exposed by a module. |
| hook_form_FORM_ID_alter |
core/ |
Provide a form-specific alteration instead of the global hook_form_alter(). |
| hook_form_BASE_FORM_ID_alter |
core/ |
Provide a form-specific alteration for shared ('base') forms. |
| hook_form_alter |
core/ |
Perform alterations before a form is rendered. |
| hook_forms |
core/ |
Map form_ids to form builder functions. |
| hook_form |
core/ |
Display a node editing form. |
| hook_flush_caches |
core/ |
Add a list of cache tables to be cleared. |
| hook_filter_js_settings_alter |
core/ |
Perform alterations on the JavaScript settings that are added for filters. |
| hook_filter_info_alter |
core/ |
Perform alterations on filter definitions. |
| hook_filter_info |
core/ |
Define content filters. |
| hook_filter_format_update |
core/ |
Perform actions when a text format has been updated. |
| hook_filter_format_insert |
core/ |
Perform actions when a new text format has been created. |
| hook_filter_format_disable |
core/ |
Perform actions when a text format has been disabled. |
| hook_file_validate |
core/ |
Check that files meet a given criteria. |
| hook_file_url_alter |
core/ |
Alter the URL to a file. |
| hook_file_update |
core/ |
Respond to a file being updated. |
| hook_file_presave |
core/ |
Act on a file being inserted or updated. |
| hook_file_predelete |
core/ |
Act prior to file deletion. |
| hook_file_move |
core/ |
Respond to a file that has been moved. |
| hook_file_mimetype_mapping_alter |
core/ |
Alter MIME type mappings used to determine MIME type from a file extension. |
| hook_file_load |
core/ |
Load additional information into file entities. |
| hook_file_insert |
core/ |
Respond to a file being added. |
| hook_file_download |
core/ |
Control access to private file downloads and specify HTTP headers. |
| hook_file_delete |
core/ |
Respond to file deletion. |
| hook_file_copy |
core/ |
Respond to a file that has been copied. |
| hook_filetransfer_info_alter |
core/ |
Alter the FileTransfer class registry. |
| hook_filetransfer_info |
core/ |
Register information about FileTransfer classes provided by a module. |
| hook_field_widget_WIDGET_TYPE_form_alter |
core/ |
Alter widget forms for a specific widget provided by another module. |
| hook_field_widget_settings_form |
core/ |
Add settings to a widget settings form. |
| hook_field_widget_properties_ENTITY_TYPE_alter |
core/ |
Alters the widget properties of a field instance on a given entity type before it gets displayed. |
| hook_field_widget_properties_alter |
core/ |
Alters the widget properties of a field instance before it gets displayed. |
| hook_field_widget_info_alter |
core/ |
Perform alterations on Field API widget types. |
| hook_field_widget_info |
core/ |
Expose Field API widget types. |
| hook_field_widget_form_alter |
core/ |
Alter forms for field widgets provided by other modules. |
| hook_field_widget_form |
core/ |
Return the form for a single field widget. |
| hook_field_widget_error |
core/ |
Flag a field-level validation error. |
| hook_field_validate |
core/ |
Validate this module's field data. |
| hook_field_update_instance |
core/ |
Act on a field instance being updated. |
| hook_field_update_forbid |
core/ |
Forbid a field update from occurring. |
| hook_field_update_field |
core/ |
Act on a field being updated. |
| hook_field_update |
core/ |
Define custom update behavior for this module's field data. |
| hook_field_storage_write |
core/ |
Write field data for an entity. |
| hook_field_storage_update_field |
core/ |
Update the storage information for a field. |
| hook_field_storage_query |
core/ |
Execute an EntityFieldQuery. |
| hook_field_storage_purge_field_instance |
core/ |
Remove field storage information when a field instance is purged. |
| hook_field_storage_purge_field |
core/ |
Remove field storage information when a field record is purged. |
| hook_field_storage_purge |
core/ |
Remove field storage information when field data is purged. |
| hook_field_storage_pre_update |
core/ |
Act before the storage backends update field data. |
| hook_field_storage_pre_load |
core/ |
Act before the storage backends load field data. |
| hook_field_storage_pre_insert |
core/ |
Act before the storage backends insert field data. |
| hook_field_storage_load |
core/ |
Load field data for a set of entities. |
| hook_field_storage_info_alter |
core/ |
Perform alterations on Field API storage types. |
| hook_field_storage_info |
core/ |
Expose Field API storage backends. |
| hook_field_storage_details_alter |
core/ |
Perform alterations on Field API storage details. |
| hook_field_storage_details |
core/ |
Reveal the internal details about the storage for a field. |
| hook_field_storage_delete_revision |
core/ |
Delete a single revision of field data for an entity. |
| hook_field_storage_delete_instance |
core/ |
Act on deletion of a field instance. |
| hook_field_storage_delete_field |
core/ |
Act on deletion of a field. |
| hook_field_storage_delete |
core/ |
Delete all field data for an entity. |
| hook_field_storage_create_field |
core/ |
Act on creation of a new field. |
| hook_field_settings_form |
core/ |
Add settings to a field settings form. |
| hook_field_schema_alter |
core/ |
Allow modules to alter the schema for a field. |
| hook_field_schema |
core/ |
Define the Field API schema for a field structure. |
| hook_field_read_instance |
core/ |
Act on a field record being read from the database. |
| hook_field_read_field |
core/ |
Act on field records being read from the database. |
| hook_field_purge_instance |
core/ |
Acts when a field instance is being purged. |
| hook_field_purge_field |
core/ |
Acts when a field record is being purged. |
| hook_field_presave |
core/ |
Define custom presave behavior for this module's field types. |
| hook_field_prepare_view |
core/ |
Prepare field values prior to display. |
| hook_field_prepare_translation |
core/ |
Define custom prepare_translation behavior for this module's field types. |
| hook_field_load |
core/ |
Define custom load behavior for this module's field types. |
| hook_field_language_alter |
core/ |
Perform alterations on field_language() values. |
| hook_field_is_empty |
core/ |
Define what constitutes an empty item for a field type. |
| hook_field_instance_settings_form |
core/ |
Add settings to an instance field settings form. |
| hook_field_insert |
core/ |
Define custom insert behavior for this module's field data. |
| hook_field_info_max_weight |
core/ |
Returns the maximum weight for the entity components handled by the module. |
| hook_field_info_alter |
core/ |
Perform alterations on Field API field types. |
| hook_field_info |
core/ |
Define Field API field types. |
| hook_field_formatter_view |
core/ |
Build a renderable array for a field value. |
| hook_field_formatter_settings_summary_alter |
core/ |
Alter the short summary for the current formatter settings of an instance. |
| hook_field_formatter_settings_summary |
core/ |
Return a short summary for the current formatter settings of an instance. |
| hook_field_formatter_settings_form_alter |
core/ |
Alter the form elements for a formatter's settings. |
| hook_field_formatter_settings_form |
core/ |
Specify the form elements for a formatter's settings. |
| hook_field_formatter_prepare_view |
core/ |
Allow formatters to load information for field values being displayed. |
| hook_field_formatter_info_alter |
core/ |
Perform alterations on Field API formatter types. |
| hook_field_formatter_info |
core/ |
Expose Field API formatter types. |
| hook_field_extra_fields_display_alter |
core/ |
Alters the display settings of pseudo-fields before an entity is displayed. |
| hook_field_extra_fields_alter |
core/ |
Alter "pseudo-field" components on fieldable entities. |
| hook_field_extra_fields |
core/ |
Exposes "pseudo-field" components on fieldable entities. |
| hook_field_display_ENTITY_TYPE_alter |
core/ |
Alters the display settings of a field on a given entity type before it gets displayed. |
| hook_field_display_alter |
core/ |
Alters the display settings of a field before it gets displayed. |
| hook_field_delete_revision |
core/ |
Define custom revision delete behavior for this module's field types. |
| hook_field_delete_instance |
core/ |
Act on a field instance being deleted. |
| hook_field_delete_field |
core/ |
Act on a field being deleted. |
| hook_field_delete |
core/ |
Define custom delete behavior for this module's field data. |
| hook_field_create_instance |
core/ |
Act on a field instance being created. |
| hook_field_create_field |
core/ |
Act on a field being created. |
| hook_field_available_languages_alter |
core/ |
Alter field_available_languages() values. |
| hook_field_attach_view_alter |
core/ |
Perform alterations on field_attach_view() or field_view_field(). |
| hook_field_attach_validate |
core/ |
Act on field_attach_validate(). |
| hook_field_attach_update |
core/ |
Act on field_attach_update(). |
| hook_field_attach_submit |
core/ |
Act on field_attach_submit(). |
| hook_field_attach_rename_bundle |
core/ |
Act on field_attach_rename_bundle(). |
| hook_field_attach_purge |
core/ |
Act on field_purge_data(). |
| hook_field_attach_presave |
core/ |
Act on field_attach_presave(). |
| hook_field_attach_preprocess_alter |
core/ |
Alter field_attach_preprocess() variables. |
| hook_field_attach_prepare_translation_alter |
core/ |
Perform alterations on field_attach_prepare_translation(). |
| hook_field_attach_load |
core/ |
Act on field_attach_load(). |
| hook_field_attach_insert |
core/ |
Act on field_attach_insert(). |
| hook_field_attach_form |
core/ |
Act on field_attach_form(). |
| hook_field_attach_delete_revision |
core/ |
Act on field_attach_delete_revision(). |
| hook_field_attach_delete_bundle |
core/ |
Act on field_attach_delete_bundle. |
| hook_field_attach_delete |
core/ |
Act on field_attach_delete(). |
| hook_field_attach_create_bundle |
core/ |
Act on field_attach_create_bundle(). |
| hook_field_access |
core/ |
Determine whether the user has access to a given field. |
| hook_exit |
core/ |
Perform cleanup tasks. |
| hook_entity_view_mode_update |
core/ |
Respond to update of a display mode. |
| hook_entity_view_mode_presave |
core/ |
Act on a display mode before it is created or updated. |
| hook_entity_view_mode_insert |
core/ |
Respond to creation of a new display mode. |
| hook_entity_view_mode_info_alter |
core/ |
Alter the display modes for entity types. |
| hook_entity_view_mode_info |
core/ |
Describe the display modes for entity types. |
| hook_entity_view_mode_delete |
core/ |
Respond to deletion of a display mode. |
| hook_entity_view_mode_alter |
core/ |
Change the display mode of an entity that is being displayed. |
| hook_entity_view_alter |
core/ |
Alter the results of ENTITY_view(). |
| hook_entity_view |
core/ |
Act on entities being assembled before rendering. |
| hook_entity_update |
core/ |
Act on entities when updated. |
| hook_entity_query_alter |
core/ |
Alter or execute an EntityFieldQuery. |
| hook_entity_presave |
core/ |
Act on an entity before it is about to be created or updated. |
| hook_entity_prepare_view |
core/ |
Act on entities as they are being prepared for view. |
| hook_entity_predelete |
core/ |
Act before entity deletion. |
| hook_entity_load |
core/ |
Act on entities when loaded. |
| hook_entity_insert |
core/ |
Act on entities when inserted. |
| hook_entity_info_alter |
core/ |
Alter the entity info. |
| hook_entity_info |
core/ |
Inform the base system and the Field API about one or more entity types. |
| hook_entity_delete |
core/ |
Respond to entity deletion. |
| hook_enable |
core/ |
Perform necessary actions after module is enabled. |
| hook_element_info_alter |
core/ |
Alter the element type information returned from modules. |
| hook_element_info |
core/ |
Allows modules to declare their own Form API element types and specify their default values. |
| hook_editor_info_alter |
core/ |
Perform alterations on editor definitions. |
| hook_editor_info |
core/ |
Define text editors, such as WYSIWYGs or toolbars to assist with text input. |
| hook_disable |
core/ |
Perform necessary actions before module is disabled. |
| hook_delete |
core/ |
Respond to node deletion. |
| hook_custom_theme |
core/ |
Return the machine-readable name of the theme to use for the current page. |
| hook_css_alter |
core/ |
Alter CSS files before they are output on the page. |
| hook_cron_queue_info_alter |
core/ |
Alter cron queue information before cron runs. |
| hook_cron_queue_info |
core/ |
Declare queues holding items that need to be run periodically. |
| hook_cron |
core/ |
Perform periodic actions. |
| hook_countries_alter |
core/ |
Alter the default country list. |
| hook_contextual_links_view_alter |
core/ |
Alter a contextual links element before it is rendered. |
| hook_config_update_validate |
core/ |
Validate configuration changes before saving them. |
| hook_config_update_validate |
core/ |
Validate configuration changes before saving them. |
| hook_config_update |
core/ |
Respond to configuration updates. |
| hook_config_update |
core/ |
Respond to configuration updates. |
| hook_config_info |
core/ |
Provides a list of configuration prefixes for describing configuration files. |
| hook_config_info |
core/ |
Provides a list of configuration prefixes for describing configuration files. |
| hook_config_delete_validate |
core/ |
Validate configuration deletions before deleting them. |
| hook_config_delete_validate |
core/ |
Validate configuration deletions before deleting them. |
| hook_config_delete |
core/ |
Respond to configuration deletion. |
| hook_config_delete |
core/ |
Respond to configuration deletion. |
| hook_config_data_validate |
core/ |
Validate a configuration before saving it. |
| hook_config_data_validate |
core/ |
Validate a configuration before saving it. |
| hook_config_create_validate |
core/ |
Validate a new configuration before saving it. |
| hook_config_create_validate |
core/ |
Validate a new configuration before saving it. |
| hook_config_create |
core/ |
Respond to configuration creation. |
| hook_config_create |
core/ |
Respond to configuration creation. |
| hook_comment_view_alter |
core/ |
Alter the results of comment_view(). |
| hook_comment_view |
core/ |
Act on a comment that is being assembled before rendering. |
| hook_comment_update |
core/ |
Respond to updates to a comment. |
| hook_comment_unpublish |
core/ |
Respond to a comment being unpublished by a moderator. |
| hook_comment_publish |
core/ |
Respond to a comment being published by a moderator. |
| hook_comment_presave |
core/ |
Act on a comment being inserted or updated. |
| hook_comment_predelete |
core/ |
Act before comment deletion. |
| hook_comment_load |
core/ |
Act on comments being loaded from the database. |
| hook_comment_insert |
core/ |
Respond to creation of a new comment. |
| hook_comment_delete |
core/ |
Respond to comment deletion. |
| hook_ckeditor_settings_alter |
core/ |
Modify the raw CKEditor 4 settings passed to the editor. |
| hook_ckeditor_plugins_alter |
core/ |
Modify the list of available CKEditor 4 plugins. |
| hook_ckeditor_plugins |
core/ |
Provides a list of CKEditor 4 plugins. |
| hook_ckeditor_css_alter |
core/ |
Modify the list of CSS files that will be added to a CKEditor 4 instance. |
| hook_ckeditor5_upgrade_format_alter |
core/ |
Modify a text format when it is upgraded from CKEditor 4 to CKEditor 5. |
| hook_ckeditor5_upgrade_button_mapping_alter |
core/ |
Modify the button mapping used between CKEditor 4 and CKEditor 5 upgrades. |
| hook_ckeditor5_upgrade_button_mapping |
core/ |
Specify the button mapping used between CKEditor 4 and CKEditor 5 upgrades. |
| hook_ckeditor5_settings_alter |
core/ |
Modify the raw CKEditor settings passed to the editor. |
| hook_ckeditor5_plugins_alter |
core/ |
Modify the list of available CKEditor plugins. |
| hook_ckeditor5_plugins |
core/ |
Provides a list of CKEditor plugins. |
| hook_ckeditor5_css_alter |
core/ |
Modify the list of CSS files that will be added to a CKEditor 5 instance. |
| hook_boot |
core/ |
Perform setup tasks for all page requests. |
| hook_block_view_MODULE_DELTA_alter |
core/ |
Perform alterations to a specific block. |
| hook_block_view_alter |
core/ |
Perform alterations to the content of a block. |
| hook_block_view |
core/ |
Return a rendered or renderable view of a block. |
| hook_block_save |
core/ |
Save the configuration options from hook_block_configure(). |
| hook_block_info_alter |
core/ |
Modify block definitions after loading form code. |
| hook_block_info |
core/ |
Defines to Backdrop what blocks are provided by your module. |
| hook_block_configure |
core/ |
Define a configuration form for a block. |
| hook_batch_alter |
core/ |
Alter batch information before a batch is processed. |
| hook_backdrop_goto_alter |
core/ |
Change the page the user is sent to by backdrop_goto(). |
| hook_autoload_info_alter |
core/ |
Perform alterations to the list of classes included in the registry. |
| hook_autoload_info |
core/ |
Define the paths to classes and interfaces within a module. |
| hook_archiver_info_alter |
core/ |
Alter archiver information declared by other modules. |
| hook_archiver_info |
core/ |
Declare archivers to the system. |
| hook_ajax_render_alter |
core/ |
Alter the commands that are sent to the user through the Ajax framework. |
| hook_admin_paths_alter |
core/ |
Redefine administrative paths defined by other modules. |
| hook_admin_paths |
core/ |
Define administrative paths. |
| hook_action_info_alter |
core/ |
Alters the actions declared by another module. |
| hook_action_info |
core/ |
Declares information about actions. |
| callback_queue_worker |
core/ |
Work on a single queue item. |
Files
|
Name |
Location | Description |
|---|---|---|
| config.api.php |
core/ |
Documentation for hooks provided by Config module. |
Sub-Topics
|
Name |
Location | Description |
|---|---|---|
| Field Widget API |
core/ |
Define Field API widget types. |
| Field Types API |
core/ |
Define field types. |
| Field Formatter API |
core/ |
Define Field API formatter types. |
| Callbacks |
core/ |
Callback function signatures. |