Allow modules to interact with the Drupal core.

Drupal's module system is based on the concept of "hooks". A hook is 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 Drupal, a module need simply implement a hook. When Drupal wishes to allow intervention from modules, it determines which modules implement a hook and call 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 is 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().

Functions

Namesort iconLocationDescription
hook_blockdocs-4-6/hooks/core.phpDeclare a block or set of blocks.
hook_commentdocs-4-6/hooks/core.phpAct on comment modification.
hook_crondocs-4-6/hooks/core.phpPerform periodic actions.
hook_db_rewrite_sqldocs-4-6/hooks/core.phpAdd JOIN and WHERE statements to queries and decide whether the primary_field shall be made DISTINCT. For node objects, primary field is always called nid. For taxonomy terms, it is tid and for vocabularies it is vid. For comments, it is cid. Note...
hook_exitdocs-4-6/hooks/core.phpPerform cleanup tasks.
hook_filterdocs-4-6/hooks/core.phpDefine content filters.
hook_filter_tipsdocs-4-6/hooks/core.phpProvide tips for using filters.
hook_footerdocs-4-6/hooks/core.phpInsert closing HTML.
hook_helpdocs-4-6/hooks/core.phpProvide online user help.
hook_initdocs-4-6/hooks/core.phpPerform setup tasks.
hook_linkdocs-4-6/hooks/core.phpDefine internal Drupal links.
hook_menudocs-4-6/hooks/core.phpDefine menu items and page callbacks.
hook_nodeapidocs-4-6/hooks/core.phpAct on nodes defined by other modules.
hook_node_grantsdocs-4-6/hooks/core.phpGrant access to nodes.
hook_onloaddocs-4-6/hooks/core.phpInsert a JavaScript onload handler.
hook_permdocs-4-6/hooks/core.phpDefine user permissions.
hook_pingdocs-4-6/hooks/core.phpPing another server.
hook_searchdocs-4-6/hooks/core.phpDefine a custom search routine.
hook_search_itemdocs-4-6/hooks/core.phpFormat a search result.
hook_search_preprocessdocs-4-6/hooks/core.phpPreprocess text for the search index.
hook_settingsdocs-4-6/hooks/core.phpDeclare administrative settings for a module.
hook_taxonomydocs-4-6/hooks/core.phpAct on taxonomy changes.
hook_textareadocs-4-6/hooks/core.phpReact to textarea additions.
hook_update_indexdocs-4-6/hooks/core.phpUpdate Drupal's full-text index for this module.
hook_userdocs-4-6/hooks/core.phpAct on user account actions.
hook_xmlrpcdocs-4-6/hooks/core.phpRegister XML-RPC callbacks.