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