system.api.php

You are here

  1. 7 modules/system/system.api.php
  2. 8 core/modules/system/system.api.php

Hooks provided by Drupal core and the System module.

Functions

Namesort descending Description
callback_entity_info_label Return the label of an entity.
callback_entity_info_language Return the language code of the entity.
callback_entity_info_uri Return the URI for an entity.
hook_actions_delete Executes code after an action is deleted.
hook_action_info Declares information about actions.
hook_action_info_alter Alters the actions declared by another module.
hook_admin_paths Define administrative paths.
hook_admin_paths_alter Redefine administrative paths defined by other modules.
hook_ajax_render_alter Alter the commands that are sent to the user through the Ajax framework.
hook_archiver_info Declare archivers to the system.
hook_archiver_info_alter Alter archiver information declared by other modules.
hook_batch_alter Alter batch information before a batch is processed.
hook_boot Perform setup tasks for all page requests.
hook_countries_alter Alter the default country list.
hook_cron Perform periodic actions.
hook_cron_queue_info Declare queues holding items that need to be run periodically.
hook_cron_queue_info_alter Alter cron queue information before cron runs.
hook_css_alter Alter CSS files before they are output on the page.
hook_custom_theme Return the machine-readable name of the theme to use for the current page.
hook_date_formats Define additional date formats.
hook_date_formats_alter Alter date formats declared by another module.
hook_date_format_types Define additional date types.
hook_date_format_types_alter Modify existing date types.
hook_disable Perform necessary actions before module is disabled.
hook_drupal_goto_alter Change the page the user is sent to by drupal_goto().
hook_element_info Allows modules to declare their own Form API element types and specify their default values.
hook_element_info_alter Alter the element type information returned from modules.
hook_enable Perform necessary actions after module is enabled.
hook_entity_delete Act on entities when deleted.
hook_entity_info Inform the base system and the Field API about one or more entity types.
hook_entity_info_alter Alter the entity info.
hook_entity_insert Act on entities when inserted.
hook_entity_load Act on entities when loaded.
hook_entity_prepare_view Act on entities as they are being prepared for view.
hook_entity_presave Act on an entity before it is about to be created or updated.
hook_entity_query_alter Alter or execute an EntityFieldQuery.
hook_entity_update Act on entities when updated.
hook_entity_view Act on entities being assembled before rendering.
hook_entity_view_alter Alter the results of ENTITY_view().
hook_entity_view_mode_alter Change the view mode of an entity that is being displayed.
hook_exit Perform cleanup tasks.
hook_filetransfer_info Register information about FileTransfer classes provided by a module.
hook_filetransfer_info_alter Alter the FileTransfer class registry.
hook_file_copy Respond to a file that has been copied.
hook_file_delete Respond to a file being deleted.
hook_file_download Control access to private file downloads and specify HTTP headers.
hook_file_insert Respond to a file being added.
hook_file_load Load additional information into file objects.
hook_file_mimetype_mapping_alter Alter MIME type mappings used to determine MIME type from a file extension.
hook_file_move Respond to a file that has been moved.
hook_file_presave Act on a file being inserted or updated.
hook_file_update Respond to a file being updated.
hook_file_url_alter Alter the URL to a file.
hook_file_validate Check that files meet a given criteria.
hook_flush_caches Add a list of cache tables to be cleared.
hook_forms Map form_ids to form builder functions.
hook_form_alter Perform alterations before a form is rendered.
hook_form_BASE_FORM_ID_alter Provide a form-specific alteration for shared ('base') forms.
hook_form_FORM_ID_alter Provide a form-specific alteration instead of the global hook_form_alter().
hook_hook_info Defines one or more hooks that are exposed by a module.
hook_hook_info_alter Alter information from hook_hook_info().
hook_html_head_alter Alter XHTML HEAD tags before they are rendered by drupal_get_html_head().
hook_image_toolkits Define image toolkits provided by this module.
hook_init Perform setup tasks for non-cached page requests.
hook_install Perform setup tasks when the module is installed.
hook_install_tasks Return an array of tasks to be performed by an installation profile.
hook_install_tasks_alter Alter the full list of installation tasks.
hook_js_alter Perform necessary alterations to the JavaScript before it is presented on the page.
hook_library Registers JavaScript/CSS libraries associated with a module.
hook_library_alter Alters the JavaScript/CSS library registry.
hook_mail Prepare a message based on parameters; called from drupal_mail().
hook_mail_alter Alter an email message created with the drupal_mail() function.
hook_menu Define menu items and page callbacks.
hook_menu_alter Alter the data being saved to the {menu_router} table after hook_menu is invoked.
hook_menu_breadcrumb_alter Alter links in the active trail before it is rendered as the breadcrumb.
hook_menu_contextual_links_alter Alter contextual links before they are rendered.
hook_menu_get_item_alter Alter a menu router item right after it has been retrieved from the database or cache.
hook_menu_link_alter Alter the data being saved to the {menu_links} table by menu_link_save().
hook_menu_link_delete Inform modules that a menu link has been deleted.
hook_menu_link_insert Inform modules that a menu link has been created.
hook_menu_link_update Inform modules that a menu link has been updated.
hook_menu_local_tasks_alter Alter tabs and actions displayed on the page before they are rendered.
hook_menu_site_status_alter Control site status before menu dispatching.
hook_modules_disabled Perform necessary actions after modules are disabled.
hook_modules_enabled Perform necessary actions after modules are enabled.
hook_modules_installed Perform necessary actions after modules are installed.
hook_modules_uninstalled Perform necessary actions after modules are uninstalled.
hook_module_implements_alter Alter the registry of modules implementing a hook.
hook_page_alter Perform alterations before a page is rendered.
hook_page_build Add elements to a page before it is rendered.
hook_page_delivery_callback_alter Alters the delivery callback used to send the result of the page callback to the browser.
hook_permission Define user permissions.
hook_query_alter Perform alterations to a structured query.
hook_query_TAG_alter Perform alterations to a structured query for a given tag.
hook_registry_files_alter Perform necessary alterations to the list of files parsed by the registry.
hook_requirements Check installation requirements and do status reporting.
hook_schema Define the current version of the database schema.
hook_schema_alter Perform alterations to existing database schemas.
hook_stream_wrappers Registers PHP stream wrapper implementations associated with a module.
hook_stream_wrappers_alter Alters the list of PHP stream wrapper implementations.
hook_system_info_alter Alter the information parsed from module and theme .info files
hook_system_themes_page_alter Alters theme operation links.
hook_system_theme_info Return additional themes provided by modules.
hook_theme Register a module (or theme's) theme implementations.
hook_theme_registry_alter Alter the theme registry information returned from hook_theme().
hook_tokens Provide replacement values for placeholder tokens.
hook_tokens_alter Alter replacement values for placeholder tokens.
hook_token_info Provide information about available placeholder tokens and token types.
hook_token_info_alter Alter the metadata about available placeholder tokens and token types.
hook_translated_menu_link_alter Alter a menu link after it has been translated and before it is rendered.
hook_uninstall Remove any information that the module sets.
hook_updater_info Provide information on Updaters (classes that can update Drupal).
hook_updater_info_alter Alter the Updater information array.
hook_update_dependencies Return an array of information about module update dependencies.
hook_update_last_removed Return a number which is no longer available as hook_update_N().
hook_update_N Perform a single update.
hook_url_inbound_alter Alters inbound URL requests.
hook_url_outbound_alter Alters outbound URLs.
hook_username_alter Alter the username that is displayed for a user.
hook_watchdog Log an event message.
hook_xmlrpc Register XML-RPC callbacks.
hook_xmlrpc_alter Alters the definition of XML-RPC methods before they are called.

File

modules/system/system.api.php
View source
  1. <?php
  2. /**
  3. * @file
  4. * Hooks provided by Drupal core and the System module.
  5. */
  6. /**
  7. * @addtogroup hooks
  8. * @{
  9. */
  10. /**
  11. * Defines one or more hooks that are exposed by a module.
  12. *
  13. * Normally hooks do not need to be explicitly defined. However, by declaring a
  14. * hook explicitly, a module may define a "group" for it. Modules that implement
  15. * a hook may then place their implementation in either $module.module or in
  16. * $module.$group.inc. If the hook is located in $module.$group.inc, then that
  17. * file will be automatically loaded when needed.
  18. * In general, hooks that are rarely invoked and/or are very large should be
  19. * placed in a separate include file, while hooks that are very short or very
  20. * frequently called should be left in the main module file so that they are
  21. * always available.
  22. *
  23. * @return
  24. * An associative array whose keys are hook names and whose values are an
  25. * associative array containing:
  26. * - group: A string defining the group to which the hook belongs. The module
  27. * system will determine whether a file with the name $module.$group.inc
  28. * exists, and automatically load it when required.
  29. *
  30. * See system_hook_info() for all hook groups defined by Drupal core.
  31. *
  32. * @see hook_hook_info_alter().
  33. */
  34. function hook_hook_info() {
  35. $hooks['token_info'] = array(
  36. 'group' => 'tokens',
  37. );
  38. $hooks['tokens'] = array(
  39. 'group' => 'tokens',
  40. );
  41. return $hooks;
  42. }
  43. /**
  44. * Alter information from hook_hook_info().
  45. *
  46. * @param $hooks
  47. * Information gathered by module_hook_info() from other modules'
  48. * implementations of hook_hook_info(). Alter this array directly.
  49. * See hook_hook_info() for information on what this may contain.
  50. */
  51. function hook_hook_info_alter(&$hooks) {
  52. // Our module wants to completely override the core tokens, so make
  53. // sure the core token hooks are not found.
  54. $hooks['token_info']['group'] = 'mytokens';
  55. $hooks['tokens']['group'] = 'mytokens';
  56. }
  57. /**
  58. * Inform the base system and the Field API about one or more entity types.
  59. *
  60. * Inform the system about one or more entity types (i.e., object types that
  61. * can be loaded via entity_load() and, optionally, to which fields can be
  62. * attached).
  63. *
  64. * @return
  65. * An array whose keys are entity type names and whose values identify
  66. * properties of those types that the system needs to know about:
  67. * - label: The human-readable name of the type.
  68. * - controller class: The name of the class that is used to load the objects.
  69. * The class has to implement the DrupalEntityControllerInterface interface.
  70. * Leave blank to use the DrupalDefaultEntityController implementation.
  71. * - base table: (used by DrupalDefaultEntityController) The name of the
  72. * entity type's base table.
  73. * - revision table: The name of the entity type's revision table (if any).
  74. * - static cache: (used by DrupalDefaultEntityController) FALSE to disable
  75. * static caching of entities during a page request. Defaults to TRUE.
  76. * - field cache: (used by Field API loading and saving of field data) FALSE
  77. * to disable Field API's persistent cache of field data. Only recommended
  78. * if a higher level persistent cache is available for the entity type.
  79. * Defaults to TRUE.
  80. * - load hook: The name of the hook which should be invoked by
  81. * DrupalDefaultEntityController:attachLoad(), for example 'node_load'.
  82. * - uri callback: The name of an implementation of
  83. * callback_entity_info_uri().
  84. * - label callback: (optional) The name of an implementation of
  85. * callback_entity_info_label(), which returns the label of the entity. The
  86. * entity label is the main string associated with an entity; for example,
  87. * the title of a node or the subject of a comment. If there is an entity
  88. * object property that defines the label, then using the 'label' element of
  89. * the 'entity keys' return value component suffices to provide this
  90. * information (see below). Alternatively, specifying this callback allows
  91. * more complex logic to determine the label of an entity. See also the
  92. * entity_label() function, which implements this logic.
  93. * - language callback: (optional) The name of an implementation of
  94. * callback_entity_info_language(). In most situations, when needing to
  95. * determine this value, inspecting a property named after the 'language'
  96. * element of the 'entity keys' should be enough. The language callback is
  97. * meant to be used primarily for temporary alterations of the property
  98. * value: entity-defining modules are encouraged to always define a
  99. * language property, instead of using the callback as main entity language
  100. * source. In fact not having a language property defined is likely to
  101. * prevent an entity from being queried by language. Moreover, given that
  102. * entity_language() is not necessarily used everywhere it would be
  103. * appropriate, modules implementing the language callback should be aware
  104. * that this might not be always called.
  105. * - fieldable: Set to TRUE if you want your entity type to accept fields
  106. * being attached to it.
  107. * - translation: An associative array of modules registered as field
  108. * translation handlers. Array keys are the module names, array values
  109. * can be any data structure the module uses to provide field translation.
  110. * Any empty value disallows the module to appear as a translation handler.
  111. * - entity keys: An array describing how the Field API can extract the
  112. * information it needs from the objects of the type. Elements:
  113. * - id: The name of the property that contains the primary id of the
  114. * entity. Every entity object passed to the Field API must have this
  115. * property and its value must be numeric.
  116. * - revision: The name of the property that contains the revision id of
  117. * the entity. The Field API assumes that all revision ids are unique
  118. * across all entities of a type. This entry can be omitted if the
  119. * entities of this type are not versionable.
  120. * - bundle: The name of the property that contains the bundle name for the
  121. * entity. The bundle name defines which set of fields are attached to
  122. * the entity (e.g. what nodes call "content type"). This entry can be
  123. * omitted if this entity type exposes a single bundle (all entities have
  124. * the same collection of fields). The name of this single bundle will be
  125. * the same as the entity type.
  126. * - label: The name of the property that contains the entity label. For
  127. * example, if the entity's label is located in $entity->subject, then
  128. * 'subject' should be specified here. If complex logic is required to
  129. * build the label, a 'label callback' should be defined instead (see
  130. * the 'label callback' section above for details).
  131. * - language: The name of the property, typically 'language', that contains
  132. * the language code representing the language the entity has been created
  133. * in. This value may be changed when editing the entity and represents
  134. * the language its textual components are supposed to have. If no
  135. * language property is available, the 'language callback' may be used
  136. * instead. This entry can be omitted if the entities of this type are not
  137. * language-aware.
  138. * - bundle keys: An array describing how the Field API can extract the
  139. * information it needs from the bundle objects for this type. This entry
  140. * is required if the 'path' provided in the 'bundles'/'admin' section
  141. * identifies the bundle using a named menu placeholder whose loader
  142. * callback returns an object (e.g., $vocabulary for taxonomy terms, or
  143. * $node_type for nodes). If the path does not include the bundle, or the
  144. * bundle is just a string rather than an automatically loaded object, then
  145. * this can be omitted. Elements:
  146. * - bundle: The name of the property of the bundle object that contains
  147. * the name of the bundle object.
  148. * - bundles: An array describing all bundles for this object type. Keys are
  149. * bundles machine names, as found in the objects' 'bundle' property
  150. * (defined in the 'entity keys' entry above). This entry can be omitted if
  151. * this entity type exposes a single bundle (all entities have the same
  152. * collection of fields). The name of this single bundle will be the same as
  153. * the entity type. Elements:
  154. * - label: The human-readable name of the bundle.
  155. * - uri callback: Same as the 'uri callback' key documented above for the
  156. * entity type, but for the bundle only. When determining the URI of an
  157. * entity, if a 'uri callback' is defined for both the entity type and
  158. * the bundle, the one for the bundle is used.
  159. * - admin: An array of information that allows Field UI pages to attach
  160. * themselves to the existing administration pages for the bundle.
  161. * Elements:
  162. * - path: the path of the bundle's main administration page, as defined
  163. * in hook_menu(). If the path includes a placeholder for the bundle,
  164. * the 'bundle argument' and 'real path' keys below are required.
  165. * - bundle argument: The position of the bundle placeholder in 'path', if
  166. * any.
  167. * - real path: The actual path (no placeholder) of the bundle's main
  168. * administration page. This will be used to generate links.
  169. * - access callback: As in hook_menu(). 'user_access' will be assumed if
  170. * no value is provided.
  171. * - access arguments: As in hook_menu().
  172. * - view modes: An array describing the view modes for the entity type. View
  173. * modes let entities be displayed differently depending on the context.
  174. * For instance, a node can be displayed differently on its own page
  175. * ('full' mode), on the home page or taxonomy listings ('teaser' mode), or
  176. * in an RSS feed ('rss' mode). Modules taking part in the display of the
  177. * entity (notably the Field API) can adjust their behavior depending on
  178. * the requested view mode. An additional 'default' view mode is available
  179. * for all entity types. This view mode is not intended for actual entity
  180. * display, but holds default display settings. For each available view
  181. * mode, administrators can configure whether it should use its own set of
  182. * field display settings, or just replicate the settings of the 'default'
  183. * view mode, thus reducing the amount of display configurations to keep
  184. * track of. Keys of the array are view mode names. Each view mode is
  185. * described by an array with the following key/value pairs:
  186. * - label: The human-readable name of the view mode
  187. * - custom settings: A boolean specifying whether the view mode should by
  188. * default use its own custom field display settings. If FALSE, entities
  189. * displayed in this view mode will reuse the 'default' display settings
  190. * by default (e.g. right after the module exposing the view mode is
  191. * enabled), but administrators can later use the Field UI to apply custom
  192. * display settings specific to the view mode.
  193. *
  194. * @see entity_load()
  195. * @see hook_entity_info_alter()
  196. */
  197. function hook_entity_info() {
  198. $return = array(
  199. 'node' => array(
  200. 'label' => t('Node'),
  201. 'controller class' => 'NodeController',
  202. 'base table' => 'node',
  203. 'revision table' => 'node_revision',
  204. 'uri callback' => 'node_uri',
  205. 'fieldable' => TRUE,
  206. 'translation' => array(
  207. 'locale' => TRUE,
  208. ),
  209. 'entity keys' => array(
  210. 'id' => 'nid',
  211. 'revision' => 'vid',
  212. 'bundle' => 'type',
  213. 'language' => 'language',
  214. ),
  215. 'bundle keys' => array(
  216. 'bundle' => 'type',
  217. ),
  218. 'bundles' => array(),
  219. 'view modes' => array(
  220. 'full' => array(
  221. 'label' => t('Full content'),
  222. 'custom settings' => FALSE,
  223. ),
  224. 'teaser' => array(
  225. 'label' => t('Teaser'),
  226. 'custom settings' => TRUE,
  227. ),
  228. 'rss' => array(
  229. 'label' => t('RSS'),
  230. 'custom settings' => FALSE,
  231. ),
  232. ),
  233. ),
  234. );
  235. // Search integration is provided by node.module, so search-related
  236. // view modes for nodes are defined here and not in search.module.
  237. if (module_exists('search')) {
  238. $return['node']['view modes'] += array(
  239. 'search_index' => array(
  240. 'label' => t('Search index'),
  241. 'custom settings' => FALSE,
  242. ),
  243. 'search_result' => array(
  244. 'label' => t('Search result'),
  245. 'custom settings' => FALSE,
  246. ),
  247. );
  248. }
  249. // Bundles must provide a human readable name so we can create help and error
  250. // messages, and the path to attach Field admin pages to.
  251. foreach (node_type_get_names() as $type => $name) {
  252. $return['node']['bundles'][$type] = array(
  253. 'label' => $name,
  254. 'admin' => array(
  255. 'path' => 'admin/structure/types/manage/%node_type',
  256. 'real path' => 'admin/structure/types/manage/' . str_replace('_', '-', $type),
  257. 'bundle argument' => 4,
  258. 'access arguments' => array('administer content types'),
  259. ),
  260. );
  261. }
  262. return $return;
  263. }
  264. /**
  265. * Alter the entity info.
  266. *
  267. * Modules may implement this hook to alter the information that defines an
  268. * entity. All properties that are available in hook_entity_info() can be
  269. * altered here.
  270. *
  271. * @param $entity_info
  272. * The entity info array, keyed by entity name.
  273. *
  274. * @see hook_entity_info()
  275. */
  276. function hook_entity_info_alter(&$entity_info) {
  277. // Set the controller class for nodes to an alternate implementation of the
  278. // DrupalEntityController interface.
  279. $entity_info['node']['controller class'] = 'MyCustomNodeController';
  280. }
  281. /**
  282. * Act on entities when loaded.
  283. *
  284. * This is a generic load hook called for all entity types loaded via the
  285. * entity API.
  286. *
  287. * @param $entities
  288. * The entities keyed by entity ID.
  289. * @param $type
  290. * The type of entities being loaded (i.e. node, user, comment).
  291. */
  292. function hook_entity_load($entities, $type) {
  293. foreach ($entities as $entity) {
  294. $entity->foo = mymodule_add_something($entity, $type);
  295. }
  296. }
  297. /**
  298. * Act on an entity before it is about to be created or updated.
  299. *
  300. * @param $entity
  301. * The entity object.
  302. * @param $type
  303. * The type of entity being saved (i.e. node, user, comment).
  304. */
  305. function hook_entity_presave($entity, $type) {
  306. $entity->changed = REQUEST_TIME;
  307. }
  308. /**
  309. * Act on entities when inserted.
  310. *
  311. * @param $entity
  312. * The entity object.
  313. * @param $type
  314. * The type of entity being inserted (i.e. node, user, comment).
  315. */
  316. function hook_entity_insert($entity, $type) {
  317. // Insert the new entity into a fictional table of all entities.
  318. $info = entity_get_info($type);
  319. list($id) = entity_extract_ids($type, $entity);
  320. db_insert('example_entity')
  321. ->fields(array(
  322. 'type' => $type,
  323. 'id' => $id,
  324. 'created' => REQUEST_TIME,
  325. 'updated' => REQUEST_TIME,
  326. ))
  327. ->execute();
  328. }
  329. /**
  330. * Act on entities when updated.
  331. *
  332. * @param $entity
  333. * The entity object.
  334. * @param $type
  335. * The type of entity being updated (i.e. node, user, comment).
  336. */
  337. function hook_entity_update($entity, $type) {
  338. // Update the entity's entry in a fictional table of all entities.
  339. $info = entity_get_info($type);
  340. list($id) = entity_extract_ids($type, $entity);
  341. db_update('example_entity')
  342. ->fields(array(
  343. 'updated' => REQUEST_TIME,
  344. ))
  345. ->condition('type', $type)
  346. ->condition('id', $id)
  347. ->execute();
  348. }
  349. /**
  350. * Act on entities when deleted.
  351. *
  352. * @param $entity
  353. * The entity object.
  354. * @param $type
  355. * The type of entity being deleted (i.e. node, user, comment).
  356. */
  357. function hook_entity_delete($entity, $type) {
  358. // Delete the entity's entry from a fictional table of all entities.
  359. $info = entity_get_info($type);
  360. list($id) = entity_extract_ids($type, $entity);
  361. db_delete('example_entity')
  362. ->condition('type', $type)
  363. ->condition('id', $id)
  364. ->execute();
  365. }
  366. /**
  367. * Alter or execute an EntityFieldQuery.
  368. *
  369. * @param EntityFieldQuery $query
  370. * An EntityFieldQuery. One of the most important properties to be changed is
  371. * EntityFieldQuery::executeCallback. If this is set to an existing function,
  372. * this function will get the query as its single argument and its result
  373. * will be the returned as the result of EntityFieldQuery::execute(). This can
  374. * be used to change the behavior of EntityFieldQuery entirely. For example,
  375. * the default implementation can only deal with one field storage engine, but
  376. * it is possible to write a module that can query across field storage
  377. * engines. Also, the default implementation presumes entities are stored in
  378. * SQL, but the execute callback could instead query any other entity storage,
  379. * local or remote.
  380. *
  381. * Note the $query->altered attribute which is TRUE in case the query has
  382. * already been altered once. This happens with cloned queries.
  383. * If there is a pager, then such a cloned query will be executed to count
  384. * all elements. This query can be detected by checking for
  385. * ($query->pager && $query->count), allowing the driver to return 0 from
  386. * the count query and disable the pager.
  387. */
  388. function hook_entity_query_alter($query) {
  389. $query->executeCallback = 'my_module_query_callback';
  390. }
  391. /**
  392. * Act on entities being assembled before rendering.
  393. *
  394. * @param $entity
  395. * The entity object.
  396. * @param $type
  397. * The type of entity being rendered (i.e. node, user, comment).
  398. * @param $view_mode
  399. * The view mode the entity is rendered in.
  400. * @param $langcode
  401. * The language code used for rendering.
  402. *
  403. * The module may add elements to $entity->content prior to rendering. The
  404. * structure of $entity->content is a renderable array as expected by
  405. * drupal_render().
  406. *
  407. * @see hook_entity_view_alter()
  408. * @see hook_comment_view()
  409. * @see hook_node_view()
  410. * @see hook_user_view()
  411. */
  412. function hook_entity_view($entity, $type, $view_mode, $langcode) {
  413. $entity->content['my_additional_field'] = array(
  414. '#markup' => $additional_field,
  415. '#weight' => 10,
  416. '#theme' => 'mymodule_my_additional_field',
  417. );
  418. }
  419. /**
  420. * Alter the results of ENTITY_view().
  421. *
  422. * This hook is called after the content has been assembled in a structured
  423. * array and may be used for doing processing which requires that the complete
  424. * entity content structure has been built.
  425. *
  426. * If a module wishes to act on the rendered HTML of the entity rather than the
  427. * structured content array, it may use this hook to add a #post_render
  428. * callback. Alternatively, it could also implement hook_preprocess_ENTITY().
  429. * See drupal_render() and theme() for details.
  430. *
  431. * @param $build
  432. * A renderable array representing the entity content.
  433. * @param $type
  434. * The type of entity being rendered (i.e. node, user, comment).
  435. *
  436. * @see hook_entity_view()
  437. * @see hook_comment_view_alter()
  438. * @see hook_node_view_alter()
  439. * @see hook_taxonomy_term_view_alter()
  440. * @see hook_user_view_alter()
  441. */
  442. function hook_entity_view_alter(&$build, $type) {
  443. if ($build['#view_mode'] == 'full' && isset($build['an_additional_field'])) {
  444. // Change its weight.
  445. $build['an_additional_field']['#weight'] = -10;
  446. // Add a #post_render callback to act on the rendered HTML of the entity.
  447. $build['#post_render'][] = 'my_module_node_post_render';
  448. }
  449. }
  450. /**
  451. * Change the view mode of an entity that is being displayed.
  452. *
  453. * @param string $view_mode
  454. * The view_mode that is to be used to display the entity.
  455. * @param array $context
  456. * Array with contextual information, including:
  457. * - entity_type: The type of the entity that is being viewed.
  458. * - entity: The entity object.
  459. * - langcode: The langcode the entity is being viewed in.
  460. */
  461. function hook_entity_view_mode_alter(&$view_mode, $context) {
  462. // For nodes, change the view mode when it is teaser.
  463. if ($context['entity_type'] == 'node' && $view_mode == 'teaser') {
  464. $view_mode = 'my_custom_view_mode';
  465. }
  466. }
  467. /**
  468. * Define administrative paths.
  469. *
  470. * Modules may specify whether or not the paths they define in hook_menu() are
  471. * to be considered administrative. Other modules may use this information to
  472. * display those pages differently (e.g. in a modal overlay, or in a different
  473. * theme).
  474. *
  475. * To change the administrative status of menu items defined in another module's
  476. * hook_menu(), modules should implement hook_admin_paths_alter().
  477. *
  478. * @return
  479. * An associative array. For each item, the key is the path in question, in
  480. * a format acceptable to drupal_match_path(). The value for each item should
  481. * be TRUE (for paths considered administrative) or FALSE (for non-
  482. * administrative paths).
  483. *
  484. * @see hook_menu()
  485. * @see drupal_match_path()
  486. * @see hook_admin_paths_alter()
  487. */
  488. function hook_admin_paths() {
  489. $paths = array(
  490. 'mymodule/*/add' => TRUE,
  491. 'mymodule/*/edit' => TRUE,
  492. );
  493. return $paths;
  494. }
  495. /**
  496. * Redefine administrative paths defined by other modules.
  497. *
  498. * @param $paths
  499. * An associative array of administrative paths, as defined by implementations
  500. * of hook_admin_paths().
  501. *
  502. * @see hook_admin_paths()
  503. */
  504. function hook_admin_paths_alter(&$paths) {
  505. // Treat all user pages as administrative.
  506. $paths['user'] = TRUE;
  507. $paths['user/*'] = TRUE;
  508. // Treat the forum topic node form as a non-administrative page.
  509. $paths['node/add/forum'] = FALSE;
  510. }
  511. /**
  512. * Act on entities as they are being prepared for view.
  513. *
  514. * Allows you to operate on multiple entities as they are being prepared for
  515. * view. Only use this if attaching the data during the entity_load() phase
  516. * is not appropriate, for example when attaching other 'entity' style objects.
  517. *
  518. * @param $entities
  519. * The entities keyed by entity ID.
  520. * @param $type
  521. * The type of entities being loaded (i.e. node, user, comment).
  522. * @param $langcode
  523. * The language to display the entity in.
  524. */
  525. function hook_entity_prepare_view($entities, $type, $langcode) {
  526. // Load a specific node into the user object for later theming.
  527. if ($type == 'user') {
  528. $nodes = mymodule_get_user_nodes(array_keys($entities));
  529. foreach ($entities as $uid => $entity) {
  530. $entity->user_node = $nodes[$uid];
  531. }
  532. }
  533. }
  534. /**
  535. * Perform periodic actions.
  536. *
  537. * Modules that require some commands to be executed periodically can
  538. * implement hook_cron(). The engine will then call the hook whenever a cron
  539. * run happens, as defined by the administrator. Typical tasks managed by
  540. * hook_cron() are database maintenance, backups, recalculation of settings
  541. * or parameters, automated mailing, and retrieving remote data.
  542. *
  543. * Short-running or non-resource-intensive tasks can be executed directly in
  544. * the hook_cron() implementation.
  545. *
  546. * Long-running tasks and tasks that could time out, such as retrieving remote
  547. * data, sending email, and intensive file tasks, should use the queue API
  548. * instead of executing the tasks directly. To do this, first define one or
  549. * more queues via hook_cron_queue_info(). Then, add items that need to be
  550. * processed to the defined queues.
  551. */
  552. function hook_cron() {
  553. // Short-running operation example, not using a queue:
  554. // Delete all expired records since the last cron run.
  555. $expires = variable_get('mymodule_cron_last_run', REQUEST_TIME);
  556. db_delete('mymodule_table')
  557. ->condition('expires', $expires, '>=')
  558. ->execute();
  559. variable_set('mymodule_cron_last_run', REQUEST_TIME);
  560. // Long-running operation example, leveraging a queue:
  561. // Fetch feeds from other sites.
  562. $result = db_query('SELECT * FROM {aggregator_feed} WHERE checked + refresh < :time AND refresh <> :never', array(
  563. ':time' => REQUEST_TIME,
  564. ':never' => AGGREGATOR_CLEAR_NEVER,
  565. ));
  566. $queue = DrupalQueue::get('aggregator_feeds');
  567. foreach ($result as $feed) {
  568. $queue->createItem($feed);
  569. }
  570. }
  571. /**
  572. * Declare queues holding items that need to be run periodically.
  573. *
  574. * While there can be only one hook_cron() process running at the same time,
  575. * there can be any number of processes defined here running. Because of
  576. * this, long running tasks are much better suited for this API. Items queued
  577. * in hook_cron() might be processed in the same cron run if there are not many
  578. * items in the queue, otherwise it might take several requests, which can be
  579. * run in parallel.
  580. *
  581. * @return
  582. * An associative array where the key is the queue name and the value is
  583. * again an associative array. Possible keys are:
  584. * - 'worker callback': The name of the function to call. It will be called
  585. * with one argument, the item created via DrupalQueue::createItem().
  586. * - 'time': (optional) How much time Drupal should spend on calling this
  587. * worker in seconds. Defaults to 15.
  588. * - 'skip on cron': (optional) Set to TRUE to avoid being processed during
  589. * cron runs (for example, if you want to control all queue execution
  590. * manually).
  591. *
  592. * @see hook_cron()
  593. * @see hook_cron_queue_info_alter()
  594. */
  595. function hook_cron_queue_info() {
  596. $queues['aggregator_feeds'] = array(
  597. 'worker callback' => 'aggregator_refresh',
  598. 'time' => 60,
  599. );
  600. return $queues;
  601. }
  602. /**
  603. * Alter cron queue information before cron runs.
  604. *
  605. * Called by drupal_cron_run() to allow modules to alter cron queue settings
  606. * before any jobs are processesed.
  607. *
  608. * @param array $queues
  609. * An array of cron queue information.
  610. *
  611. * @see hook_cron_queue_info()
  612. * @see drupal_cron_run()
  613. */
  614. function hook_cron_queue_info_alter(&$queues) {
  615. // This site has many feeds so let's spend 90 seconds on each cron run
  616. // updating feeds instead of the default 60.
  617. $queues['aggregator_feeds']['time'] = 90;
  618. }
  619. /**
  620. * Allows modules to declare their own Form API element types and specify their
  621. * default values.
  622. *
  623. * This hook allows modules to declare their own form element types and to
  624. * specify their default values. The values returned by this hook will be
  625. * merged with the elements returned by hook_form() implementations and so
  626. * can return defaults for any Form APIs keys in addition to those explicitly
  627. * mentioned below.
  628. *
  629. * Each of the form element types defined by this hook is assumed to have
  630. * a matching theme function, e.g. theme_elementtype(), which should be
  631. * registered with hook_theme() as normal.
  632. *
  633. * For more information about custom element types see the explanation at
  634. * http://drupal.org/node/169815.
  635. *
  636. * @return
  637. * An associative array describing the element types being defined. The array
  638. * contains a sub-array for each element type, with the machine-readable type
  639. * name as the key. Each sub-array has a number of possible attributes:
  640. * - "#input": boolean indicating whether or not this element carries a value
  641. * (even if it's hidden).
  642. * - "#process": array of callback functions taking $element, $form_state,
  643. * and $complete_form.
  644. * - "#after_build": array of callback functions taking $element and $form_state.
  645. * - "#validate": array of callback functions taking $form and $form_state.
  646. * - "#element_validate": array of callback functions taking $element and
  647. * $form_state.
  648. * - "#pre_render": array of callback functions taking $element and $form_state.
  649. * - "#post_render": array of callback functions taking $element and $form_state.
  650. * - "#submit": array of callback functions taking $form and $form_state.
  651. * - "#title_display": optional string indicating if and how #title should be
  652. * displayed, see theme_form_element() and theme_form_element_label().
  653. *
  654. * @see hook_element_info_alter()
  655. * @see system_element_info()
  656. */
  657. function hook_element_info() {
  658. $types['filter_format'] = array(
  659. '#input' => TRUE,
  660. );
  661. return $types;
  662. }
  663. /**
  664. * Alter the element type information returned from modules.
  665. *
  666. * A module may implement this hook in order to alter the element type defaults
  667. * defined by a module.
  668. *
  669. * @param $type
  670. * All element type defaults as collected by hook_element_info().
  671. *
  672. * @see hook_element_info()
  673. */
  674. function hook_element_info_alter(&$type) {
  675. // Decrease the default size of textfields.
  676. if (isset($type['textfield']['#size'])) {
  677. $type['textfield']['#size'] = 40;
  678. }
  679. }
  680. /**
  681. * Perform cleanup tasks.
  682. *
  683. * This hook is run at the end of most regular page requests. It is often
  684. * used for page logging and specialized cleanup. This hook MUST NOT print
  685. * anything because by the time it runs the response is already sent to
  686. * the browser.
  687. *
  688. * Only use this hook if your code must run even for cached page views.
  689. * If you have code which must run once on all non-cached pages, use
  690. * hook_init() instead. That is the usual case. If you implement this hook
  691. * and see an error like 'Call to undefined function', it is likely that
  692. * you are depending on the presence of a module which has not been loaded yet.
  693. * It is not loaded because Drupal is still in bootstrap mode.
  694. *
  695. * @param $destination
  696. * If this hook is invoked as part of a drupal_goto() call, then this argument
  697. * will be a fully-qualified URL that is the destination of the redirect.
  698. */
  699. function hook_exit($destination = NULL) {
  700. db_update('counter')
  701. ->expression('hits', 'hits + 1')
  702. ->condition('type', 1)
  703. ->execute();
  704. }
  705. /**
  706. * Perform necessary alterations to the JavaScript before it is presented on
  707. * the page.
  708. *
  709. * @param $javascript
  710. * An array of all JavaScript being presented on the page.
  711. *
  712. * @see drupal_add_js()
  713. * @see drupal_get_js()
  714. * @see drupal_js_defaults()
  715. */
  716. function hook_js_alter(&$javascript) {
  717. // Swap out jQuery to use an updated version of the library.
  718. $javascript['misc/jquery.js']['data'] = drupal_get_path('module', 'jquery_update') . '/jquery.js';
  719. }
  720. /**
  721. * Registers JavaScript/CSS libraries associated with a module.
  722. *
  723. * Modules implementing this return an array of arrays. The key to each
  724. * sub-array is the machine readable name of the library. Each library may
  725. * contain the following items:
  726. *
  727. * - 'title': The human readable name of the library.
  728. * - 'website': The URL of the library's web site.
  729. * - 'version': A string specifying the version of the library; intentionally
  730. * not a float because a version like "1.2.3" is not a valid float. Use PHP's
  731. * version_compare() to compare different versions.
  732. * - 'js': An array of JavaScript elements; each element's key is used as $data
  733. * argument, each element's value is used as $options array for
  734. * drupal_add_js(). To add library-specific (not module-specific) JavaScript
  735. * settings, the key may be skipped, the value must specify
  736. * 'type' => 'setting', and the actual settings must be contained in a 'data'
  737. * element of the value.
  738. * - 'css': Like 'js', an array of CSS elements passed to drupal_add_css().
  739. * - 'dependencies': An array of libraries that are required for a library. Each
  740. * element is an array listing the module and name of another library. Note
  741. * that all dependencies for each dependent library will also be added when
  742. * this library is added.
  743. *
  744. * Registered information for a library should contain re-usable data only.
  745. * Module- or implementation-specific data and integration logic should be added
  746. * separately.
  747. *
  748. * @return
  749. * An array defining libraries associated with a module.
  750. *
  751. * @see system_library()
  752. * @see drupal_add_library()
  753. * @see drupal_get_library()
  754. */
  755. function hook_library() {
  756. // Library One.
  757. $libraries['library-1'] = array(
  758. 'title' => 'Library One',
  759. 'website' => 'http://example.com/library-1',
  760. 'version' => '1.2',
  761. 'js' => array(
  762. drupal_get_path('module', 'my_module') . '/library-1.js' => array(),
  763. ),
  764. 'css' => array(
  765. drupal_get_path('module', 'my_module') . '/library-2.css' => array(
  766. 'type' => 'file',
  767. 'media' => 'screen',
  768. ),
  769. ),
  770. );
  771. // Library Two.
  772. $libraries['library-2'] = array(
  773. 'title' => 'Library Two',
  774. 'website' => 'http://example.com/library-2',
  775. 'version' => '3.1-beta1',
  776. 'js' => array(
  777. // JavaScript settings may use the 'data' key.
  778. array(
  779. 'type' => 'setting',
  780. 'data' => array('library2' => TRUE),
  781. ),
  782. ),
  783. 'dependencies' => array(
  784. // Require jQuery UI core by System module.
  785. array('system', 'ui'),
  786. // Require our other library.
  787. array('my_module', 'library-1'),
  788. // Require another library.
  789. array('other_module', 'library-3'),
  790. ),
  791. );
  792. return $libraries;
  793. }
  794. /**
  795. * Alters the JavaScript/CSS library registry.
  796. *
  797. * Allows certain, contributed modules to update libraries to newer versions
  798. * while ensuring backwards compatibility. In general, such manipulations should
  799. * only be done by designated modules, since most modules that integrate with a
  800. * certain library also depend on the API of a certain library version.
  801. *
  802. * @param $libraries
  803. * The JavaScript/CSS libraries provided by $module. Keyed by internal library
  804. * name and passed by reference.
  805. * @param $module
  806. * The name of the module that registered the libraries.
  807. *
  808. * @see hook_library()
  809. */
  810. function hook_library_alter(&$libraries, $module) {
  811. // Update Farbtastic to version 2.0.
  812. if ($module == 'system' && isset($libraries['farbtastic'])) {
  813. // Verify existing version is older than the one we are updating to.
  814. if (version_compare($libraries['farbtastic']['version'], '2.0', '<')) {
  815. // Update the existing Farbtastic to version 2.0.
  816. $libraries['farbtastic']['version'] = '2.0';
  817. $libraries['farbtastic']['js'] = array(
  818. drupal_get_path('module', 'farbtastic_update') . '/farbtastic-2.0.js' => array(),
  819. );
  820. }
  821. }
  822. }
  823. /**
  824. * Alter CSS files before they are output on the page.
  825. *
  826. * @param $css
  827. * An array of all CSS items (files and inline CSS) being requested on the page.
  828. *
  829. * @see drupal_add_css()
  830. * @see drupal_get_css()
  831. */
  832. function hook_css_alter(&$css) {
  833. // Remove defaults.css file.
  834. unset($css[drupal_get_path('module', 'system') . '/defaults.css']);
  835. }
  836. /**
  837. * Alter the commands that are sent to the user through the Ajax framework.
  838. *
  839. * @param $commands
  840. * An array of all commands that will be sent to the user.
  841. *
  842. * @see ajax_render()
  843. */
  844. function hook_ajax_render_alter(&$commands) {
  845. // Inject any new status messages into the content area.
  846. $commands[] = ajax_command_prepend('#block-system-main .content', theme('status_messages'));
  847. }
  848. /**
  849. * Add elements to a page before it is rendered.
  850. *
  851. * Use this hook when you want to add elements at the page level. For your
  852. * additions to be printed, they have to be placed below a top level array key
  853. * of the $page array that has the name of a region of the active theme.
  854. *
  855. * By default, valid region keys are 'page_top', 'header', 'sidebar_first',
  856. * 'content', 'sidebar_second' and 'page_bottom'. To get a list of all regions
  857. * of the active theme, use system_region_list($theme). Note that $theme is a
  858. * global variable.
  859. *
  860. * If you want to alter the elements added by other modules or if your module
  861. * depends on the elements of other modules, use hook_page_alter() instead which
  862. * runs after this hook.
  863. *
  864. * @param $page
  865. * Nested array of renderable elements that make up the page.
  866. *
  867. * @see hook_page_alter()
  868. * @see drupal_render_page()
  869. */
  870. function hook_page_build(&$page) {
  871. if (menu_get_object('node', 1)) {
  872. // We are on a node detail page. Append a standard disclaimer to the
  873. // content region.
  874. $page['content']['disclaimer'] = array(
  875. '#markup' => t('Acme, Inc. is not responsible for the contents of this sample code.'),
  876. '#weight' => 25,
  877. );
  878. }
  879. }
  880. /**
  881. * Alter a menu router item right after it has been retrieved from the database or cache.
  882. *
  883. * This hook is invoked by menu_get_item() and allows for run-time alteration of router
  884. * information (page_callback, title, and so on) before it is translated and checked for
  885. * access. The passed-in $router_item is statically cached for the current request, so this
  886. * hook is only invoked once for any router item that is retrieved via menu_get_item().
  887. *
  888. * Usually, modules will only want to inspect the router item and conditionally
  889. * perform other actions (such as preparing a state for the current request).
  890. * Note that this hook is invoked for any router item that is retrieved by
  891. * menu_get_item(), which may or may not be called on the path itself, so implementations
  892. * should check the $path parameter if the alteration should fire for the current request
  893. * only.
  894. *
  895. * @param $router_item
  896. * The menu router item for $path.
  897. * @param $path
  898. * The originally passed path, for which $router_item is responsible.
  899. * @param $original_map
  900. * The path argument map, as contained in $path.
  901. *
  902. * @see menu_get_item()
  903. */
  904. function hook_menu_get_item_alter(&$router_item, $path, $original_map) {
  905. // When retrieving the router item for the current path...
  906. if ($path == $_GET['q']) {
  907. // ...call a function that prepares something for this request.
  908. mymodule_prepare_something();
  909. }
  910. }
  911. /**
  912. * Define menu items and page callbacks.
  913. *
  914. * This hook enables modules to register paths in order to define how URL
  915. * requests are handled. Paths may be registered for URL handling only, or they
  916. * can register a link to be placed in a menu (usually the Navigation menu). A
  917. * path and its associated information is commonly called a "menu router item".
  918. * This hook is rarely called (for example, when modules are enabled), and
  919. * its results are cached in the database.
  920. *
  921. * hook_menu() implementations return an associative array whose keys define
  922. * paths and whose values are an associative array of properties for each
  923. * path. (The complete list of properties is in the return value section below.)
  924. *
  925. * @section sec_callback_funcs Callback Functions
  926. * The definition for each path may include a page callback function, which is
  927. * invoked when the registered path is requested. If there is no other
  928. * registered path that fits the requested path better, any further path
  929. * components are passed to the callback function. For example, your module
  930. * could register path 'abc/def':
  931. * @code
  932. * function mymodule_menu() {
  933. * $items['abc/def'] = array(
  934. * 'page callback' => 'mymodule_abc_view',
  935. * );
  936. * return $items;
  937. * }
  938. *
  939. * function mymodule_abc_view($ghi = 0, $jkl = '') {
  940. * // ...
  941. * }
  942. * @endcode
  943. * When path 'abc/def' is requested, no further path components are in the
  944. * request, and no additional arguments are passed to the callback function (so
  945. * $ghi and $jkl would take the default values as defined in the function
  946. * signature). When 'abc/def/123/foo' is requested, $ghi will be '123' and
  947. * $jkl will be 'foo'. Note that this automatic passing of optional path
  948. * arguments applies only to page and theme callback functions.
  949. *
  950. * @subsection sub_callback_arguments Callback Arguments
  951. * In addition to optional path arguments, the page callback and other callback
  952. * functions may specify argument lists as arrays. These argument lists may
  953. * contain both fixed/hard-coded argument values and integers that correspond
  954. * to path components. When integers are used and the callback function is
  955. * called, the corresponding path components will be substituted for the
  956. * integers. That is, the integer 0 in an argument list will be replaced with
  957. * the first path component, integer 1 with the second, and so on (path
  958. * components are numbered starting from zero). To pass an integer without it
  959. * being replaced with its respective path component, use the string value of
  960. * the integer (e.g., '1') as the argument value. This substitution feature
  961. * allows you to re-use a callback function for several different paths. For
  962. * example:
  963. * @code
  964. * function mymodule_menu() {
  965. * $items['abc/def'] = array(
  966. * 'page callback' => 'mymodule_abc_view',
  967. * 'page arguments' => array(1, 'foo'),
  968. * );
  969. * return $items;
  970. * }
  971. * @endcode
  972. * When path 'abc/def' is requested, the page callback function will get 'def'
  973. * as the first argument and (always) 'foo' as the second argument.
  974. *
  975. * If a page callback function uses an argument list array, and its path is
  976. * requested with optional path arguments, then the list array's arguments are
  977. * passed to the callback function first, followed by the optional path
  978. * arguments. Using the above example, when path 'abc/def/bar/baz' is requested,
  979. * mymodule_abc_view() will be called with 'def', 'foo', 'bar' and 'baz' as
  980. * arguments, in that order.
  981. *
  982. * Special care should be taken for the page callback drupal_get_form(), because
  983. * your specific form callback function will always receive $form and
  984. * &$form_state as the first function arguments:
  985. * @code
  986. * function mymodule_abc_form($form, &$form_state) {
  987. * // ...
  988. * return $form;
  989. * }
  990. * @endcode
  991. * See @link form_api Form API documentation @endlink for details.
  992. *
  993. * @section sec_path_wildcards Wildcards in Paths
  994. * @subsection sub_simple_wildcards Simple Wildcards
  995. * Wildcards within paths also work with integer substitution. For example,
  996. * your module could register path 'my-module/%/edit':
  997. * @code
  998. * $items['my-module/%/edit'] = array(
  999. * 'page callback' => 'mymodule_abc_edit',
  1000. * 'page arguments' => array(1),
  1001. * );
  1002. * @endcode
  1003. * When path 'my-module/foo/edit' is requested, integer 1 will be replaced
  1004. * with 'foo' and passed to the callback function. Note that wildcards may not
  1005. * be used as the first component.
  1006. *
  1007. * @subsection sub_autoload_wildcards Auto-Loader Wildcards
  1008. * Registered paths may also contain special "auto-loader" wildcard components
  1009. * in the form of '%mymodule_abc', where the '%' part means that this path
  1010. * component is a wildcard, and the 'mymodule_abc' part defines the prefix for a
  1011. * load function, which here would be named mymodule_abc_load(). When a matching
  1012. * path is requested, your load function will receive as its first argument the
  1013. * path component in the position of the wildcard; load functions may also be
  1014. * passed additional arguments (see "load arguments" in the return value
  1015. * section below). For example, your module could register path
  1016. * 'my-module/%mymodule_abc/edit':
  1017. * @code
  1018. * $items['my-module/%mymodule_abc/edit'] = array(
  1019. * 'page callback' => 'mymodule_abc_edit',
  1020. * 'page arguments' => array(1),
  1021. * );
  1022. * @endcode
  1023. * When path 'my-module/123/edit' is requested, your load function
  1024. * mymodule_abc_load() will be invoked with the argument '123', and should
  1025. * load and return an "abc" object with internal id 123:
  1026. * @code
  1027. * function mymodule_abc_load($abc_id) {
  1028. * return db_query("SELECT * FROM {mymodule_abc} WHERE abc_id = :abc_id", array(':abc_id' => $abc_id))->fetchObject();
  1029. * }
  1030. * @endcode
  1031. * This 'abc' object will then be passed into the callback functions defined
  1032. * for the menu item, such as the page callback function mymodule_abc_edit()
  1033. * to replace the integer 1 in the argument array. Note that a load function
  1034. * should return FALSE when it is unable to provide a loadable object. For
  1035. * example, the node_load() function for the 'node/%node/edit' menu item will
  1036. * return FALSE for the path 'node/999/edit' if a node with a node ID of 999
  1037. * does not exist. The menu routing system will return a 404 error in this case.
  1038. *
  1039. * @subsection sub_argument_wildcards Argument Wildcards
  1040. * You can also define a %wildcard_to_arg() function (for the example menu
  1041. * entry above this would be 'mymodule_abc_to_arg()'). The _to_arg() function
  1042. * is invoked to retrieve a value that is used in the path in place of the
  1043. * wildcard. A good example is user.module, which defines
  1044. * user_uid_optional_to_arg() (corresponding to the menu entry
  1045. * 'tracker/%user_uid_optional'). This function returns the user ID of the
  1046. * current user.
  1047. *
  1048. * The _to_arg() function will get called with three arguments:
  1049. * - $arg: A string representing whatever argument may have been supplied by
  1050. * the caller (this is particularly useful if you want the _to_arg()
  1051. * function only supply a (default) value if no other value is specified,
  1052. * as in the case of user_uid_optional_to_arg().
  1053. * - $map: An array of all path fragments (e.g. array('node','123','edit') for
  1054. * 'node/123/edit').
  1055. * - $index: An integer indicating which element of $map corresponds to $arg.
  1056. *
  1057. * _load() and _to_arg() functions may seem similar at first glance, but they
  1058. * have different purposes and are called at different times. _load()
  1059. * functions are called when the menu system is collecting arguments to pass
  1060. * to the callback functions defined for the menu item. _to_arg() functions
  1061. * are called when the menu system is generating links to related paths, such
  1062. * as the tabs for a set of MENU_LOCAL_TASK items.
  1063. *
  1064. * @section sec_render_tabs Rendering Menu Items As Tabs
  1065. * You can also make groups of menu items to be rendered (by default) as tabs
  1066. * on a page. To do that, first create one menu item of type MENU_NORMAL_ITEM,
  1067. * with your chosen path, such as 'foo'. Then duplicate that menu item, using a
  1068. * subdirectory path, such as 'foo/tab1', and changing the type to
  1069. * MENU_DEFAULT_LOCAL_TASK to make it the default tab for the group. Then add
  1070. * the additional tab items, with paths such as "foo/tab2" etc., with type
  1071. * MENU_LOCAL_TASK. Example:
  1072. * @code
  1073. * // Make "Foo settings" appear on the admin Config page
  1074. * $items['admin/config/system/foo'] = array(
  1075. * 'title' => 'Foo settings',
  1076. * 'type' => MENU_NORMAL_ITEM,
  1077. * // Page callback, etc. need to be added here.
  1078. * );
  1079. * // Make "Tab 1" the main tab on the "Foo settings" page
  1080. * $items['admin/config/system/foo/tab1'] = array(
  1081. * 'title' => 'Tab 1',
  1082. * 'type' => MENU_DEFAULT_LOCAL_TASK,
  1083. * // Access callback, page callback, and theme callback will be inherited
  1084. * // from 'admin/config/system/foo', if not specified here to override.
  1085. * );
  1086. * // Make an additional tab called "Tab 2" on "Foo settings"
  1087. * $items['admin/config/system/foo/tab2'] = array(
  1088. * 'title' => 'Tab 2',
  1089. * 'type' => MENU_LOCAL_TASK,
  1090. * // Page callback and theme callback will be inherited from
  1091. * // 'admin/config/system/foo', if not specified here to override.
  1092. * // Need to add access callback or access arguments.
  1093. * );
  1094. * @endcode
  1095. *
  1096. * @return
  1097. * An array of menu items. Each menu item has a key corresponding to the
  1098. * Drupal path being registered. The corresponding array value is an
  1099. * associative array that may contain the following key-value pairs:
  1100. * - "title": Required. The untranslated title of the menu item.
  1101. * - "title callback": Function to generate the title; defaults to t().
  1102. * If you require only the raw string to be output, set this to FALSE.
  1103. * - "title arguments": Arguments to send to t() or your custom callback,
  1104. * with path component substitution as described above.
  1105. * - "description": The untranslated description of the menu item.
  1106. * - "page callback": The function to call to display a web page when the user
  1107. * visits the path. If omitted, the parent menu item's callback will be used
  1108. * instead.
  1109. * - "page arguments": An array of arguments to pass to the page callback
  1110. * function, with path component substitution as described above.
  1111. * - "delivery callback": The function to call to package the result of the
  1112. * page callback function and send it to the browser. Defaults to
  1113. * drupal_deliver_html_page() unless a value is inherited from a parent menu
  1114. * item. Note that this function is called even if the access checks fail,
  1115. * so any custom delivery callback function should take that into account.
  1116. * See drupal_deliver_html_page() for an example.
  1117. * - "access callback": A function returning TRUE if the user has access
  1118. * rights to this menu item, and FALSE if not. It can also be a boolean
  1119. * constant instead of a function, and you can also use numeric values
  1120. * (will be cast to boolean). Defaults to user_access() unless a value is
  1121. * inherited from the parent menu item; only MENU_DEFAULT_LOCAL_TASK items
  1122. * can inherit access callbacks. To use the user_access() default callback,
  1123. * you must specify the permission to check as 'access arguments' (see
  1124. * below).
  1125. * - "access arguments": An array of arguments to pass to the access callback
  1126. * function, with path component substitution as described above. If the
  1127. * access callback is inherited (see above), the access arguments will be
  1128. * inherited with it, unless overridden in the child menu item.
  1129. * - "theme callback": (optional) A function returning the machine-readable
  1130. * name of the theme that will be used to render the page. If not provided,
  1131. * the value will be inherited from a parent menu item. If there is no
  1132. * theme callback, or if the function does not return the name of a current
  1133. * active theme on the site, the theme for this page will be determined by
  1134. * either hook_custom_theme() or the default theme instead. As a general
  1135. * rule, the use of theme callback functions should be limited to pages
  1136. * whose functionality is very closely tied to a particular theme, since
  1137. * they can only be overridden by modules which specifically target those
  1138. * pages in hook_menu_alter(). Modules implementing more generic theme
  1139. * switching functionality (for example, a module which allows the theme to
  1140. * be set dynamically based on the current user's role) should use
  1141. * hook_custom_theme() instead.
  1142. * - "theme arguments": An array of arguments to pass to the theme callback
  1143. * function, with path component substitution as described above.
  1144. * - "file": A file that will be included before the page callback is called;
  1145. * this allows page callback functions to be in separate files. The file
  1146. * should be relative to the implementing module's directory unless
  1147. * otherwise specified by the "file path" option. Does not apply to other
  1148. * callbacks (only page callback).
  1149. * - "file path": The path to the directory containing the file specified in
  1150. * "file". This defaults to the path to the module implementing the hook.
  1151. * - "load arguments": An array of arguments to be passed to each of the
  1152. * wildcard object loaders in the path, after the path argument itself.
  1153. * For example, if a module registers path node/%node/revisions/%/view
  1154. * with load arguments set to array(3), the '%node' in the path indicates
  1155. * that the loader function node_load() will be called with the second
  1156. * path component as the first argument. The 3 in the load arguments
  1157. * indicates that the fourth path component will also be passed to
  1158. * node_load() (numbering of path components starts at zero). So, if path
  1159. * node/12/revisions/29/view is requested, node_load(12, 29) will be called.
  1160. * There are also two "magic" values that can be used in load arguments.
  1161. * "%index" indicates the index of the wildcard path component. "%map"
  1162. * indicates the path components as an array. For example, if a module
  1163. * registers for several paths of the form 'user/%user_category/edit/*', all
  1164. * of them can use the same load function user_category_load(), by setting
  1165. * the load arguments to array('%map', '%index'). For instance, if the user
  1166. * is editing category 'foo' by requesting path 'user/32/edit/foo', the load
  1167. * function user_category_load() will be called with 32 as its first
  1168. * argument, the array ('user', 32, 'edit', 'foo') as the map argument,
  1169. * and 1 as the index argument (because %user_category is the second path
  1170. * component and numbering starts at zero). user_category_load() can then
  1171. * use these values to extract the information that 'foo' is the category
  1172. * being requested.
  1173. * - "weight": An integer that determines the relative position of items in
  1174. * the menu; higher-weighted items sink. Defaults to 0. Menu items with the
  1175. * same weight are ordered alphabetically.
  1176. * - "menu_name": Optional. Set this to a custom menu if you don't want your
  1177. * item to be placed in Navigation.
  1178. * - "expanded": Optional. If set to TRUE, and if a menu link is provided for
  1179. * this menu item (as a result of other properties), then the menu link is
  1180. * always expanded, equivalent to its 'always expanded' checkbox being set
  1181. * in the UI.
  1182. * - "context": (optional) Defines the context a tab may appear in. By
  1183. * default, all tabs are only displayed as local tasks when being rendered
  1184. * in a page context. All tabs that should be accessible as contextual links
  1185. * in page region containers outside of the parent menu item's primary page
  1186. * context should be registered using one of the following contexts:
  1187. * - MENU_CONTEXT_PAGE: (default) The tab is displayed as local task for the
  1188. * page context only.
  1189. * - MENU_CONTEXT_INLINE: The tab is displayed as contextual link outside of
  1190. * the primary page context only.
  1191. * Contexts can be combined. For example, to display a tab both on a page
  1192. * and inline, a menu router item may specify:
  1193. * @code
  1194. * 'context' => MENU_CONTEXT_PAGE | MENU_CONTEXT_INLINE,
  1195. * @endcode
  1196. * - "tab_parent": For local task menu items, the path of the task's parent
  1197. * item; defaults to the same path without the last component (e.g., the
  1198. * default parent for 'admin/people/create' is 'admin/people').
  1199. * - "tab_root": For local task menu items, the path of the closest non-tab
  1200. * item; same default as "tab_parent".
  1201. * - "position": Position of the block ('left' or 'right') on the system
  1202. * administration page for this item.
  1203. * - "type": A bitmask of flags describing properties of the menu item.
  1204. * Many shortcut bitmasks are provided as constants in menu.inc:
  1205. * - MENU_NORMAL_ITEM: Normal menu items show up in the menu tree and can be
  1206. * moved/hidden by the administrator.
  1207. * - MENU_CALLBACK: Callbacks simply register a path so that the correct
  1208. * information is generated when the path is accessed.
  1209. * - MENU_SUGGESTED_ITEM: Modules may "suggest" menu items that the
  1210. * administrator may enable.
  1211. * - MENU_LOCAL_ACTION: Local actions are menu items that describe actions
  1212. * on the parent item such as adding a new user or block, and are
  1213. * rendered in the action-links list in your theme.
  1214. * - MENU_LOCAL_TASK: Local tasks are menu items that describe different
  1215. * displays of data, and are generally rendered as tabs.
  1216. * - MENU_DEFAULT_LOCAL_TASK: Every set of local tasks should provide one
  1217. * "default" task, which should display the same page as the parent item.
  1218. * If the "type" element is omitted, MENU_NORMAL_ITEM is assumed.
  1219. * - "options": An array of options to be passed to l() when generating a link
  1220. * from this menu item. Note that the "options" parameter has no effect on
  1221. * MENU_LOCAL_TASK, MENU_DEFAULT_LOCAL_TASK, and MENU_LOCAL_ACTION items.
  1222. *
  1223. * For a detailed usage example, see page_example.module.
  1224. * For comprehensive documentation on the menu system, see
  1225. * http://drupal.org/node/102338.
  1226. */
  1227. function hook_menu() {
  1228. $items['example'] = array(
  1229. 'title' => 'Example Page',
  1230. 'page callback' => 'example_page',
  1231. 'access arguments' => array('access content'),
  1232. 'type' => MENU_SUGGESTED_ITEM,
  1233. );
  1234. $items['example/feed'] = array(
  1235. 'title' => 'Example RSS feed',
  1236. 'page callback' => 'example_feed',
  1237. 'access arguments' => array('access content'),
  1238. 'type' => MENU_CALLBACK,
  1239. );
  1240. return $items;
  1241. }
  1242. /**
  1243. * Alter the data being saved to the {menu_router} table after hook_menu is invoked.
  1244. *
  1245. * This hook is invoked by menu_router_build(). The menu definitions are passed
  1246. * in by reference. Each element of the $items array is one item returned
  1247. * by a module from hook_menu. Additional items may be added, or existing items
  1248. * altered.
  1249. *
  1250. * @param $items
  1251. * Associative array of menu router definitions returned from hook_menu().
  1252. */
  1253. function hook_menu_alter(&$items) {
  1254. // Example - disable the page at node/add
  1255. $items['node/add']['access callback'] = FALSE;
  1256. }
  1257. /**
  1258. * Alter the data being saved to the {menu_links} table by menu_link_save().
  1259. *
  1260. * @param $item
  1261. * Associative array defining a menu link as passed into menu_link_save().
  1262. *
  1263. * @see hook_translated_menu_link_alter()
  1264. */
  1265. function hook_menu_link_alter(&$item) {
  1266. // Make all new admin links hidden (a.k.a disabled).
  1267. if (strpos($item['link_path'], 'admin') === 0 && empty($item['mlid'])) {
  1268. $item['hidden'] = 1;
  1269. }
  1270. // Flag a link to be altered by hook_translated_menu_link_alter().
  1271. if ($item['link_path'] == 'devel/cache/clear') {
  1272. $item['options']['alter'] = TRUE;
  1273. }
  1274. // Flag a link to be altered by hook_translated_menu_link_alter(), but only
  1275. // if it is derived from a menu router item; i.e., do not alter a custom
  1276. // menu link pointing to the same path that has been created by a user.
  1277. if ($item['link_path'] == 'user' && $item['module'] == 'system') {
  1278. $item['options']['alter'] = TRUE;
  1279. }
  1280. }
  1281. /**
  1282. * Alter a menu link after it has been translated and before it is rendered.
  1283. *
  1284. * This hook is invoked from _menu_link_translate() after a menu link has been
  1285. * translated; i.e., after dynamic path argument placeholders (%) have been
  1286. * replaced with actual values, the user access to the link's target page has
  1287. * been checked, and the link has been localized. It is only invoked if
  1288. * $item['options']['alter'] has been set to a non-empty value (e.g., TRUE).
  1289. * This flag should be set using hook_menu_link_alter().
  1290. *
  1291. * Implementations of this hook are able to alter any property of the menu link.
  1292. * For example, this hook may be used to add a page-specific query string to all
  1293. * menu links, or hide a certain link by setting:
  1294. * @code
  1295. * 'hidden' => 1,
  1296. * @endcode
  1297. *
  1298. * @param $item
  1299. * Associative array defining a menu link after _menu_link_translate()
  1300. * @param $map
  1301. * Associative array containing the menu $map (path parts and/or objects).
  1302. *
  1303. * @see hook_menu_link_alter()
  1304. */
  1305. function hook_translated_menu_link_alter(&$item, $map) {
  1306. if ($item['href'] == 'devel/cache/clear') {
  1307. $item['localized_options']['query'] = drupal_get_destination();
  1308. }
  1309. }
  1310. /**
  1311. * Inform modules that a menu link has been created.
  1312. *
  1313. * This hook is used to notify modules that menu items have been
  1314. * created. Contributed modules may use the information to perform
  1315. * actions based on the information entered into the menu system.
  1316. *
  1317. * @param $link
  1318. * Associative array defining a menu link as passed into menu_link_save().
  1319. *
  1320. * @see hook_menu_link_update()
  1321. * @see hook_menu_link_delete()
  1322. */
  1323. function hook_menu_link_insert($link) {
  1324. // In our sample case, we track menu items as editing sections
  1325. // of the site. These are stored in our table as 'disabled' items.
  1326. $record['mlid'] = $link['mlid'];
  1327. $record['menu_name'] = $link['menu_name'];
  1328. $record['status'] = 0;
  1329. drupal_write_record('menu_example', $record);
  1330. }
  1331. /**
  1332. * Inform modules that a menu link has been updated.
  1333. *
  1334. * This hook is used to notify modules that menu items have been
  1335. * updated. Contributed modules may use the information to perform
  1336. * actions based on the information entered into the menu system.
  1337. *
  1338. * @param $link
  1339. * Associative array defining a menu link as passed into menu_link_save().
  1340. *
  1341. * @see hook_menu_link_insert()
  1342. * @see hook_menu_link_delete()
  1343. */
  1344. function hook_menu_link_update($link) {
  1345. // If the parent menu has changed, update our record.
  1346. $menu_name = db_query("SELECT menu_name FROM {menu_example} WHERE mlid = :mlid", array(':mlid' => $link['mlid']))->fetchField();
  1347. if ($menu_name != $link['menu_name']) {
  1348. db_update('menu_example')
  1349. ->fields(array('menu_name' => $link['menu_name']))
  1350. ->condition('mlid', $link['mlid'])
  1351. ->execute();
  1352. }
  1353. }
  1354. /**
  1355. * Inform modules that a menu link has been deleted.
  1356. *
  1357. * This hook is used to notify modules that menu items have been
  1358. * deleted. Contributed modules may use the information to perform
  1359. * actions based on the information entered into the menu system.
  1360. *
  1361. * @param $link
  1362. * Associative array defining a menu link as passed into menu_link_save().
  1363. *
  1364. * @see hook_menu_link_insert()
  1365. * @see hook_menu_link_update()
  1366. */
  1367. function hook_menu_link_delete($link) {
  1368. // Delete the record from our table.
  1369. db_delete('menu_example')
  1370. ->condition('mlid', $link['mlid'])
  1371. ->execute();
  1372. }
  1373. /**
  1374. * Alter tabs and actions displayed on the page before they are rendered.
  1375. *
  1376. * This hook is invoked by menu_local_tasks(). The system-determined tabs and
  1377. * actions are passed in by reference. Additional tabs or actions may be added,
  1378. * or existing items altered.
  1379. *
  1380. * Each tab or action is an associative array containing:
  1381. * - #theme: The theme function to use to render.
  1382. * - #link: An associative array containing:
  1383. * - title: The localized title of the link.
  1384. * - href: The system path to link to.
  1385. * - localized_options: An array of options to pass to l().
  1386. * - #active: Whether the link should be marked as 'active'.
  1387. *
  1388. * @param $data
  1389. * An associative array containing:
  1390. * - actions: An associative array containing:
  1391. * - count: The amount of actions determined by the menu system, which can
  1392. * be ignored.
  1393. * - output: A list of of actions, each one being an associative array
  1394. * as described above.
  1395. * - tabs: An indexed array (list) of tab levels (up to 2 levels), each
  1396. * containing an associative array:
  1397. * - count: The amount of tabs determined by the menu system. This value
  1398. * does not need to be altered if there is more than one tab.
  1399. * - output: A list of of tabs, each one being an associative array as
  1400. * described above.
  1401. * @param $router_item
  1402. * The menu system router item of the page.
  1403. * @param $root_path
  1404. * The path to the root item for this set of tabs.
  1405. */
  1406. function hook_menu_local_tasks_alter(&$data, $router_item, $root_path) {
  1407. // Add an action linking to node/add to all pages.
  1408. $data['actions']['output'][] = array(
  1409. '#theme' => 'menu_local_task',
  1410. '#link' => array(
  1411. 'title' => t('Add new content'),
  1412. 'href' => 'node/add',
  1413. 'localized_options' => array(
  1414. 'attributes' => array(
  1415. 'title' => t('Add new content'),
  1416. ),
  1417. ),
  1418. ),
  1419. );
  1420. // Add a tab linking to node/add to all pages.
  1421. $data['tabs'][0]['output'][] = array(
  1422. '#theme' => 'menu_local_task',
  1423. '#link' => array(
  1424. 'title' => t('Example tab'),
  1425. 'href' => 'node/add',
  1426. 'localized_options' => array(
  1427. 'attributes' => array(
  1428. 'title' => t('Add new content'),
  1429. ),
  1430. ),
  1431. ),
  1432. // Define whether this link is active. This can be omitted for
  1433. // implementations that add links to pages outside of the current page
  1434. // context.
  1435. '#active' => ($router_item['path'] == $root_path),
  1436. );
  1437. }
  1438. /**
  1439. * Alter links in the active trail before it is rendered as the breadcrumb.
  1440. *
  1441. * This hook is invoked by menu_get_active_breadcrumb() and allows alteration
  1442. * of the breadcrumb links for the current page, which may be preferred instead
  1443. * of setting a custom breadcrumb via drupal_set_breadcrumb().
  1444. *
  1445. * Implementations should take into account that menu_get_active_breadcrumb()
  1446. * subsequently performs the following adjustments to the active trail *after*
  1447. * this hook has been invoked:
  1448. * - The last link in $active_trail is removed, if its 'href' is identical to
  1449. * the 'href' of $item. This happens, because the breadcrumb normally does
  1450. * not contain a link to the current page.
  1451. * - The (second to) last link in $active_trail is removed, if the current $item
  1452. * is a MENU_DEFAULT_LOCAL_TASK. This happens in order to do not show a link
  1453. * to the current page, when being on the path for the default local task;
  1454. * e.g. when being on the path node/%/view, the breadcrumb should not contain
  1455. * a link to node/%.
  1456. *
  1457. * Each link in the active trail must contain:
  1458. * - title: The localized title of the link.
  1459. * - href: The system path to link to.
  1460. * - localized_options: An array of options to pass to url().
  1461. *
  1462. * @param $active_trail
  1463. * An array containing breadcrumb links for the current page.
  1464. * @param $item
  1465. * The menu router item of the current page.
  1466. *
  1467. * @see drupal_set_breadcrumb()
  1468. * @see menu_get_active_breadcrumb()
  1469. * @see menu_get_active_trail()
  1470. * @see menu_set_active_trail()
  1471. */
  1472. function hook_menu_breadcrumb_alter(&$active_trail, $item) {
  1473. // Always display a link to the current page by duplicating the last link in
  1474. // the active trail. This means that menu_get_active_breadcrumb() will remove
  1475. // the last link (for the current page), but since it is added once more here,
  1476. // it will appear.
  1477. if (!drupal_is_front_page()) {
  1478. $end = end($active_trail);
  1479. if ($item['href'] == $end['href']) {
  1480. $active_trail[] = $end;
  1481. }
  1482. }
  1483. }
  1484. /**
  1485. * Alter contextual links before they are rendered.
  1486. *
  1487. * This hook is invoked by menu_contextual_links(). The system-determined
  1488. * contextual links are passed in by reference. Additional links may be added
  1489. * or existing links can be altered.
  1490. *
  1491. * Each contextual link must at least contain:
  1492. * - title: The localized title of the link.
  1493. * - href: The system path to link to.
  1494. * - localized_options: An array of options to pass to url().
  1495. *
  1496. * @param $links
  1497. * An associative array containing contextual links for the given $root_path,
  1498. * as described above. The array keys are used to build CSS class names for
  1499. * contextual links and must therefore be unique for each set of contextual
  1500. * links.
  1501. * @param $router_item
  1502. * The menu router item belonging to the $root_path being requested.
  1503. * @param $root_path
  1504. * The (parent) path that has been requested to build contextual links for.
  1505. * This is a normalized path, which means that an originally passed path of
  1506. * 'node/123' became 'node/%'.
  1507. *
  1508. * @see hook_contextual_links_view_alter()
  1509. * @see menu_contextual_links()
  1510. * @see hook_menu()
  1511. * @see contextual_preprocess()
  1512. */
  1513. function hook_menu_contextual_links_alter(&$links, $router_item, $root_path) {
  1514. // Add a link to all contextual links for nodes.
  1515. if ($root_path == 'node/%') {
  1516. $links['foo'] = array(
  1517. 'title' => t('Do fu'),
  1518. 'href' => 'foo/do',
  1519. 'localized_options' => array(
  1520. 'query' => array(
  1521. 'foo' => 'bar',
  1522. ),
  1523. ),
  1524. );
  1525. }
  1526. }
  1527. /**
  1528. * Perform alterations before a page is rendered.
  1529. *
  1530. * Use this hook when you want to remove or alter elements at the page
  1531. * level, or add elements at the page level that depend on an other module's
  1532. * elements (this hook runs after hook_page_build().
  1533. *
  1534. * If you are making changes to entities such as forms, menus, or user
  1535. * profiles, use those objects' native alter hooks instead (hook_form_alter(),
  1536. * for example).
  1537. *
  1538. * The $page array contains top level elements for each block region:
  1539. * @code
  1540. * $page['page_top']
  1541. * $page['header']
  1542. * $page['sidebar_first']
  1543. * $page['content']
  1544. * $page['sidebar_second']
  1545. * $page['page_bottom']
  1546. * @endcode
  1547. *
  1548. * The 'content' element contains the main content of the current page, and its
  1549. * structure will vary depending on what module is responsible for building the
  1550. * page. Some legacy modules may not return structured content at all: their
  1551. * pre-rendered markup will be located in $page['content']['main']['#markup'].
  1552. *
  1553. * Pages built by Drupal's core Node and Blog modules use a standard structure:
  1554. *
  1555. * @code
  1556. * // Node body.
  1557. * $page['content']['system_main']['nodes'][$nid]['body']
  1558. * // Array of links attached to the node (add comments, read more).
  1559. * $page['content']['system_main']['nodes'][$nid]['links']
  1560. * // The node object itself.
  1561. * $page['content']['system_main']['nodes'][$nid]['#node']
  1562. * // The results pager.
  1563. * $page['content']['system_main']['pager']
  1564. * @endcode
  1565. *
  1566. * Blocks may be referenced by their module/delta pair within a region:
  1567. * @code
  1568. * // The login block in the first sidebar region.
  1569. * $page['sidebar_first']['user_login']['#block'];
  1570. * @endcode
  1571. *
  1572. * @param $page
  1573. * Nested array of renderable elements that make up the page.
  1574. *
  1575. * @see hook_page_build()
  1576. * @see drupal_render_page()
  1577. */
  1578. function hook_page_alter(&$page) {
  1579. // Add help text to the user login block.
  1580. $page['sidebar_first']['user_login']['help'] = array(
  1581. '#weight' => -10,
  1582. '#markup' => t('To post comments or add new content, you first have to log in.'),
  1583. );
  1584. }
  1585. /**
  1586. * Perform alterations before a form is rendered.
  1587. *
  1588. * One popular use of this hook is to add form elements to the node form. When
  1589. * altering a node form, the node object can be accessed at $form['#node'].
  1590. *
  1591. * In addition to hook_form_alter(), which is called for all forms, there are
  1592. * two more specific form hooks available. The first,
  1593. * hook_form_BASE_FORM_ID_alter(), allows targeting of a form/forms via a base
  1594. * form (if one exists). The second, hook_form_FORM_ID_alter(), can be used to
  1595. * target a specific form directly.
  1596. *
  1597. * The call order is as follows: all existing form alter functions are called
  1598. * for module A, then all for module B, etc., followed by all for any base
  1599. * theme(s), and finally for the theme itself. The module order is determined
  1600. * by system weight, then by module name.
  1601. *
  1602. * Within each module, form alter hooks are called in the following order:
  1603. * first, hook_form_alter(); second, hook_form_BASE_FORM_ID_alter(); third,
  1604. * hook_form_FORM_ID_alter(). So, for each module, the more general hooks are
  1605. * called first followed by the more specific.
  1606. *
  1607. * @param $form
  1608. * Nested array of form elements that comprise the form.
  1609. * @param $form_state
  1610. * A keyed array containing the current state of the form. The arguments
  1611. * that drupal_get_form() was originally called with are available in the
  1612. * array $form_state['build_info']['args'].
  1613. * @param $form_id
  1614. * String representing the name of the form itself. Typically this is the
  1615. * name of the function that generated the form.
  1616. *
  1617. * @see hook_form_BASE_FORM_ID_alter()
  1618. * @see hook_form_FORM_ID_alter()
  1619. * @see forms_api_reference.html
  1620. */
  1621. function hook_form_alter(&$form, &$form_state, $form_id) {
  1622. if (isset($form['type']) && $form['type']['#value'] . '_node_settings' == $form_id) {
  1623. $form['workflow']['upload_' . $form['type']['#value']] = array(
  1624. '#type' => 'radios',
  1625. '#title' => t('Attachments'),
  1626. '#default_value' => variable_get('upload_' . $form['type']['#value'], 1),
  1627. '#options' => array(t('Disabled'), t('Enabled')),
  1628. );
  1629. }
  1630. }
  1631. /**
  1632. * Provide a form-specific alteration instead of the global hook_form_alter().
  1633. *
  1634. * Modules can implement hook_form_FORM_ID_alter() to modify a specific form,
  1635. * rather than implementing hook_form_alter() and checking the form ID, or
  1636. * using long switch statements to alter multiple forms.
  1637. *
  1638. * Form alter hooks are called in the following order: hook_form_alter(),
  1639. * hook_form_BASE_FORM_ID_alter(), hook_form_FORM_ID_alter(). See
  1640. * hook_form_alter() for more details.
  1641. *
  1642. * @param $form
  1643. * Nested array of form elements that comprise the form.
  1644. * @param $form_state
  1645. * A keyed array containing the current state of the form. The arguments
  1646. * that drupal_get_form() was originally called with are available in the
  1647. * array $form_state['build_info']['args'].
  1648. * @param $form_id
  1649. * String representing the name of the form itself. Typically this is the
  1650. * name of the function that generated the form.
  1651. *
  1652. * @see hook_form_alter()
  1653. * @see hook_form_BASE_FORM_ID_alter()
  1654. * @see drupal_prepare_form()
  1655. * @see forms_api_reference.html
  1656. */
  1657. function hook_form_FORM_ID_alter(&$form, &$form_state, $form_id) {
  1658. // Modification for the form with the given form ID goes here. For example, if
  1659. // FORM_ID is "user_register_form" this code would run only on the user
  1660. // registration form.
  1661. // Add a checkbox to registration form about agreeing to terms of use.
  1662. $form['terms_of_use'] = array(
  1663. '#type' => 'checkbox',
  1664. '#title' => t("I agree with the website's terms and conditions."),
  1665. '#required' => TRUE,
  1666. );
  1667. }
  1668. /**
  1669. * Provide a form-specific alteration for shared ('base') forms.
  1670. *
  1671. * By default, when drupal_get_form() is called, Drupal looks for a function
  1672. * with the same name as the form ID, and uses that function to build the form.
  1673. * In contrast, base forms allow multiple form IDs to be mapped to a single base
  1674. * (also called 'factory') form function.
  1675. *
  1676. * Modules can implement hook_form_BASE_FORM_ID_alter() to modify a specific
  1677. * base form, rather than implementing hook_form_alter() and checking for
  1678. * conditions that would identify the shared form constructor.
  1679. *
  1680. * To identify the base form ID for a particular form (or to determine whether
  1681. * one exists) check the $form_state. The base form ID is stored under
  1682. * $form_state['build_info']['base_form_id'].
  1683. *
  1684. * See hook_forms() for more information on how to implement base forms in
  1685. * Drupal.
  1686. *
  1687. * Form alter hooks are called in the following order: hook_form_alter(),
  1688. * hook_form_BASE_FORM_ID_alter(), hook_form_FORM_ID_alter(). See
  1689. * hook_form_alter() for more details.
  1690. *
  1691. * @param $form
  1692. * Nested array of form elements that comprise the form.
  1693. * @param $form_state
  1694. * A keyed array containing the current state of the form.
  1695. * @param $form_id
  1696. * String representing the name of the form itself. Typically this is the
  1697. * name of the function that generated the form.
  1698. *
  1699. * @see hook_form_alter()
  1700. * @see hook_form_FORM_ID_alter()
  1701. * @see drupal_prepare_form()
  1702. * @see hook_forms()
  1703. */
  1704. function hook_form_BASE_FORM_ID_alter(&$form, &$form_state, $form_id) {
  1705. // Modification for the form with the given BASE_FORM_ID goes here. For
  1706. // example, if BASE_FORM_ID is "node_form", this code would run on every
  1707. // node form, regardless of node type.
  1708. // Add a checkbox to the node form about agreeing to terms of use.
  1709. $form['terms_of_use'] = array(
  1710. '#type' => 'checkbox',
  1711. '#title' => t("I agree with the website's terms and conditions."),
  1712. '#required' => TRUE,
  1713. );
  1714. }
  1715. /**
  1716. * Map form_ids to form builder functions.
  1717. *
  1718. * By default, when drupal_get_form() is called, the system will look for a
  1719. * function with the same name as the form ID, and use that function to build
  1720. * the form. If no such function is found, Drupal calls this hook. Modules
  1721. * implementing this hook can then provide their own instructions for mapping
  1722. * form IDs to constructor functions. As a result, you can easily map multiple
  1723. * form IDs to a single form constructor (referred to as a 'base' form).
  1724. *
  1725. * Using a base form can help to avoid code duplication, by allowing many
  1726. * similar forms to use the same code base. Another benefit is that it becomes
  1727. * much easier for other modules to apply a general change to the group of
  1728. * forms; hook_form_BASE_FORM_ID_alter() can be used to easily alter multiple
  1729. * forms at once by directly targeting the shared base form.
  1730. *
  1731. * Two example use cases where base forms may be useful are given below.
  1732. *
  1733. * First, you can use this hook to tell the form system to use a different
  1734. * function to build certain forms in your module; this is often used to define
  1735. * a form "factory" function that is used to build several similar forms. In
  1736. * this case, your hook implementation will likely ignore all of the input
  1737. * arguments. See node_forms() for an example of this. Note, node_forms() is the
  1738. * hook_forms() implementation; the base form itself is defined in node_form().
  1739. *
  1740. * Second, you could use this hook to define how to build a form with a
  1741. * dynamically-generated form ID. In this case, you would need to verify that
  1742. * the $form_id input matched your module's format for dynamically-generated
  1743. * form IDs, and if so, act appropriately.
  1744. *
  1745. * @param $form_id
  1746. * The unique string identifying the desired form.
  1747. * @param $args
  1748. * An array containing the original arguments provided to drupal_get_form()
  1749. * or drupal_form_submit(). These are always passed to the form builder and
  1750. * do not have to be specified manually in 'callback arguments'.
  1751. *
  1752. * @return
  1753. * An associative array whose keys define form_ids and whose values are an
  1754. * associative array defining the following keys:
  1755. * - callback: The name of the form builder function to invoke. This will be
  1756. * used for the base form ID, for example, to target a base form using
  1757. * hook_form_BASE_FORM_ID_alter().
  1758. * - callback arguments: (optional) Additional arguments to pass to the
  1759. * function defined in 'callback', which are prepended to $args.
  1760. * - wrapper_callback: (optional) The name of a form builder function to
  1761. * invoke before the form builder defined in 'callback' is invoked. This
  1762. * wrapper callback may prepopulate the $form array with form elements,
  1763. * which will then be already contained in the $form that is passed on to
  1764. * the form builder defined in 'callback'. For example, a wrapper callback
  1765. * could setup wizard-alike form buttons that are the same for a variety of
  1766. * forms that belong to the wizard, which all share the same wrapper
  1767. * callback.
  1768. */
  1769. function hook_forms($form_id, $args) {
  1770. // Simply reroute the (non-existing) $form_id 'mymodule_first_form' to
  1771. // 'mymodule_main_form'.
  1772. $forms['mymodule_first_form'] = array(
  1773. 'callback' => 'mymodule_main_form',
  1774. );
  1775. // Reroute the $form_id and prepend an additional argument that gets passed to
  1776. // the 'mymodule_main_form' form builder function.
  1777. $forms['mymodule_second_form'] = array(
  1778. 'callback' => 'mymodule_main_form',
  1779. 'callback arguments' => array('some parameter'),
  1780. );
  1781. // Reroute the $form_id, but invoke the form builder function
  1782. // 'mymodule_main_form_wrapper' first, so we can prepopulate the $form array
  1783. // that is passed to the actual form builder 'mymodule_main_form'.
  1784. $forms['mymodule_wrapped_form'] = array(
  1785. 'callback' => 'mymodule_main_form',
  1786. 'wrapper_callback' => 'mymodule_main_form_wrapper',
  1787. );
  1788. return $forms;
  1789. }
  1790. /**
  1791. * Perform setup tasks for all page requests.
  1792. *
  1793. * This hook is run at the beginning of the page request. It is typically
  1794. * used to set up global parameters that are needed later in the request.
  1795. *
  1796. * Only use this hook if your code must run even for cached page views. This
  1797. * hook is called before the theme, modules, or most include files are loaded
  1798. * into memory. It happens while Drupal is still in bootstrap mode.
  1799. *
  1800. * @see hook_init()
  1801. */
  1802. function hook_boot() {
  1803. // We need user_access() in the shutdown function. Make sure it gets loaded.
  1804. drupal_load('module', 'user');
  1805. drupal_register_shutdown_function('devel_shutdown');
  1806. }
  1807. /**
  1808. * Perform setup tasks for non-cached page requests.
  1809. *
  1810. * This hook is run at the beginning of the page request. It is typically
  1811. * used to set up global parameters that are needed later in the request.
  1812. * When this hook is called, the theme and all modules are already loaded in
  1813. * memory.
  1814. *
  1815. * This hook is not run on cached pages.
  1816. *
  1817. * To add CSS or JS that should be present on all pages, modules should not
  1818. * implement this hook, but declare these files in their .info file.
  1819. *
  1820. * @see hook_boot()
  1821. */
  1822. function hook_init() {
  1823. // Since this file should only be loaded on the front page, it cannot be
  1824. // declared in the info file.
  1825. if (drupal_is_front_page()) {
  1826. drupal_add_css(drupal_get_path('module', 'foo') . '/foo.css');
  1827. }
  1828. }
  1829. /**
  1830. * Define image toolkits provided by this module.
  1831. *
  1832. * The file which includes each toolkit's functions must be declared as part of
  1833. * the files array in the module .info file so that the registry will find and
  1834. * parse it.
  1835. *
  1836. * The toolkit's functions must be named image_toolkitname_operation().
  1837. * where the operation may be:
  1838. * - 'load': Required. See image_gd_load() for usage.
  1839. * - 'save': Required. See image_gd_save() for usage.
  1840. * - 'settings': Optional. See image_gd_settings() for usage.
  1841. * - 'resize': Optional. See image_gd_resize() for usage.
  1842. * - 'rotate': Optional. See image_gd_rotate() for usage.
  1843. * - 'crop': Optional. See image_gd_crop() for usage.
  1844. * - 'desaturate': Optional. See image_gd_desaturate() for usage.
  1845. *
  1846. * @return
  1847. * An array with the toolkit name as keys and sub-arrays with these keys:
  1848. * - 'title': A string with the toolkit's title.
  1849. * - 'available': A Boolean value to indicate that the toolkit is operating
  1850. * properly, e.g. all required libraries exist.
  1851. *
  1852. * @see system_image_toolkits()
  1853. */
  1854. function hook_image_toolkits() {
  1855. return array(
  1856. 'working' => array(
  1857. 'title' => t('A toolkit that works.'),
  1858. 'available' => TRUE,
  1859. ),
  1860. 'broken' => array(
  1861. 'title' => t('A toolkit that is "broken" and will not be listed.'),
  1862. 'available' => FALSE,
  1863. ),
  1864. );
  1865. }
  1866. /**
  1867. * Alter an email message created with the drupal_mail() function.
  1868. *
  1869. * hook_mail_alter() allows modification of email messages created and sent
  1870. * with drupal_mail(). Usage examples include adding and/or changing message
  1871. * text, message fields, and message headers.
  1872. *
  1873. * Email messages sent using functions other than drupal_mail() will not
  1874. * invoke hook_mail_alter(). For example, a contributed module directly
  1875. * calling the drupal_mail_system()->mail() or PHP mail() function
  1876. * will not invoke this hook. All core modules use drupal_mail() for
  1877. * messaging, it is best practice but not mandatory in contributed modules.
  1878. *
  1879. * @param $message
  1880. * An array containing the message data. Keys in this array include:
  1881. * - 'id':
  1882. * The drupal_mail() id of the message. Look at module source code or
  1883. * drupal_mail() for possible id values.
  1884. * - 'to':
  1885. * The address or addresses the message will be sent to. The formatting of
  1886. * this string will be validated with the
  1887. * @link http://php.net/manual/filter.filters.validate.php PHP e-mail validation filter. @endlink
  1888. * - 'from':
  1889. * The address the message will be marked as being from, which is
  1890. * either a custom address or the site-wide default email address.
  1891. * - 'subject':
  1892. * Subject of the email to be sent. This must not contain any newline
  1893. * characters, or the email may not be sent properly.
  1894. * - 'body':
  1895. * An array of strings containing the message text. The message body is
  1896. * created by concatenating the individual array strings into a single text
  1897. * string using "\n\n" as a separator.
  1898. * - 'headers':
  1899. * Associative array containing mail headers, such as From, Sender,
  1900. * MIME-Version, Content-Type, etc.
  1901. * - 'params':
  1902. * An array of optional parameters supplied by the caller of drupal_mail()
  1903. * that is used to build the message before hook_mail_alter() is invoked.
  1904. * - 'language':
  1905. * The language object used to build the message before hook_mail_alter()
  1906. * is invoked.
  1907. * - 'send':
  1908. * Set to FALSE to abort sending this email message.
  1909. *
  1910. * @see drupal_mail()
  1911. */
  1912. function hook_mail_alter(&$message) {
  1913. if ($message['id'] == 'modulename_messagekey') {
  1914. if (!example_notifications_optin($message['to'], $message['id'])) {
  1915. // If the recipient has opted to not receive such messages, cancel
  1916. // sending.
  1917. $message['send'] = FALSE;
  1918. return;
  1919. }
  1920. $message['body'][] = "--\nMail sent out from " . variable_get('site_name', t('Drupal'));
  1921. }
  1922. }
  1923. /**
  1924. * Alter the registry of modules implementing a hook.
  1925. *
  1926. * This hook is invoked during module_implements(). A module may implement this
  1927. * hook in order to reorder the implementing modules, which are otherwise
  1928. * ordered by the module's system weight.
  1929. *
  1930. * Note that hooks invoked using drupal_alter() can have multiple variations
  1931. * (such as hook_form_alter() and hook_form_FORM_ID_alter()). drupal_alter()
  1932. * will call all such variants defined by a single module in turn. For the
  1933. * purposes of hook_module_implements_alter(), these variants are treated as
  1934. * a single hook. Thus, to ensure that your implementation of
  1935. * hook_form_FORM_ID_alter() is called at the right time, you will have to
  1936. * change the order of hook_form_alter() implementation in
  1937. * hook_module_implements_alter().
  1938. *
  1939. * @param $implementations
  1940. * An array keyed by the module's name. The value of each item corresponds
  1941. * to a $group, which is usually FALSE, unless the implementation is in a
  1942. * file named $module.$group.inc.
  1943. * @param $hook
  1944. * The name of the module hook being implemented.
  1945. */
  1946. function hook_module_implements_alter(&$implementations, $hook) {
  1947. if ($hook == 'rdf_mapping') {
  1948. // Move my_module_rdf_mapping() to the end of the list. module_implements()
  1949. // iterates through $implementations with a foreach loop which PHP iterates
  1950. // in the order that the items were added, so to move an item to the end of
  1951. // the array, we remove it and then add it.
  1952. $group = $implementations['my_module'];
  1953. unset($implementations['my_module']);
  1954. $implementations['my_module'] = $group;
  1955. }
  1956. }
  1957. /**
  1958. * Return additional themes provided by modules.
  1959. *
  1960. * Only use this hook for testing purposes. Use a hidden MYMODULE_test.module
  1961. * to implement this hook. Testing themes should be hidden, too.
  1962. *
  1963. * This hook is invoked from _system_rebuild_theme_data() and allows modules to
  1964. * register additional themes outside of the regular 'themes' directories of a
  1965. * Drupal installation.
  1966. *
  1967. * @return
  1968. * An associative array. Each key is the system name of a theme and each value
  1969. * is the corresponding path to the theme's .info file.
  1970. */
  1971. function hook_system_theme_info() {
  1972. $themes['mymodule_test_theme'] = drupal_get_path('module', 'mymodule') . '/mymodule_test_theme/mymodule_test_theme.info';
  1973. return $themes;
  1974. }
  1975. /**
  1976. * Alter the information parsed from module and theme .info files
  1977. *
  1978. * This hook is invoked in _system_rebuild_module_data() and in
  1979. * _system_rebuild_theme_data(). A module may implement this hook in order to
  1980. * add to or alter the data generated by reading the .info file with
  1981. * drupal_parse_info_file().
  1982. *
  1983. * @param $info
  1984. * The .info file contents, passed by reference so that it can be altered.
  1985. * @param $file
  1986. * Full information about the module or theme, including $file->name, and
  1987. * $file->filename
  1988. * @param $type
  1989. * Either 'module' or 'theme', depending on the type of .info file that was
  1990. * passed.
  1991. */
  1992. function hook_system_info_alter(&$info, $file, $type) {
  1993. // Only fill this in if the .info file does not define a 'datestamp'.
  1994. if (empty($info['datestamp'])) {
  1995. $info['datestamp'] = filemtime($file->filename);
  1996. }
  1997. }
  1998. /**
  1999. * Define user permissions.
  2000. *
  2001. * This hook can supply permissions that the module defines, so that they
  2002. * can be selected on the user permissions page and used to grant or restrict
  2003. * access to actions the module performs.
  2004. *
  2005. * Permissions are checked using user_access().
  2006. *
  2007. * For a detailed usage example, see page_example.module.
  2008. *
  2009. * @return
  2010. * An array whose keys are permission names and whose corresponding values
  2011. * are arrays containing the following key-value pairs:
  2012. * - title: The human-readable name of the permission, to be shown on the
  2013. * permission administration page. This should be wrapped in the t()
  2014. * function so it can be translated.
  2015. * - description: (optional) A description of what the permission does. This
  2016. * should be wrapped in the t() function so it can be translated.
  2017. * - restrict access: (optional) A boolean which can be set to TRUE to
  2018. * indicate that site administrators should restrict access to this
  2019. * permission to trusted users. This should be used for permissions that
  2020. * have inherent security risks across a variety of potential use cases
  2021. * (for example, the "administer filters" and "bypass node access"
  2022. * permissions provided by Drupal core). When set to TRUE, a standard
  2023. * warning message defined in user_admin_permissions() and output via
  2024. * theme_user_permission_description() will be associated with the
  2025. * permission and displayed with it on the permission administration page.
  2026. * Defaults to FALSE.
  2027. * - warning: (optional) A translated warning message to display for this
  2028. * permission on the permission administration page. This warning overrides
  2029. * the automatic warning generated by 'restrict access' being set to TRUE.
  2030. * This should rarely be used, since it is important for all permissions to
  2031. * have a clear, consistent security warning that is the same across the
  2032. * site. Use the 'description' key instead to provide any information that
  2033. * is specific to the permission you are defining.
  2034. *
  2035. * @see theme_user_permission_description()
  2036. */
  2037. function hook_permission() {
  2038. return array(
  2039. 'administer my module' => array(
  2040. 'title' => t('Administer my module'),
  2041. 'description' => t('Perform administration tasks for my module.'),
  2042. ),
  2043. );
  2044. }
  2045. /**
  2046. * Register a module (or theme's) theme implementations.
  2047. *
  2048. * The implementations declared by this hook have two purposes: either they
  2049. * specify how a particular render array is to be rendered as HTML (this is
  2050. * usually the case if the theme function is assigned to the render array's
  2051. * #theme property), or they return the HTML that should be returned by an
  2052. * invocation of theme(). See
  2053. * @link http://drupal.org/node/933976 Using the theme layer Drupal 7.x @endlink
  2054. * for more information on how to implement theme hooks.
  2055. *
  2056. * The following parameters are all optional.
  2057. *
  2058. * @param array $existing
  2059. * An array of existing implementations that may be used for override
  2060. * purposes. This is primarily useful for themes that may wish to examine
  2061. * existing implementations to extract data (such as arguments) so that
  2062. * it may properly register its own, higher priority implementations.
  2063. * @param $type
  2064. * Whether a theme, module, etc. is being processed. This is primarily useful
  2065. * so that themes tell if they are the actual theme being called or a parent
  2066. * theme. May be one of:
  2067. * - 'module': A module is being checked for theme implementations.
  2068. * - 'base_theme_engine': A theme engine is being checked for a theme that is
  2069. * a parent of the actual theme being used.
  2070. * - 'theme_engine': A theme engine is being checked for the actual theme
  2071. * being used.
  2072. * - 'base_theme': A base theme is being checked for theme implementations.
  2073. * - 'theme': The actual theme in use is being checked.
  2074. * @param $theme
  2075. * The actual name of theme, module, etc. that is being being processed.
  2076. * @param $path
  2077. * The directory path of the theme or module, so that it doesn't need to be
  2078. * looked up.
  2079. *
  2080. * @return array
  2081. * An associative array of theme hook information. The keys on the outer
  2082. * array are the internal names of the hooks, and the values are arrays
  2083. * containing information about the hook. Each information array must contain
  2084. * either a 'variables' element or a 'render element' element, but not both.
  2085. * Use 'render element' if you are theming a single element or element tree
  2086. * composed of elements, such as a form array, a page array, or a single
  2087. * checkbox element. Use 'variables' if your theme implementation is
  2088. * intended to be called directly through theme() and has multiple arguments
  2089. * for the data and style; in this case, the variables not supplied by the
  2090. * calling function will be given default values and passed to the template
  2091. * or theme function. The returned theme information array can contain the
  2092. * following key/value pairs:
  2093. * - variables: (see above) Each array key is the name of the variable, and
  2094. * the value given is used as the default value if the function calling
  2095. * theme() does not supply it. Template implementations receive each array
  2096. * key as a variable in the template file (so they must be legal PHP
  2097. * variable names). Function implementations are passed the variables in a
  2098. * single $variables function argument.
  2099. * - render element: (see above) The name of the renderable element or element
  2100. * tree to pass to the theme function. This name is used as the name of the
  2101. * variable that holds the renderable element or tree in preprocess and
  2102. * process functions.
  2103. * - file: The file the implementation resides in. This file will be included
  2104. * prior to the theme being rendered, to make sure that the function or
  2105. * preprocess function (as needed) is actually loaded; this makes it
  2106. * possible to split theme functions out into separate files quite easily.
  2107. * - path: Override the path of the file to be used. Ordinarily the module or
  2108. * theme path will be used, but if the file will not be in the default
  2109. * path, include it here. This path should be relative to the Drupal root
  2110. * directory.
  2111. * - template: If specified, this theme implementation is a template, and
  2112. * this is the template file without an extension. Do not put .tpl.php on
  2113. * this file; that extension will be added automatically by the default
  2114. * rendering engine (which is PHPTemplate). If 'path', above, is specified,
  2115. * the template should also be in this path.
  2116. * - function: If specified, this will be the function name to invoke for
  2117. * this implementation. If neither 'template' nor 'function' is specified,
  2118. * a default function name will be assumed. For example, if a module
  2119. * registers the 'node' theme hook, 'theme_node' will be assigned to its
  2120. * function. If the chameleon theme registers the node hook, it will be
  2121. * assigned 'chameleon_node' as its function.
  2122. * - base hook: A string declaring the base theme hook if this theme
  2123. * implementation is actually implementing a suggestion for another theme
  2124. * hook.
  2125. * - pattern: A regular expression pattern to be used to allow this theme
  2126. * implementation to have a dynamic name. The convention is to use __ to
  2127. * differentiate the dynamic portion of the theme. For example, to allow
  2128. * forums to be themed individually, the pattern might be: 'forum__'. Then,
  2129. * when the forum is themed, call:
  2130. * @code
  2131. * theme(array('forum__' . $tid, 'forum'), $forum)
  2132. * @endcode
  2133. * - preprocess functions: A list of functions used to preprocess this data.
  2134. * Ordinarily this won't be used; it's automatically filled in. By default,
  2135. * for a module this will be filled in as template_preprocess_HOOK. For
  2136. * a theme this will be filled in as phptemplate_preprocess and
  2137. * phptemplate_preprocess_HOOK as well as themename_preprocess and
  2138. * themename_preprocess_HOOK.
  2139. * - override preprocess functions: Set to TRUE when a theme does NOT want
  2140. * the standard preprocess functions to run. This can be used to give a
  2141. * theme FULL control over how variables are set. For example, if a theme
  2142. * wants total control over how certain variables in the page.tpl.php are
  2143. * set, this can be set to true. Please keep in mind that when this is used
  2144. * by a theme, that theme becomes responsible for making sure necessary
  2145. * variables are set.
  2146. * - type: (automatically derived) Where the theme hook is defined:
  2147. * 'module', 'theme_engine', or 'theme'.
  2148. * - theme path: (automatically derived) The directory path of the theme or
  2149. * module, so that it doesn't need to be looked up.
  2150. *
  2151. * @see hook_theme_registry_alter()
  2152. */
  2153. function hook_theme($existing, $type, $theme, $path) {
  2154. return array(
  2155. 'forum_display' => array(
  2156. 'variables' => array('forums' => NULL, 'topics' => NULL, 'parents' => NULL, 'tid' => NULL, 'sortby' => NULL, 'forum_per_page' => NULL),
  2157. ),
  2158. 'forum_list' => array(
  2159. 'variables' => array('forums' => NULL, 'parents' => NULL, 'tid' => NULL),
  2160. ),
  2161. 'forum_topic_list' => array(
  2162. 'variables' => array('tid' => NULL, 'topics' => NULL, 'sortby' => NULL, 'forum_per_page' => NULL),
  2163. ),
  2164. 'forum_icon' => array(
  2165. 'variables' => array('new_posts' => NULL, 'num_posts' => 0, 'comment_mode' => 0, 'sticky' => 0),
  2166. ),
  2167. 'status_report' => array(
  2168. 'render element' => 'requirements',
  2169. 'file' => 'system.admin.inc',
  2170. ),
  2171. 'system_date_time_settings' => array(
  2172. 'render element' => 'form',
  2173. 'file' => 'system.admin.inc',
  2174. ),
  2175. );
  2176. }
  2177. /**
  2178. * Alter the theme registry information returned from hook_theme().
  2179. *
  2180. * The theme registry stores information about all available theme hooks,
  2181. * including which callback functions those hooks will call when triggered,
  2182. * what template files are exposed by these hooks, and so on.
  2183. *
  2184. * Note that this hook is only executed as the theme cache is re-built.
  2185. * Changes here will not be visible until the next cache clear.
  2186. *
  2187. * The $theme_registry array is keyed by theme hook name, and contains the
  2188. * information returned from hook_theme(), as well as additional properties
  2189. * added by _theme_process_registry().
  2190. *
  2191. * For example:
  2192. * @code
  2193. * $theme_registry['user_profile'] = array(
  2194. * 'variables' => array(
  2195. * 'account' => NULL,
  2196. * ),
  2197. * 'template' => 'modules/user/user-profile',
  2198. * 'file' => 'modules/user/user.pages.inc',
  2199. * 'type' => 'module',
  2200. * 'theme path' => 'modules/user',
  2201. * 'preprocess functions' => array(
  2202. * 0 => 'template_preprocess',
  2203. * 1 => 'template_preprocess_user_profile',
  2204. * ),
  2205. * );
  2206. * @endcode
  2207. *
  2208. * @param $theme_registry
  2209. * The entire cache of theme registry information, post-processing.
  2210. *
  2211. * @see hook_theme()
  2212. * @see _theme_process_registry()
  2213. */
  2214. function hook_theme_registry_alter(&$theme_registry) {
  2215. // Kill the next/previous forum topic navigation links.
  2216. foreach ($theme_registry['forum_topic_navigation']['preprocess functions'] as $key => $value) {
  2217. if ($value == 'template_preprocess_forum_topic_navigation') {
  2218. unset($theme_registry['forum_topic_navigation']['preprocess functions'][$key]);
  2219. }
  2220. }
  2221. }
  2222. /**
  2223. * Return the machine-readable name of the theme to use for the current page.
  2224. *
  2225. * This hook can be used to dynamically set the theme for the current page
  2226. * request. It should be used by modules which need to override the theme
  2227. * based on dynamic conditions (for example, a module which allows the theme to
  2228. * be set based on the current user's role). The return value of this hook will
  2229. * be used on all pages except those which have a valid per-page or per-section
  2230. * theme set via a theme callback function in hook_menu(); the themes on those
  2231. * pages can only be overridden using hook_menu_alter().
  2232. *
  2233. * Note that returning different themes for the same path may not work with page
  2234. * caching. This is most likely to be a problem if an anonymous user on a given
  2235. * path could have different themes returned under different conditions.
  2236. *
  2237. * Since only one theme can be used at a time, the last (i.e., highest
  2238. * weighted) module which returns a valid theme name from this hook will
  2239. * prevail.
  2240. *
  2241. * @return
  2242. * The machine-readable name of the theme that should be used for the current
  2243. * page request. The value returned from this function will only have an
  2244. * effect if it corresponds to a currently-active theme on the site. Do not
  2245. * return a value if you do not wish to set a custom theme.
  2246. */
  2247. function hook_custom_theme() {
  2248. // Allow the user to request a particular theme via a query parameter.
  2249. if (isset($_GET['theme'])) {
  2250. return $_GET['theme'];
  2251. }
  2252. }
  2253. /**
  2254. * Register XML-RPC callbacks.
  2255. *
  2256. * This hook lets a module register callback functions to be called when
  2257. * particular XML-RPC methods are invoked by a client.
  2258. *
  2259. * @return
  2260. * An array which maps XML-RPC methods to Drupal functions. Each array
  2261. * element is either a pair of method => function or an array with four
  2262. * entries:
  2263. * - The XML-RPC method name (for example, module.function).
  2264. * - The Drupal callback function (for example, module_function).
  2265. * - The method signature is an array of XML-RPC types. The first element
  2266. * of this array is the type of return value and then you should write a
  2267. * list of the types of the parameters. XML-RPC types are the following
  2268. * (See the types at http://www.xmlrpc.com/spec):
  2269. * - "boolean": 0 (false) or 1 (true).
  2270. * - "double": a floating point number (for example, -12.214).
  2271. * - "int": a integer number (for example, -12).
  2272. * - "array": an array without keys (for example, array(1, 2, 3)).
  2273. * - "struct": an associative array or an object (for example,
  2274. * array('one' => 1, 'two' => 2)).
  2275. * - "date": when you return a date, then you may either return a
  2276. * timestamp (time(), mktime() etc.) or an ISO8601 timestamp. When
  2277. * date is specified as an input parameter, then you get an object,
  2278. * which is described in the function xmlrpc_date
  2279. * - "base64": a string containing binary data, automatically
  2280. * encoded/decoded automatically.
  2281. * - "string": anything else, typically a string.
  2282. * - A descriptive help string, enclosed in a t() function for translation
  2283. * purposes.
  2284. * Both forms are shown in the example.
  2285. */
  2286. function hook_xmlrpc() {
  2287. return array(
  2288. 'drupal.login' => 'drupal_login',
  2289. array(
  2290. 'drupal.site.ping',
  2291. 'drupal_directory_ping',
  2292. array('boolean', 'string', 'string', 'string', 'string', 'string'),
  2293. t('Handling ping request'))
  2294. );
  2295. }
  2296. /**
  2297. * Alters the definition of XML-RPC methods before they are called.
  2298. *
  2299. * This hook allows modules to modify the callback definition of declared
  2300. * XML-RPC methods, right before they are invoked by a client. Methods may be
  2301. * added, or existing methods may be altered.
  2302. *
  2303. * Note that hook_xmlrpc() supports two distinct and incompatible formats to
  2304. * define a callback, so care must be taken when altering other methods.
  2305. *
  2306. * @param $methods
  2307. * An asssociative array of method callback definitions, as returned from
  2308. * hook_xmlrpc() implementations.
  2309. *
  2310. * @see hook_xmlrpc()
  2311. * @see xmlrpc_server()
  2312. */
  2313. function hook_xmlrpc_alter(&$methods) {
  2314. // Directly change a simple method.
  2315. $methods['drupal.login'] = 'mymodule_login';
  2316. // Alter complex definitions.
  2317. foreach ($methods as $key => &$method) {
  2318. // Skip simple method definitions.
  2319. if (!is_int($key)) {
  2320. continue;
  2321. }
  2322. // Perform the wanted manipulation.
  2323. if ($method[0] == 'drupal.site.ping') {
  2324. $method[1] = 'mymodule_directory_ping';
  2325. }
  2326. }
  2327. }
  2328. /**
  2329. * Log an event message.
  2330. *
  2331. * This hook allows modules to route log events to custom destinations, such as
  2332. * SMS, Email, pager, syslog, ...etc.
  2333. *
  2334. * @param $log_entry
  2335. * An associative array containing the following keys:
  2336. * - type: The type of message for this entry.
  2337. * - user: The user object for the user who was logged in when the event
  2338. * happened.
  2339. * - uid: The user ID for the user who was logged in when the event happened.
  2340. * - request_uri: The request URI for the page the event happened in.
  2341. * - referer: The page that referred the user to the page where the event
  2342. * occurred.
  2343. * - ip: The IP address where the request for the page came from.
  2344. * - timestamp: The UNIX timestamp of the date/time the event occurred.
  2345. * - severity: The severity of the message; one of the following values as
  2346. * defined in @link http://www.faqs.org/rfcs/rfc3164.html RFC 3164: @endlink
  2347. * - WATCHDOG_EMERGENCY: Emergency, system is unusable.
  2348. * - WATCHDOG_ALERT: Alert, action must be taken immediately.
  2349. * - WATCHDOG_CRITICAL: Critical conditions.
  2350. * - WATCHDOG_ERROR: Error conditions.
  2351. * - WATCHDOG_WARNING: Warning conditions.
  2352. * - WATCHDOG_NOTICE: Normal but significant conditions.
  2353. * - WATCHDOG_INFO: Informational messages.
  2354. * - WATCHDOG_DEBUG: Debug-level messages.
  2355. * - link: An optional link provided by the module that called the watchdog()
  2356. * function.
  2357. * - message: The text of the message to be logged. Variables in the message
  2358. * are indicated by using placeholder strings alongside the variables
  2359. * argument to declare the value of the placeholders. See t() for
  2360. * documentation on how the message and variable parameters interact.
  2361. * - variables: An array of variables to be inserted into the message on
  2362. * display. Will be NULL or missing if a message is already translated or if
  2363. * the message is not possible to translate.
  2364. */
  2365. function hook_watchdog(array $log_entry) {
  2366. global $base_url, $language;
  2367. $severity_list = array(
  2368. WATCHDOG_EMERGENCY => t('Emergency'),
  2369. WATCHDOG_ALERT => t('Alert'),
  2370. WATCHDOG_CRITICAL => t('Critical'),
  2371. WATCHDOG_ERROR => t('Error'),
  2372. WATCHDOG_WARNING => t('Warning'),
  2373. WATCHDOG_NOTICE => t('Notice'),
  2374. WATCHDOG_INFO => t('Info'),
  2375. WATCHDOG_DEBUG => t('Debug'),
  2376. );
  2377. $to = 'someone@example.com';
  2378. $params = array();
  2379. $params['subject'] = t('[@site_name] @severity_desc: Alert from your web site', array(
  2380. '@site_name' => variable_get('site_name', 'Drupal'),
  2381. '@severity_desc' => $severity_list[$log_entry['severity']],
  2382. ));
  2383. $params['message'] = "\nSite: @base_url";
  2384. $params['message'] .= "\nSeverity: (@severity) @severity_desc";
  2385. $params['message'] .= "\nTimestamp: @timestamp";
  2386. $params['message'] .= "\nType: @type";
  2387. $params['message'] .= "\nIP Address: @ip";
  2388. $params['message'] .= "\nRequest URI: @request_uri";
  2389. $params['message'] .= "\nReferrer URI: @referer_uri";
  2390. $params['message'] .= "\nUser: (@uid) @name";
  2391. $params['message'] .= "\nLink: @link";
  2392. $params['message'] .= "\nMessage: \n\n@message";
  2393. $params['message'] = t($params['message'], array(
  2394. '@base_url' => $base_url,
  2395. '@severity' => $log_entry['severity'],
  2396. '@severity_desc' => $severity_list[$log_entry['severity']],
  2397. '@timestamp' => format_date($log_entry['timestamp']),
  2398. '@type' => $log_entry['type'],
  2399. '@ip' => $log_entry['ip'],
  2400. '@request_uri' => $log_entry['request_uri'],
  2401. '@referer_uri' => $log_entry['referer'],
  2402. '@uid' => $log_entry['uid'],
  2403. '@name' => $log_entry['user']->name,
  2404. '@link' => strip_tags($log_entry['link']),
  2405. '@message' => strip_tags($log_entry['message']),
  2406. ));
  2407. drupal_mail('emaillog', 'entry', $to, $language, $params);
  2408. }
  2409. /**
  2410. * Prepare a message based on parameters; called from drupal_mail().
  2411. *
  2412. * Note that hook_mail(), unlike hook_mail_alter(), is only called on the
  2413. * $module argument to drupal_mail(), not all modules.
  2414. *
  2415. * @param $key
  2416. * An identifier of the mail.
  2417. * @param $message
  2418. * An array to be filled in. Elements in this array include:
  2419. * - id: An ID to identify the mail sent. Look at module source code
  2420. * or drupal_mail() for possible id values.
  2421. * - to: The address or addresses the message will be sent to. The formatting
  2422. * of this string will be validated with the
  2423. * @link http://php.net/manual/filter.filters.validate.php PHP e-mail validation filter. @endlink
  2424. * - subject: Subject of the e-mail to be sent. This must not contain any
  2425. * newline characters, or the mail may not be sent properly. drupal_mail()
  2426. * sets this to an empty string when the hook is invoked.
  2427. * - body: An array of lines containing the message to be sent. Drupal will
  2428. * format the correct line endings for you. drupal_mail() sets this to an
  2429. * empty array when the hook is invoked.
  2430. * - from: The address the message will be marked as being from, which is
  2431. * set by drupal_mail() to either a custom address or the site-wide
  2432. * default email address when the hook is invoked.
  2433. * - headers: Associative array containing mail headers, such as From,
  2434. * Sender, MIME-Version, Content-Type, etc. drupal_mail() pre-fills
  2435. * several headers in this array.
  2436. * @param $params
  2437. * An array of parameters supplied by the caller of drupal_mail().
  2438. */
  2439. function hook_mail($key, &$message, $params) {
  2440. $account = $params['account'];
  2441. $context = $params['context'];
  2442. $variables = array(
  2443. '%site_name' => variable_get('site_name', 'Drupal'),
  2444. '%username' => format_username($account),
  2445. );
  2446. if ($context['hook'] == 'taxonomy') {
  2447. $entity = $params['entity'];
  2448. $vocabulary = taxonomy_vocabulary_load($entity->vid);
  2449. $variables += array(
  2450. '%term_name' => $entity->name,
  2451. '%term_description' => $entity->description,
  2452. '%term_id' => $entity->tid,
  2453. '%vocabulary_name' => $vocabulary->name,
  2454. '%vocabulary_description' => $vocabulary->description,
  2455. '%vocabulary_id' => $vocabulary->vid,
  2456. );
  2457. }
  2458. // Node-based variable translation is only available if we have a node.
  2459. if (isset($params['node'])) {
  2460. $node = $params['node'];
  2461. $variables += array(
  2462. '%uid' => $node->uid,
  2463. '%node_url' => url('node/' . $node->nid, array('absolute' => TRUE)),
  2464. '%node_type' => node_type_get_name($node),
  2465. '%title' => $node->title,
  2466. '%teaser' => $node->teaser,
  2467. '%body' => $node->body,
  2468. );
  2469. }
  2470. $subject = strtr($context['subject'], $variables);
  2471. $body = strtr($context['message'], $variables);
  2472. $message['subject'] .= str_replace(array("\r", "\n"), '', $subject);
  2473. $message['body'][] = drupal_html_to_text($body);
  2474. }
  2475. /**
  2476. * Add a list of cache tables to be cleared.
  2477. *
  2478. * This hook allows your module to add cache table names to the list of cache
  2479. * tables that will be cleared by the Clear button on the Performance page or
  2480. * whenever drupal_flush_all_caches is invoked.
  2481. *
  2482. * @return
  2483. * An array of cache table names.
  2484. *
  2485. * @see drupal_flush_all_caches()
  2486. */
  2487. function hook_flush_caches() {
  2488. return array('cache_example');
  2489. }
  2490. /**
  2491. * Perform necessary actions after modules are installed.
  2492. *
  2493. * This function differs from hook_install() in that it gives all other modules
  2494. * a chance to perform actions when a module is installed, whereas
  2495. * hook_install() is only called on the module actually being installed. See
  2496. * module_enable() for a detailed description of the order in which install and
  2497. * enable hooks are invoked.
  2498. *
  2499. * @param $modules
  2500. * An array of the modules that were installed.
  2501. *
  2502. * @see module_enable()
  2503. * @see hook_modules_enabled()
  2504. * @see hook_install()
  2505. */
  2506. function hook_modules_installed($modules) {
  2507. if (in_array('lousy_module', $modules)) {
  2508. variable_set('lousy_module_conflicting_variable', FALSE);
  2509. }
  2510. }
  2511. /**
  2512. * Perform necessary actions after modules are enabled.
  2513. *
  2514. * This function differs from hook_enable() in that it gives all other modules a
  2515. * chance to perform actions when modules are enabled, whereas hook_enable() is
  2516. * only called on the module actually being enabled. See module_enable() for a
  2517. * detailed description of the order in which install and enable hooks are
  2518. * invoked.
  2519. *
  2520. * @param $modules
  2521. * An array of the modules that were enabled.
  2522. *
  2523. * @see hook_enable()
  2524. * @see hook_modules_installed()
  2525. * @see module_enable()
  2526. */
  2527. function hook_modules_enabled($modules) {
  2528. if (in_array('lousy_module', $modules)) {
  2529. drupal_set_message(t('mymodule is not compatible with lousy_module'), 'error');
  2530. mymodule_disable_functionality();
  2531. }
  2532. }
  2533. /**
  2534. * Perform necessary actions after modules are disabled.
  2535. *
  2536. * This function differs from hook_disable() in that it gives all other modules
  2537. * a chance to perform actions when modules are disabled, whereas hook_disable()
  2538. * is only called on the module actually being disabled.
  2539. *
  2540. * @param $modules
  2541. * An array of the modules that were disabled.
  2542. *
  2543. * @see hook_disable()
  2544. * @see hook_modules_uninstalled()
  2545. */
  2546. function hook_modules_disabled($modules) {
  2547. if (in_array('lousy_module', $modules)) {
  2548. mymodule_enable_functionality();
  2549. }
  2550. }
  2551. /**
  2552. * Perform necessary actions after modules are uninstalled.
  2553. *
  2554. * This function differs from hook_uninstall() in that it gives all other
  2555. * modules a chance to perform actions when a module is uninstalled, whereas
  2556. * hook_uninstall() is only called on the module actually being uninstalled.
  2557. *
  2558. * It is recommended that you implement this hook if your module stores
  2559. * data that may have been set by other modules.
  2560. *
  2561. * @param $modules
  2562. * An array of the modules that were uninstalled.
  2563. *
  2564. * @see hook_uninstall()
  2565. * @see hook_modules_disabled()
  2566. */
  2567. function hook_modules_uninstalled($modules) {
  2568. foreach ($modules as $module) {
  2569. db_delete('mymodule_table')
  2570. ->condition('module', $module)
  2571. ->execute();
  2572. }
  2573. mymodule_cache_rebuild();
  2574. }
  2575. /**
  2576. * Registers PHP stream wrapper implementations associated with a module.
  2577. *
  2578. * Provide a facility for managing and querying user-defined stream wrappers
  2579. * in PHP. PHP's internal stream_get_wrappers() doesn't return the class
  2580. * registered to handle a stream, which we need to be able to find the handler
  2581. * for class instantiation.
  2582. *
  2583. * If a module registers a scheme that is already registered with PHP, it will
  2584. * be unregistered and replaced with the specified class.
  2585. *
  2586. * @return
  2587. * A nested array, keyed first by scheme name ("public" for "public://"),
  2588. * then keyed by the following values:
  2589. * - 'name' A short string to name the wrapper.
  2590. * - 'class' A string specifying the PHP class that implements the
  2591. * DrupalStreamWrapperInterface interface.
  2592. * - 'description' A string with a short description of what the wrapper does.
  2593. * - 'type' (Optional) A bitmask of flags indicating what type of streams this
  2594. * wrapper will access - local or remote, readable and/or writeable, etc.
  2595. * Many shortcut constants are defined in stream_wrappers.inc. Defaults to
  2596. * STREAM_WRAPPERS_NORMAL which includes all of these bit flags:
  2597. * - STREAM_WRAPPERS_READ
  2598. * - STREAM_WRAPPERS_WRITE
  2599. * - STREAM_WRAPPERS_VISIBLE
  2600. *
  2601. * @see file_get_stream_wrappers()
  2602. * @see hook_stream_wrappers_alter()
  2603. * @see system_stream_wrappers()
  2604. */
  2605. function hook_stream_wrappers() {
  2606. return array(
  2607. 'public' => array(
  2608. 'name' => t('Public files'),
  2609. 'class' => 'DrupalPublicStreamWrapper',
  2610. 'description' => t('Public local files served by the webserver.'),
  2611. 'type' => STREAM_WRAPPERS_LOCAL_NORMAL,
  2612. ),
  2613. 'private' => array(
  2614. 'name' => t('Private files'),
  2615. 'class' => 'DrupalPrivateStreamWrapper',
  2616. 'description' => t('Private local files served by Drupal.'),
  2617. 'type' => STREAM_WRAPPERS_LOCAL_NORMAL,
  2618. ),
  2619. 'temp' => array(
  2620. 'name' => t('Temporary files'),
  2621. 'class' => 'DrupalTempStreamWrapper',
  2622. 'description' => t('Temporary local files for upload and previews.'),
  2623. 'type' => STREAM_WRAPPERS_LOCAL_HIDDEN,
  2624. ),
  2625. 'cdn' => array(
  2626. 'name' => t('Content delivery network files'),
  2627. 'class' => 'MyModuleCDNStreamWrapper',
  2628. 'description' => t('Files served by a content delivery network.'),
  2629. // 'type' can be omitted to use the default of STREAM_WRAPPERS_NORMAL
  2630. ),
  2631. 'youtube' => array(
  2632. 'name' => t('YouTube video'),
  2633. 'class' => 'MyModuleYouTubeStreamWrapper',
  2634. 'description' => t('Video streamed from YouTube.'),
  2635. // A module implementing YouTube integration may decide to support using
  2636. // the YouTube API for uploading video, but here, we assume that this
  2637. // particular module only supports playing YouTube video.
  2638. 'type' => STREAM_WRAPPERS_READ_VISIBLE,
  2639. ),
  2640. );
  2641. }
  2642. /**
  2643. * Alters the list of PHP stream wrapper implementations.
  2644. *
  2645. * @see file_get_stream_wrappers()
  2646. * @see hook_stream_wrappers()
  2647. */
  2648. function hook_stream_wrappers_alter(&$wrappers) {
  2649. // Change the name of private files to reflect the performance.
  2650. $wrappers['private']['name'] = t('Slow files');
  2651. }
  2652. /**
  2653. * Load additional information into file objects.
  2654. *
  2655. * file_load_multiple() calls this hook to allow modules to load
  2656. * additional information into each file.
  2657. *
  2658. * @param $files
  2659. * An array of file objects, indexed by fid.
  2660. *
  2661. * @see file_load_multiple()
  2662. * @see file_load()
  2663. */
  2664. function hook_file_load($files) {
  2665. // Add the upload specific data into the file object.
  2666. $result = db_query('SELECT * FROM {upload} u WHERE u.fid IN (:fids)', array(':fids' => array_keys($files)))->fetchAll(PDO::FETCH_ASSOC);
  2667. foreach ($result as $record) {
  2668. foreach ($record as $key => $value) {
  2669. $files[$record['fid']]->$key = $value;
  2670. }
  2671. }
  2672. }
  2673. /**
  2674. * Check that files meet a given criteria.
  2675. *
  2676. * This hook lets modules perform additional validation on files. They're able
  2677. * to report a failure by returning one or more error messages.
  2678. *
  2679. * @param $file
  2680. * The file object being validated.
  2681. * @return
  2682. * An array of error messages. If there are no problems with the file return
  2683. * an empty array.
  2684. *
  2685. * @see file_validate()
  2686. */
  2687. function hook_file_validate($file) {
  2688. $errors = array();
  2689. if (empty($file->filename)) {
  2690. $errors[] = t("The file's name is empty. Please give a name to the file.");
  2691. }
  2692. if (strlen($file->filename) > 255) {
  2693. $errors[] = t("The file's name exceeds the 255 characters limit. Please rename the file and try again.");
  2694. }
  2695. return $errors;
  2696. }
  2697. /**
  2698. * Act on a file being inserted or updated.
  2699. *
  2700. * This hook is called when a file has been added to the database. The hook
  2701. * doesn't distinguish between files created as a result of a copy or those
  2702. * created by an upload.
  2703. *
  2704. * @param $file
  2705. * The file that has just been created.
  2706. *
  2707. * @see file_save()
  2708. */
  2709. function hook_file_presave($file) {
  2710. // Change the file timestamp to an hour prior.
  2711. $file->timestamp -= 3600;
  2712. }
  2713. /**
  2714. * Respond to a file being added.
  2715. *
  2716. * This hook is called after a file has been added to the database. The hook
  2717. * doesn't distinguish between files created as a result of a copy or those
  2718. * created by an upload.
  2719. *
  2720. * @param $file
  2721. * The file that has been added.
  2722. *
  2723. * @see file_save()
  2724. */
  2725. function hook_file_insert($file) {
  2726. // Add a message to the log, if the file is a jpg
  2727. $validate = file_validate_extensions($file, 'jpg');
  2728. if (empty($validate)) {
  2729. watchdog('file', 'A jpg has been added.');
  2730. }
  2731. }
  2732. /**
  2733. * Respond to a file being updated.
  2734. *
  2735. * This hook is called when file_save() is called on an existing file.
  2736. *
  2737. * @param $file
  2738. * The file that has just been updated.
  2739. *
  2740. * @see file_save()
  2741. */
  2742. function hook_file_update($file) {
  2743. $file_user = user_load($file->uid);
  2744. // Make sure that the file name starts with the owner's user name.
  2745. if (strpos($file->filename, $file_user->name) !== 0) {
  2746. $old_filename = $file->filename;
  2747. $file->filename = $file_user->name . '_' . $file->filename;
  2748. $file->save();
  2749. watchdog('file', t('%source has been renamed to %destination', array('%source' => $old_filename, '%destination' => $file->filename)));
  2750. }
  2751. }
  2752. /**
  2753. * Respond to a file that has been copied.
  2754. *
  2755. * @param $file
  2756. * The newly copied file object.
  2757. * @param $source
  2758. * The original file before the copy.
  2759. *
  2760. * @see file_copy()
  2761. */
  2762. function hook_file_copy($file, $source) {
  2763. $file_user = user_load($file->uid);
  2764. // Make sure that the file name starts with the owner's user name.
  2765. if (strpos($file->filename, $file_user->name) !== 0) {
  2766. $file->filename = $file_user->name . '_' . $file->filename;
  2767. $file->save();
  2768. watchdog('file', t('Copied file %source has been renamed to %destination', array('%source' => $source->filename, '%destination' => $file->filename)));
  2769. }
  2770. }
  2771. /**
  2772. * Respond to a file that has been moved.
  2773. *
  2774. * @param $file
  2775. * The updated file object after the move.
  2776. * @param $source
  2777. * The original file object before the move.
  2778. *
  2779. * @see file_move()
  2780. */
  2781. function hook_file_move($file, $source) {
  2782. $file_user = user_load($file->uid);
  2783. // Make sure that the file name starts with the owner's user name.
  2784. if (strpos($file->filename, $file_user->name) !== 0) {
  2785. $file->filename = $file_user->name . '_' . $file->filename;
  2786. $file->save();
  2787. watchdog('file', t('Moved file %source has been renamed to %destination', array('%source' => $source->filename, '%destination' => $file->filename)));
  2788. }
  2789. }
  2790. /**
  2791. * Respond to a file being deleted.
  2792. *
  2793. * @param $file
  2794. * The file that has just been deleted.
  2795. *
  2796. * @see file_delete()
  2797. */
  2798. function hook_file_delete($file) {
  2799. // Delete all information associated with the file.
  2800. db_delete('upload')->condition('fid', $file->fid)->execute();
  2801. }
  2802. /**
  2803. * Control access to private file downloads and specify HTTP headers.
  2804. *
  2805. * This hook allows modules enforce permissions on file downloads when the
  2806. * private file download method is selected. Modules can also provide headers
  2807. * to specify information like the file's name or MIME type.
  2808. *
  2809. * @param $uri
  2810. * The URI of the file.
  2811. * @return
  2812. * If the user does not have permission to access the file, return -1. If the
  2813. * user has permission, return an array with the appropriate headers. If the
  2814. * file is not controlled by the current module, the return value should be
  2815. * NULL.
  2816. *
  2817. * @see file_download()
  2818. */
  2819. function hook_file_download($uri) {
  2820. // Check if the file is controlled by the current module.
  2821. if (!file_prepare_directory($uri)) {
  2822. $uri = FALSE;
  2823. }
  2824. if (strpos(file_uri_target($uri), variable_get('user_picture_path', 'pictures') . '/picture-') === 0) {
  2825. if (!user_access('access user profiles')) {
  2826. // Access to the file is denied.
  2827. return -1;
  2828. }
  2829. else {
  2830. $info = image_get_info($uri);
  2831. return array('Content-Type' => $info['mime_type']);
  2832. }
  2833. }
  2834. }
  2835. /**
  2836. * Alter the URL to a file.
  2837. *
  2838. * This hook is called from file_create_url(), and is called fairly
  2839. * frequently (10+ times per page), depending on how many files there are in a
  2840. * given page.
  2841. * If CSS and JS aggregation are disabled, this can become very frequently
  2842. * (50+ times per page) so performance is critical.
  2843. *
  2844. * This function should alter the URI, if it wants to rewrite the file URL.
  2845. *
  2846. * @param $uri
  2847. * The URI to a file for which we need an external URL, or the path to a
  2848. * shipped file.
  2849. */
  2850. function hook_file_url_alter(&$uri) {
  2851. global $user;
  2852. // User 1 will always see the local file in this example.
  2853. if ($user->uid == 1) {
  2854. return;
  2855. }
  2856. $cdn1 = 'http://cdn1.example.com';
  2857. $cdn2 = 'http://cdn2.example.com';
  2858. $cdn_extensions = array('css', 'js', 'gif', 'jpg', 'jpeg', 'png');
  2859. // Most CDNs don't support private file transfers without a lot of hassle,
  2860. // so don't support this in the common case.
  2861. $schemes = array('public');
  2862. $scheme = file_uri_scheme($uri);
  2863. // Only serve shipped files and public created files from the CDN.
  2864. if (!$scheme || in_array($scheme, $schemes)) {
  2865. // Shipped files.
  2866. if (!$scheme) {
  2867. $path = $uri;
  2868. }
  2869. // Public created files.
  2870. else {
  2871. $wrapper = file_stream_wrapper_get_instance_by_scheme($scheme);
  2872. $path = $wrapper->getDirectoryPath() . '/' . file_uri_target($uri);
  2873. }
  2874. // Clean up Windows paths.
  2875. $path = str_replace('\\', '/', $path);
  2876. // Serve files with one of the CDN extensions from CDN 1, all others from
  2877. // CDN 2.
  2878. $pathinfo = pathinfo($path);
  2879. if (isset($pathinfo['extension']) && in_array($pathinfo['extension'], $cdn_extensions)) {
  2880. $uri = $cdn1 . '/' . $path;
  2881. }
  2882. else {
  2883. $uri = $cdn2 . '/' . $path;
  2884. }
  2885. }
  2886. }
  2887. /**
  2888. * Check installation requirements and do status reporting.
  2889. *
  2890. * This hook has three closely related uses, determined by the $phase argument:
  2891. * - Checking installation requirements ($phase == 'install').
  2892. * - Checking update requirements ($phase == 'update').
  2893. * - Status reporting ($phase == 'runtime').
  2894. *
  2895. * Note that this hook, like all others dealing with installation and updates,
  2896. * must reside in a module_name.install file, or it will not properly abort
  2897. * the installation of the module if a critical requirement is missing.
  2898. *
  2899. * During the 'install' phase, modules can for example assert that
  2900. * library or server versions are available or sufficient.
  2901. * Note that the installation of a module can happen during installation of
  2902. * Drupal itself (by install.php) with an installation profile or later by hand.
  2903. * As a consequence, install-time requirements must be checked without access
  2904. * to the full Drupal API, because it is not available during install.php.
  2905. * For localization you should for example use $t = get_t() to
  2906. * retrieve the appropriate localization function name (t() or st()).
  2907. * If a requirement has a severity of REQUIREMENT_ERROR, install.php will abort
  2908. * or at least the module will not install.
  2909. * Other severity levels have no effect on the installation.
  2910. * Module dependencies do not belong to these installation requirements,
  2911. * but should be defined in the module's .info file.
  2912. *
  2913. * The 'runtime' phase is not limited to pure installation requirements
  2914. * but can also be used for more general status information like maintenance
  2915. * tasks and security issues.
  2916. * The returned 'requirements' will be listed on the status report in the
  2917. * administration section, with indication of the severity level.
  2918. * Moreover, any requirement with a severity of REQUIREMENT_ERROR severity will
  2919. * result in a notice on the administration configuration page.
  2920. *
  2921. * @param $phase
  2922. * The phase in which requirements are checked:
  2923. * - install: The module is being installed.
  2924. * - update: The module is enabled and update.php is run.
  2925. * - runtime: The runtime requirements are being checked and shown on the
  2926. * status report page.
  2927. *
  2928. * @return
  2929. * An associative array where the keys are arbitrary but must be unique (it
  2930. * is suggested to use the module short name as a prefix) and the values are
  2931. * themselves associative arrays with the following elements:
  2932. * - title: The name of the requirement.
  2933. * - value: The current value (e.g., version, time, level, etc). During
  2934. * install phase, this should only be used for version numbers, do not set
  2935. * it if not applicable.
  2936. * - description: The description of the requirement/status.
  2937. * - severity: The requirement's result/severity level, one of:
  2938. * - REQUIREMENT_INFO: For info only.
  2939. * - REQUIREMENT_OK: The requirement is satisfied.
  2940. * - REQUIREMENT_WARNING: The requirement failed with a warning.
  2941. * - REQUIREMENT_ERROR: The requirement failed with an error.
  2942. */
  2943. function hook_requirements($phase) {
  2944. $requirements = array();
  2945. // Ensure translations don't break during installation.
  2946. $t = get_t();
  2947. // Report Drupal version
  2948. if ($phase == 'runtime') {
  2949. $requirements['drupal'] = array(
  2950. 'title' => $t('Drupal'),
  2951. 'value' => VERSION,
  2952. 'severity' => REQUIREMENT_INFO
  2953. );
  2954. }
  2955. // Test PHP version
  2956. $requirements['php'] = array(
  2957. 'title' => $t('PHP'),
  2958. 'value' => ($phase == 'runtime') ? l(phpversion(), 'admin/reports/status/php') : phpversion(),
  2959. );
  2960. if (version_compare(phpversion(), DRUPAL_MINIMUM_PHP) < 0) {
  2961. $requirements['php']['description'] = $t('Your PHP installation is too old. Drupal requires at least PHP %version.', array('%version' => DRUPAL_MINIMUM_PHP));
  2962. $requirements['php']['severity'] = REQUIREMENT_ERROR;
  2963. }
  2964. // Report cron status
  2965. if ($phase == 'runtime') {
  2966. $cron_last = variable_get('cron_last');
  2967. if (is_numeric($cron_last)) {
  2968. $requirements['cron']['value'] = $t('Last run !time ago', array('!time' => format_interval(REQUEST_TIME - $cron_last)));
  2969. }
  2970. else {
  2971. $requirements['cron'] = array(
  2972. 'description' => $t('Cron has not run. It appears cron jobs have not been setup on your system. Check the help pages for <a href="@url">configuring cron jobs</a>.', array('@url' => 'http://drupal.org/cron')),
  2973. 'severity' => REQUIREMENT_ERROR,
  2974. 'value' => $t('Never run'),
  2975. );
  2976. }
  2977. $requirements['cron']['description'] .= ' ' . $t('You can <a href="@cron">run cron manually</a>.', array('@cron' => url('admin/reports/status/run-cron')));
  2978. $requirements['cron']['title'] = $t('Cron maintenance tasks');
  2979. }
  2980. return $requirements;
  2981. }
  2982. /**
  2983. * Define the current version of the database schema.
  2984. *
  2985. * A Drupal schema definition is an array structure representing one or more
  2986. * tables and their related keys and indexes. A schema is defined by
  2987. * hook_schema() which must live in your module's .install file.
  2988. *
  2989. * This hook is called at install and uninstall time, and in the latter case, it
  2990. * cannot rely on the .module file being loaded or hooks being known. If the
  2991. * .module file is needed, it may be loaded with drupal_load().
  2992. *
  2993. * The tables declared by this hook will be automatically created when the
  2994. * module is first enabled, and removed when the module is uninstalled. This
  2995. * happens before hook_install() is invoked, and after hook_uninstall() is
  2996. * invoked, respectively.
  2997. *
  2998. * By declaring the tables used by your module via an implementation of
  2999. * hook_schema(), these tables will be available on all supported database
  3000. * engines. You don't have to deal with the different SQL dialects for table
  3001. * creation and alteration of the supported database engines.
  3002. *
  3003. * See the Schema API Handbook at http://drupal.org/node/146843 for details on
  3004. * schema definition structures.
  3005. *
  3006. * @return array
  3007. * A schema definition structure array. For each element of the
  3008. * array, the key is a table name and the value is a table structure
  3009. * definition.
  3010. *
  3011. * @see hook_schema_alter()
  3012. *
  3013. * @ingroup schemaapi
  3014. */
  3015. function hook_schema() {
  3016. $schema['node'] = array(
  3017. // Example (partial) specification for table "node".
  3018. 'description' => 'The base table for nodes.',
  3019. 'fields' => array(
  3020. 'nid' => array(
  3021. 'description' => 'The primary identifier for a node.',
  3022. 'type' => 'serial',
  3023. 'unsigned' => TRUE,
  3024. 'not null' => TRUE,
  3025. ),
  3026. 'vid' => array(
  3027. 'description' => 'The current {node_revision}.vid version identifier.',
  3028. 'type' => 'int',
  3029. 'unsigned' => TRUE,
  3030. 'not null' => TRUE,
  3031. 'default' => 0,
  3032. ),
  3033. 'type' => array(
  3034. 'description' => 'The {node_type} of this node.',
  3035. 'type' => 'varchar',
  3036. 'length' => 32,
  3037. 'not null' => TRUE,
  3038. 'default' => '',
  3039. ),
  3040. 'title' => array(
  3041. 'description' => 'The title of this node, always treated as non-markup plain text.',
  3042. 'type' => 'varchar',
  3043. 'length' => 255,
  3044. 'not null' => TRUE,
  3045. 'default' => '',
  3046. ),
  3047. ),
  3048. 'indexes' => array(
  3049. 'node_changed' => array('changed'),
  3050. 'node_created' => array('created'),
  3051. ),
  3052. 'unique keys' => array(
  3053. 'nid_vid' => array('nid', 'vid'),
  3054. 'vid' => array('vid'),
  3055. ),
  3056. 'foreign keys' => array(
  3057. 'node_revision' => array(
  3058. 'table' => 'node_revision',
  3059. 'columns' => array('vid' => 'vid'),
  3060. ),
  3061. 'node_author' => array(
  3062. 'table' => 'users',
  3063. 'columns' => array('uid' => 'uid'),
  3064. ),
  3065. ),
  3066. 'primary key' => array('nid'),
  3067. );
  3068. return $schema;
  3069. }
  3070. /**
  3071. * Perform alterations to existing database schemas.
  3072. *
  3073. * When a module modifies the database structure of another module (by
  3074. * changing, adding or removing fields, keys or indexes), it should
  3075. * implement hook_schema_alter() to update the default $schema to take its
  3076. * changes into account.
  3077. *
  3078. * See hook_schema() for details on the schema definition structure.
  3079. *
  3080. * @param $schema
  3081. * Nested array describing the schemas for all modules.
  3082. *
  3083. * @ingroup schemaapi
  3084. */
  3085. function hook_schema_alter(&$schema) {
  3086. // Add field to existing schema.
  3087. $schema['users']['fields']['timezone_id'] = array(
  3088. 'type' => 'int',
  3089. 'not null' => TRUE,
  3090. 'default' => 0,
  3091. 'description' => 'Per-user timezone configuration.',
  3092. );
  3093. }
  3094. /**
  3095. * Perform alterations to a structured query.
  3096. *
  3097. * Structured (aka dynamic) queries that have tags associated may be altered by any module
  3098. * before the query is executed.
  3099. *
  3100. * @param $query
  3101. * A Query object describing the composite parts of a SQL query.
  3102. *
  3103. * @see hook_query_TAG_alter()
  3104. * @see node_query_node_access_alter()
  3105. * @see QueryAlterableInterface
  3106. * @see SelectQueryInterface
  3107. */
  3108. function hook_query_alter(QueryAlterableInterface $query) {
  3109. if ($query->hasTag('micro_limit')) {
  3110. $query->range(0, 2);
  3111. }
  3112. }
  3113. /**
  3114. * Perform alterations to a structured query for a given tag.
  3115. *
  3116. * @param $query
  3117. * An Query object describing the composite parts of a SQL query.
  3118. *
  3119. * @see hook_query_alter()
  3120. * @see node_query_node_access_alter()
  3121. * @see QueryAlterableInterface
  3122. * @see SelectQueryInterface
  3123. */
  3124. function hook_query_TAG_alter(QueryAlterableInterface $query) {
  3125. // Skip the extra expensive alterations if site has no node access control modules.
  3126. if (!node_access_view_all_nodes()) {
  3127. // Prevent duplicates records.
  3128. $query->distinct();
  3129. // The recognized operations are 'view', 'update', 'delete'.
  3130. if (!$op = $query->getMetaData('op')) {
  3131. $op = 'view';
  3132. }
  3133. // Skip the extra joins and conditions for node admins.
  3134. if (!user_access('bypass node access')) {
  3135. // The node_access table has the access grants for any given node.
  3136. $access_alias = $query->join('node_access', 'na', '%alias.nid = n.nid');
  3137. $or = db_or();
  3138. // If any grant exists for the specified user, then user has access to the node for the specified operation.
  3139. foreach (node_access_grants($op, $query->getMetaData('account')) as $realm => $gids) {
  3140. foreach ($gids as $gid) {
  3141. $or->condition(db_and()
  3142. ->condition($access_alias . '.gid', $gid)
  3143. ->condition($access_alias . '.realm', $realm)
  3144. );
  3145. }
  3146. }
  3147. if (count($or->conditions())) {
  3148. $query->condition($or);
  3149. }
  3150. $query->condition($access_alias . 'grant_' . $op, 1, '>=');
  3151. }
  3152. }
  3153. }
  3154. /**
  3155. * Perform setup tasks when the module is installed.
  3156. *
  3157. * If the module implements hook_schema(), the database tables will
  3158. * be created before this hook is fired.
  3159. *
  3160. * Implementations of this hook are by convention declared in the module's
  3161. * .install file. The implementation can rely on the .module file being loaded.
  3162. * The hook will only be called the first time a module is enabled or after it
  3163. * is re-enabled after being uninstalled. The module's schema version will be
  3164. * set to the module's greatest numbered update hook. Because of this, any time
  3165. * a hook_update_N() is added to the module, this function needs to be updated
  3166. * to reflect the current version of the database schema.
  3167. *
  3168. * See the @link http://drupal.org/node/146843 Schema API documentation @endlink
  3169. * for details on hook_schema and how database tables are defined.
  3170. *
  3171. * Note that since this function is called from a full bootstrap, all functions
  3172. * (including those in modules enabled by the current page request) are
  3173. * available when this hook is called. Use cases could be displaying a user
  3174. * message, or calling a module function necessary for initial setup, etc.
  3175. *
  3176. * Please be sure that anything added or modified in this function that can
  3177. * be removed during uninstall should be removed with hook_uninstall().
  3178. *
  3179. * @see hook_schema()
  3180. * @see module_enable()
  3181. * @see hook_enable()
  3182. * @see hook_disable()
  3183. * @see hook_uninstall()
  3184. * @see hook_modules_installed()
  3185. */
  3186. function hook_install() {
  3187. // Populate the default {node_access} record.
  3188. db_insert('node_access')
  3189. ->fields(array(
  3190. 'nid' => 0,
  3191. 'gid' => 0,
  3192. 'realm' => 'all',
  3193. 'grant_view' => 1,
  3194. 'grant_update' => 0,
  3195. 'grant_delete' => 0,
  3196. ))
  3197. ->execute();
  3198. }
  3199. /**
  3200. * Perform a single update.
  3201. *
  3202. * For each change that requires one or more actions to be performed when
  3203. * updating a site, add a new hook_update_N(), which will be called by
  3204. * update.php. The documentation block preceding this function is stripped of
  3205. * newlines and used as the description for the update on the pending updates
  3206. * task list. Schema updates should adhere to the
  3207. * @link http://drupal.org/node/150215 Schema API. @endlink
  3208. *
  3209. * Implementations of hook_update_N() are named (module name)_update_(number).
  3210. * The numbers are composed of three parts:
  3211. * - 1 digit for Drupal core compatibility.
  3212. * - 1 digit for your module's major release version (e.g., is this the 7.x-1.*
  3213. * (1) or 7.x-2.* (2) series of your module?). This digit should be 0 for
  3214. * initial porting of your module to a new Drupal core API.
  3215. * - 2 digits for sequential counting, starting with 00.
  3216. *
  3217. * Examples:
  3218. * - mymodule_update_7000(): This is the required update for mymodule to run
  3219. * with Drupal core API 7.x when upgrading from Drupal core API 6.x.
  3220. * - mymodule_update_7100(): This is the first update to get the database ready
  3221. * to run mymodule 7.x-1.*.
  3222. * - mymodule_update_7200(): This is the first update to get the database ready
  3223. * to run mymodule 7.x-2.*. Users can directly update from 6.x-2.* to 7.x-2.*
  3224. * and they get all 70xx and 72xx updates, but not 71xx updates, because
  3225. * those reside in the 7.x-1.x branch only.
  3226. *
  3227. * A good rule of thumb is to remove updates older than two major releases of
  3228. * Drupal. See hook_update_last_removed() to notify Drupal about the removals.
  3229. * For further information about releases and release numbers see:
  3230. * @link http://drupal.org/node/711070 Maintaining a drupal.org project with Git @endlink
  3231. *
  3232. * Never renumber update functions.
  3233. *
  3234. * Implementations of this hook should be placed in a mymodule.install file in
  3235. * the same directory as mymodule.module. Drupal core's updates are implemented
  3236. * using the system module as a name and stored in database/updates.inc.
  3237. *
  3238. * Not all module functions are available from within a hook_update_N() function.
  3239. * In order to call a function from your mymodule.module or an include file,
  3240. * you need to explicitly load that file first.
  3241. *
  3242. * During database updates the schema of any module could be out of date. For
  3243. * this reason, caution is needed when using any API function within an update
  3244. * function - particularly CRUD functions, functions that depend on the schema
  3245. * (for example by using drupal_write_record()), and any functions that invoke
  3246. * hooks. See @link update_api Update versions of API functions @endlink for
  3247. * details.
  3248. *
  3249. * If your update task is potentially time-consuming, you'll need to implement a
  3250. * multipass update to avoid PHP timeouts. Multipass updates use the $sandbox
  3251. * parameter provided by the batch API (normally, $context['sandbox']) to store
  3252. * information between successive calls, and the $sandbox['#finished'] value
  3253. * to provide feedback regarding completion level.
  3254. *
  3255. * See the batch operations page for more information on how to use the
  3256. * @link http://drupal.org/node/180528 Batch API. @endlink
  3257. *
  3258. * @param $sandbox
  3259. * Stores information for multipass updates. See above for more information.
  3260. *
  3261. * @throws DrupalUpdateException, PDOException
  3262. * In case of error, update hooks should throw an instance of DrupalUpdateException
  3263. * with a meaningful message for the user. If a database query fails for whatever
  3264. * reason, it will throw a PDOException.
  3265. *
  3266. * @return
  3267. * Optionally, update hooks may return a translated string that will be
  3268. * displayed to the user after the update has completed. If no message is
  3269. * returned, no message will be presented to the user.
  3270. *
  3271. * @see batch
  3272. * @see schemaapi
  3273. * @see update_api
  3274. * @see hook_update_last_removed()
  3275. * @see update_get_update_list()
  3276. */
  3277. function hook_update_N(&$sandbox) {
  3278. // For non-multipass updates, the signature can simply be;
  3279. // function hook_update_N() {
  3280. // For most updates, the following is sufficient.
  3281. db_add_field('mytable1', 'newcol', array('type' => 'int', 'not null' => TRUE, 'description' => 'My new integer column.'));
  3282. // However, for more complex operations that may take a long time,
  3283. // you may hook into Batch API as in the following example.
  3284. // Update 3 users at a time to have an exclamation point after their names.
  3285. // (They're really happy that we can do batch API in this hook!)
  3286. if (!isset($sandbox['progress'])) {
  3287. $sandbox['progress'] = 0;
  3288. $sandbox['current_uid'] = 0;
  3289. // We'll -1 to disregard the uid 0...
  3290. $sandbox['max'] = db_query('SELECT COUNT(DISTINCT uid) FROM {users}')->fetchField() - 1;
  3291. }
  3292. $users = db_select('users', 'u')
  3293. ->fields('u', array('uid', 'name'))
  3294. ->condition('uid', $sandbox['current_uid'], '>')
  3295. ->range(0, 3)
  3296. ->orderBy('uid', 'ASC')
  3297. ->execute();
  3298. foreach ($users as $user) {
  3299. $user->name .= '!';
  3300. db_update('users')
  3301. ->fields(array('name' => $user->name))
  3302. ->condition('uid', $user->uid)
  3303. ->execute();
  3304. $sandbox['progress']++;
  3305. $sandbox['current_uid'] = $user->uid;
  3306. }
  3307. $sandbox['#finished'] = empty($sandbox['max']) ? 1 : ($sandbox['progress'] / $sandbox['max']);
  3308. // To display a message to the user when the update is completed, return it.
  3309. // If you do not want to display a completion message, simply return nothing.
  3310. return t('The update did what it was supposed to do.');
  3311. // In case of an error, simply throw an exception with an error message.
  3312. throw new DrupalUpdateException('Something went wrong; here is what you should do.');
  3313. }
  3314. /**
  3315. * Return an array of information about module update dependencies.
  3316. *
  3317. * This can be used to indicate update functions from other modules that your
  3318. * module's update functions depend on, or vice versa. It is used by the update
  3319. * system to determine the appropriate order in which updates should be run, as
  3320. * well as to search for missing dependencies.
  3321. *
  3322. * Implementations of this hook should be placed in a mymodule.install file in
  3323. * the same directory as mymodule.module.
  3324. *
  3325. * @return
  3326. * A multidimensional array containing information about the module update
  3327. * dependencies. The first two levels of keys represent the module and update
  3328. * number (respectively) for which information is being returned, and the
  3329. * value is an array of information about that update's dependencies. Within
  3330. * this array, each key represents a module, and each value represents the
  3331. * number of an update function within that module. In the event that your
  3332. * update function depends on more than one update from a particular module,
  3333. * you should always list the highest numbered one here (since updates within
  3334. * a given module always run in numerical order).
  3335. *
  3336. * @see update_resolve_dependencies()
  3337. * @see hook_update_N()
  3338. */
  3339. function hook_update_dependencies() {
  3340. // Indicate that the mymodule_update_7000() function provided by this module
  3341. // must run after the another_module_update_7002() function provided by the
  3342. // 'another_module' module.
  3343. $dependencies['mymodule'][7000] = array(
  3344. 'another_module' => 7002,
  3345. );
  3346. // Indicate that the mymodule_update_7001() function provided by this module
  3347. // must run before the yet_another_module_update_7004() function provided by
  3348. // the 'yet_another_module' module. (Note that declaring dependencies in this
  3349. // direction should be done only in rare situations, since it can lead to the
  3350. // following problem: If a site has already run the yet_another_module
  3351. // module's database updates before it updates its codebase to pick up the
  3352. // newest mymodule code, then the dependency declared here will be ignored.)
  3353. $dependencies['yet_another_module'][7004] = array(
  3354. 'mymodule' => 7001,
  3355. );
  3356. return $dependencies;
  3357. }
  3358. /**
  3359. * Return a number which is no longer available as hook_update_N().
  3360. *
  3361. * If you remove some update functions from your mymodule.install file, you
  3362. * should notify Drupal of those missing functions. This way, Drupal can
  3363. * ensure that no update is accidentally skipped.
  3364. *
  3365. * Implementations of this hook should be placed in a mymodule.install file in
  3366. * the same directory as mymodule.module.
  3367. *
  3368. * @return
  3369. * An integer, corresponding to hook_update_N() which has been removed from
  3370. * mymodule.install.
  3371. *
  3372. * @see hook_update_N()
  3373. */
  3374. function hook_update_last_removed() {
  3375. // We've removed the 5.x-1.x version of mymodule, including database updates.
  3376. // The next update function is mymodule_update_5200().
  3377. return 5103;
  3378. }
  3379. /**
  3380. * Remove any information that the module sets.
  3381. *
  3382. * The information that the module should remove includes:
  3383. * - variables that the module has set using variable_set() or system_settings_form()
  3384. * - modifications to existing tables
  3385. *
  3386. * The module should not remove its entry from the {system} table. Database
  3387. * tables defined by hook_schema() will be removed automatically.
  3388. *
  3389. * The uninstall hook must be implemented in the module's .install file. It
  3390. * will fire when the module gets uninstalled but before the module's database
  3391. * tables are removed, allowing your module to query its own tables during
  3392. * this routine.
  3393. *
  3394. * When hook_uninstall() is called, your module will already be disabled, so
  3395. * its .module file will not be automatically included. If you need to call API
  3396. * functions from your .module file in this hook, use drupal_load() to make
  3397. * them available. (Keep this usage to a minimum, though, especially when
  3398. * calling API functions that invoke hooks, or API functions from modules
  3399. * listed as dependencies, since these may not be available or work as expected
  3400. * when the module is disabled.)
  3401. *
  3402. * @see hook_install()
  3403. * @see hook_schema()
  3404. * @see hook_disable()
  3405. * @see hook_modules_uninstalled()
  3406. */
  3407. function hook_uninstall() {
  3408. variable_del('upload_file_types');
  3409. }
  3410. /**
  3411. * Perform necessary actions after module is enabled.
  3412. *
  3413. * The hook is called every time the module is enabled. It should be
  3414. * implemented in the module's .install file. The implementation can
  3415. * rely on the .module file being loaded.
  3416. *
  3417. * @see module_enable()
  3418. * @see hook_install()
  3419. * @see hook_modules_enabled()
  3420. */
  3421. function hook_enable() {
  3422. mymodule_cache_rebuild();
  3423. }
  3424. /**
  3425. * Perform necessary actions before module is disabled.
  3426. *
  3427. * The hook is called every time the module is disabled. It should be
  3428. * implemented in the module's .install file. The implementation can rely
  3429. * on the .module file being loaded.
  3430. *
  3431. * @see hook_uninstall()
  3432. * @see hook_modules_disabled()
  3433. */
  3434. function hook_disable() {
  3435. mymodule_cache_rebuild();
  3436. }
  3437. /**
  3438. * Perform necessary alterations to the list of files parsed by the registry.
  3439. *
  3440. * Modules can manually modify the list of files before the registry parses
  3441. * them. The $modules array provides the .info file information, which includes
  3442. * the list of files registered to each module. Any files in the list can then
  3443. * be added to the list of files that the registry will parse, or modify
  3444. * attributes of a file.
  3445. *
  3446. * A necessary alteration made by the core SimpleTest module is to force .test
  3447. * files provided by disabled modules into the list of files parsed by the
  3448. * registry.
  3449. *
  3450. * @param $files
  3451. * List of files to be parsed by the registry. The list will contain
  3452. * files found in each enabled module's info file and the core includes
  3453. * directory. The array is keyed by the file path and contains an array of
  3454. * the related module's name and weight as used internally by
  3455. * _registry_update() and related functions.
  3456. *
  3457. * For example:
  3458. * @code
  3459. * $files["modules/system/system.module"] = array(
  3460. * 'module' => 'system',
  3461. * 'weight' => 0,
  3462. * );
  3463. * @endcode
  3464. * @param $modules
  3465. * An array containing all module information stored in the {system} table.
  3466. * Each element of the array also contains the module's .info file
  3467. * information in the property 'info'. An additional 'dir' property has been
  3468. * added to the module information which provides the path to the directory
  3469. * in which the module resides. The example shows how to take advantage of
  3470. * both properties.
  3471. *
  3472. * @see _registry_update()
  3473. * @see simpletest_test_get_all()
  3474. */
  3475. function hook_registry_files_alter(&$files, $modules) {
  3476. foreach ($modules as $module) {
  3477. // Only add test files for disabled modules, as enabled modules should
  3478. // already include any test files they provide.
  3479. if (!$module->status) {
  3480. $dir = $module->dir;
  3481. foreach ($module->info['files'] as $file) {
  3482. if (substr($file, -5) == '.test') {
  3483. $files["$dir/$file"] = array('module' => $module->name, 'weight' => $module->weight);
  3484. }
  3485. }
  3486. }
  3487. }
  3488. }
  3489. /**
  3490. * Return an array of tasks to be performed by an installation profile.
  3491. *
  3492. * Any tasks you define here will be run, in order, after the installer has
  3493. * finished the site configuration step but before it has moved on to the
  3494. * final import of languages and the end of the installation. You can have any
  3495. * number of custom tasks to perform during this phase.
  3496. *
  3497. * Each task you define here corresponds to a callback function which you must
  3498. * separately define and which is called when your task is run. This function
  3499. * will receive the global installation state variable, $install_state, as
  3500. * input, and has the opportunity to access or modify any of its settings. See
  3501. * the install_state_defaults() function in the installer for the list of
  3502. * $install_state settings used by Drupal core.
  3503. *
  3504. * At the end of your task function, you can indicate that you want the
  3505. * installer to pause and display a page to the user by returning any themed
  3506. * output that should be displayed on that page (but see below for tasks that
  3507. * use the form API or batch API; the return values of these task functions are
  3508. * handled differently). You should also use drupal_set_title() within the task
  3509. * callback function to set a custom page title. For some tasks, however, you
  3510. * may want to simply do some processing and pass control to the next task
  3511. * without ending the page request; to indicate this, simply do not send back
  3512. * a return value from your task function at all. This can be used, for
  3513. * example, by installation profiles that need to configure certain site
  3514. * settings in the database without obtaining any input from the user.
  3515. *
  3516. * The task function is treated specially if it defines a form or requires
  3517. * batch processing; in that case, you should return either the form API
  3518. * definition or batch API array, as appropriate. See below for more
  3519. * information on the 'type' key that you must define in the task definition
  3520. * to inform the installer that your task falls into one of those two
  3521. * categories. It is important to use these APIs directly, since the installer
  3522. * may be run non-interactively (for example, via a command line script), all
  3523. * in one page request; in that case, the installer will automatically take
  3524. * care of submitting forms and processing batches correctly for both types of
  3525. * installations. You can inspect the $install_state['interactive'] boolean to
  3526. * see whether or not the current installation is interactive, if you need
  3527. * access to this information.
  3528. *
  3529. * Remember that a user installing Drupal interactively will be able to reload
  3530. * an installation page multiple times, so you should use variable_set() and
  3531. * variable_get() if you are collecting any data that you need to store and
  3532. * inspect later. It is important to remove any temporary variables using
  3533. * variable_del() before your last task has completed and control is handed
  3534. * back to the installer.
  3535. *
  3536. * @param array $install_state
  3537. * An array of information about the current installation state.
  3538. *
  3539. * @return array
  3540. * A keyed array of tasks the profile will perform during the final stage of
  3541. * the installation. Each key represents the name of a function (usually a
  3542. * function defined by this profile, although that is not strictly required)
  3543. * that is called when that task is run. The values are associative arrays
  3544. * containing the following key-value pairs (all of which are optional):
  3545. * - display_name: The human-readable name of the task. This will be
  3546. * displayed to the user while the installer is running, along with a list
  3547. * of other tasks that are being run. Leave this unset to prevent the task
  3548. * from appearing in the list.
  3549. * - display: This is a boolean which can be used to provide finer-grained
  3550. * control over whether or not the task will display. This is mostly useful
  3551. * for tasks that are intended to display only under certain conditions;
  3552. * for these tasks, you can set 'display_name' to the name that you want to
  3553. * display, but then use this boolean to hide the task only when certain
  3554. * conditions apply.
  3555. * - type: A string representing the type of task. This parameter has three
  3556. * possible values:
  3557. * - normal: (default) This indicates that the task will be treated as a
  3558. * regular callback function, which does its processing and optionally
  3559. * returns HTML output.
  3560. * - batch: This indicates that the task function will return a batch API
  3561. * definition suitable for batch_set(). The installer will then take care
  3562. * of automatically running the task via batch processing.
  3563. * - form: This indicates that the task function will return a standard
  3564. * form API definition (and separately define validation and submit
  3565. * handlers, as appropriate). The installer will then take care of
  3566. * automatically directing the user through the form submission process.
  3567. * - run: A constant representing the manner in which the task will be run.
  3568. * This parameter has three possible values:
  3569. * - INSTALL_TASK_RUN_IF_NOT_COMPLETED: (default) This indicates that the
  3570. * task will run once during the installation of the profile.
  3571. * - INSTALL_TASK_SKIP: This indicates that the task will not run during
  3572. * the current installation page request. It can be used to skip running
  3573. * an installation task when certain conditions are met, even though the
  3574. * task may still show on the list of installation tasks presented to the
  3575. * user.
  3576. * - INSTALL_TASK_RUN_IF_REACHED: This indicates that the task will run on
  3577. * each installation page request that reaches it. This is rarely
  3578. * necessary for an installation profile to use; it is primarily used by
  3579. * the Drupal installer for bootstrap-related tasks.
  3580. * - function: Normally this does not need to be set, but it can be used to
  3581. * force the installer to call a different function when the task is run
  3582. * (rather than the function whose name is given by the array key). This
  3583. * could be used, for example, to allow the same function to be called by
  3584. * two different tasks.
  3585. *
  3586. * @see install_state_defaults()
  3587. * @see batch_set()
  3588. */
  3589. function hook_install_tasks(&$install_state) {
  3590. // Here, we define a variable to allow tasks to indicate that a particular,
  3591. // processor-intensive batch process needs to be triggered later on in the
  3592. // installation.
  3593. $myprofile_needs_batch_processing = variable_get('myprofile_needs_batch_processing', FALSE);
  3594. $tasks = array(
  3595. // This is an example of a task that defines a form which the user who is
  3596. // installing the site will be asked to fill out. To implement this task,
  3597. // your profile would define a function named myprofile_data_import_form()
  3598. // as a normal form API callback function, with associated validation and
  3599. // submit handlers. In the submit handler, in addition to saving whatever
  3600. // other data you have collected from the user, you might also call
  3601. // variable_set('myprofile_needs_batch_processing', TRUE) if the user has
  3602. // entered data which requires that batch processing will need to occur
  3603. // later on.
  3604. 'myprofile_data_import_form' => array(
  3605. 'display_name' => st('Data import options'),
  3606. 'type' => 'form',
  3607. ),
  3608. // Similarly, to implement this task, your profile would define a function
  3609. // named myprofile_settings_form() with associated validation and submit
  3610. // handlers. This form might be used to collect and save additional
  3611. // information from the user that your profile needs. There are no extra
  3612. // steps required for your profile to act as an "installation wizard"; you
  3613. // can simply define as many tasks of type 'form' as you wish to execute,
  3614. // and the forms will be presented to the user, one after another.
  3615. 'myprofile_settings_form' => array(
  3616. 'display_name' => st('Additional options'),
  3617. 'type' => 'form',
  3618. ),
  3619. // This is an example of a task that performs batch operations. To
  3620. // implement this task, your profile would define a function named
  3621. // myprofile_batch_processing() which returns a batch API array definition
  3622. // that the installer will use to execute your batch operations. Due to the
  3623. // 'myprofile_needs_batch_processing' variable used here, this task will be
  3624. // hidden and skipped unless your profile set it to TRUE in one of the
  3625. // previous tasks.
  3626. 'myprofile_batch_processing' => array(
  3627. 'display_name' => st('Import additional data'),
  3628. 'display' => $myprofile_needs_batch_processing,
  3629. 'type' => 'batch',
  3630. 'run' => $myprofile_needs_batch_processing ? INSTALL_TASK_RUN_IF_NOT_COMPLETED : INSTALL_TASK_SKIP,
  3631. ),
  3632. // This is an example of a task that will not be displayed in the list that
  3633. // the user sees. To implement this task, your profile would define a
  3634. // function named myprofile_final_site_setup(), in which additional,
  3635. // automated site setup operations would be performed. Since this is the
  3636. // last task defined by your profile, you should also use this function to
  3637. // call variable_del('myprofile_needs_batch_processing') and clean up the
  3638. // variable that was used above. If you want the user to pass to the final
  3639. // Drupal installation tasks uninterrupted, return no output from this
  3640. // function. Otherwise, return themed output that the user will see (for
  3641. // example, a confirmation page explaining that your profile's tasks are
  3642. // complete, with a link to reload the current page and therefore pass on
  3643. // to the final Drupal installation tasks when the user is ready to do so).
  3644. 'myprofile_final_site_setup' => array(
  3645. ),
  3646. );
  3647. return $tasks;
  3648. }
  3649. /**
  3650. * Change the page the user is sent to by drupal_goto().
  3651. *
  3652. * @param $path
  3653. * A Drupal path or a full URL.
  3654. * @param $options
  3655. * An associative array of additional URL options to pass to url().
  3656. * @param $http_response_code
  3657. * The HTTP status code to use for the redirection. See drupal_goto() for more
  3658. * information.
  3659. */
  3660. function hook_drupal_goto_alter(&$path, &$options, &$http_response_code) {
  3661. // A good addition to misery module.
  3662. $http_response_code = 500;
  3663. }
  3664. /**
  3665. * Alter XHTML HEAD tags before they are rendered by drupal_get_html_head().
  3666. *
  3667. * Elements available to be altered are only those added using
  3668. * drupal_add_html_head_link() or drupal_add_html_head(). CSS and JS files
  3669. * are handled using drupal_add_css() and drupal_add_js(), so the head links
  3670. * for those files will not appear in the $head_elements array.
  3671. *
  3672. * @param $head_elements
  3673. * An array of renderable elements. Generally the values of the #attributes
  3674. * array will be the most likely target for changes.
  3675. */
  3676. function hook_html_head_alter(&$head_elements) {
  3677. foreach ($head_elements as $key => $element) {
  3678. if (isset($element['#attributes']['rel']) && $element['#attributes']['rel'] == 'canonical') {
  3679. // I want a custom canonical URL.
  3680. $head_elements[$key]['#attributes']['href'] = mymodule_canonical_url();
  3681. }
  3682. }
  3683. }
  3684. /**
  3685. * Alter the full list of installation tasks.
  3686. *
  3687. * @param $tasks
  3688. * An array of all available installation tasks, including those provided by
  3689. * Drupal core. You can modify this array to change or replace any part of
  3690. * the Drupal installation process that occurs after the installation profile
  3691. * is selected.
  3692. * @param $install_state
  3693. * An array of information about the current installation state.
  3694. */
  3695. function hook_install_tasks_alter(&$tasks, $install_state) {
  3696. // Replace the "Choose language" installation task provided by Drupal core
  3697. // with a custom callback function defined by this installation profile.
  3698. $tasks['install_select_locale']['function'] = 'myprofile_locale_selection';
  3699. }
  3700. /**
  3701. * Alter MIME type mappings used to determine MIME type from a file extension.
  3702. *
  3703. * This hook is run when file_mimetype_mapping() is called. It is used to
  3704. * allow modules to add to or modify the default mapping from
  3705. * file_default_mimetype_mapping().
  3706. *
  3707. * @param $mapping
  3708. * An array of mimetypes correlated to the extensions that relate to them.
  3709. * The array has 'mimetypes' and 'extensions' elements, each of which is an
  3710. * array.
  3711. *
  3712. * @see file_default_mimetype_mapping()
  3713. */
  3714. function hook_file_mimetype_mapping_alter(&$mapping) {
  3715. // Add new MIME type 'drupal/info'.
  3716. $mapping['mimetypes']['example_info'] = 'drupal/info';
  3717. // Add new extension '.info' and map it to the 'drupal/info' MIME type.
  3718. $mapping['extensions']['info'] = 'example_info';
  3719. // Override existing extension mapping for '.ogg' files.
  3720. $mapping['extensions']['ogg'] = 189;
  3721. }
  3722. /**
  3723. * Declares information about actions.
  3724. *
  3725. * Any module can define actions, and then call actions_do() to make those
  3726. * actions happen in response to events. The trigger module provides a user
  3727. * interface for associating actions with module-defined triggers, and it makes
  3728. * sure the core triggers fire off actions when their events happen.
  3729. *
  3730. * An action consists of two or three parts:
  3731. * - an action definition (returned by this hook)
  3732. * - a function which performs the action (which by convention is named
  3733. * MODULE_description-of-function_action)
  3734. * - an optional form definition function that defines a configuration form
  3735. * (which has the name of the action function with '_form' appended to it.)
  3736. *
  3737. * The action function takes two to four arguments, which come from the input
  3738. * arguments to actions_do().
  3739. *
  3740. * @return
  3741. * An associative array of action descriptions. The keys of the array
  3742. * are the names of the action functions, and each corresponding value
  3743. * is an associative array with the following key-value pairs:
  3744. * - 'type': The type of object this action acts upon. Core actions have types
  3745. * 'node', 'user', 'comment', and 'system'.
  3746. * - 'label': The human-readable name of the action, which should be passed
  3747. * through the t() function for translation.
  3748. * - 'configurable': If FALSE, then the action doesn't require any extra
  3749. * configuration. If TRUE, then your module must define a form function with
  3750. * the same name as the action function with '_form' appended (e.g., the
  3751. * form for 'node_assign_owner_action' is 'node_assign_owner_action_form'.)
  3752. * This function takes $context as its only parameter, and is paired with
  3753. * the usual _submit function, and possibly a _validate function.
  3754. * - 'triggers': An array of the events (that is, hooks) that can trigger this
  3755. * action. For example: array('node_insert', 'user_update'). You can also
  3756. * declare support for any trigger by returning array('any') for this value.
  3757. * - 'behavior': (optional) A machine-readable array of behaviors of this
  3758. * action, used to signal additionally required actions that may need to be
  3759. * triggered. Currently recognized behaviors by Trigger module:
  3760. * - 'changes_property': If an action with this behavior is assigned to a
  3761. * trigger other than a "presave" hook, any save actions also assigned to
  3762. * this trigger are moved later in the list. If no save action is present,
  3763. * one will be added.
  3764. * Modules that are processing actions (like Trigger module) should take
  3765. * special care for the "presave" hook, in which case a dependent "save"
  3766. * action should NOT be invoked.
  3767. *
  3768. * @ingroup actions
  3769. */
  3770. function hook_action_info() {
  3771. return array(
  3772. 'comment_unpublish_action' => array(
  3773. 'type' => 'comment',
  3774. 'label' => t('Unpublish comment'),
  3775. 'configurable' => FALSE,
  3776. 'behavior' => array('changes_property'),
  3777. 'triggers' => array('comment_presave', 'comment_insert', 'comment_update'),
  3778. ),
  3779. 'comment_unpublish_by_keyword_action' => array(
  3780. 'type' => 'comment',
  3781. 'label' => t('Unpublish comment containing keyword(s)'),
  3782. 'configurable' => TRUE,
  3783. 'behavior' => array('changes_property'),
  3784. 'triggers' => array('comment_presave', 'comment_insert', 'comment_update'),
  3785. ),
  3786. 'comment_save_action' => array(
  3787. 'type' => 'comment',
  3788. 'label' => t('Save comment'),
  3789. 'configurable' => FALSE,
  3790. 'triggers' => array('comment_insert', 'comment_update'),
  3791. ),
  3792. );
  3793. }
  3794. /**
  3795. * Executes code after an action is deleted.
  3796. *
  3797. * @param $aid
  3798. * The action ID.
  3799. */
  3800. function hook_actions_delete($aid) {
  3801. db_delete('actions_assignments')
  3802. ->condition('aid', $aid)
  3803. ->execute();
  3804. }
  3805. /**
  3806. * Alters the actions declared by another module.
  3807. *
  3808. * Called by actions_list() to allow modules to alter the return values from
  3809. * implementations of hook_action_info().
  3810. *
  3811. * @see trigger_example_action_info_alter()
  3812. */
  3813. function hook_action_info_alter(&$actions) {
  3814. $actions['node_unpublish_action']['label'] = t('Unpublish and remove from public view.');
  3815. }
  3816. /**
  3817. * Declare archivers to the system.
  3818. *
  3819. * An archiver is a class that is able to package and unpackage one or more files
  3820. * into a single possibly compressed file. Common examples of such files are
  3821. * zip files and tar.gz files. All archiver classes must implement
  3822. * ArchiverInterface.
  3823. *
  3824. * Each entry should be keyed on a unique value, and specify three
  3825. * additional keys:
  3826. * - class: The name of the PHP class for this archiver.
  3827. * - extensions: An array of file extensions that this archiver supports.
  3828. * - weight: This optional key specifies the weight of this archiver.
  3829. * When mapping file extensions to archivers, the first archiver by
  3830. * weight found that supports the requested extension will be used.
  3831. *
  3832. * @see hook_archiver_info_alter()
  3833. */
  3834. function hook_archiver_info() {
  3835. return array(
  3836. 'tar' => array(
  3837. 'class' => 'ArchiverTar',
  3838. 'extensions' => array('tar', 'tar.gz', 'tar.bz2'),
  3839. ),
  3840. );
  3841. }
  3842. /**
  3843. * Alter archiver information declared by other modules.
  3844. *
  3845. * See hook_archiver_info() for a description of archivers and the archiver
  3846. * information structure.
  3847. *
  3848. * @param $info
  3849. * Archiver information to alter (return values from hook_archiver_info()).
  3850. */
  3851. function hook_archiver_info_alter(&$info) {
  3852. $info['tar']['extensions'][] = 'tgz';
  3853. }
  3854. /**
  3855. * Define additional date types.
  3856. *
  3857. * Next to the 'long', 'medium' and 'short' date types defined in core, any
  3858. * module can define additional types that can be used when displaying dates,
  3859. * by implementing this hook. A date type is basically just a name for a date
  3860. * format.
  3861. *
  3862. * Date types are used in the administration interface: a user can assign
  3863. * date format types defined in hook_date_formats() to date types defined in
  3864. * this hook. Once a format has been assigned by a user, the machine name of a
  3865. * type can be used in the format_date() function to format a date using the
  3866. * chosen formatting.
  3867. *
  3868. * To define a date type in a module and make sure a format has been assigned to
  3869. * it, without requiring a user to visit the administrative interface, use
  3870. * @code variable_set('date_format_' . $type, $format); @endcode
  3871. * where $type is the machine-readable name defined here, and $format is a PHP
  3872. * date format string.
  3873. *
  3874. * To avoid namespace collisions with date types defined by other modules, it is
  3875. * recommended that each date type starts with the module name. A date type
  3876. * can consist of letters, numbers and underscores.
  3877. *
  3878. * @return
  3879. * An array of date types where the keys are the machine-readable names and
  3880. * the values are the human-readable labels.
  3881. *
  3882. * @see hook_date_formats()
  3883. * @see format_date()
  3884. */
  3885. function hook_date_format_types() {
  3886. // Define the core date format types.
  3887. return array(
  3888. 'long' => t('Long'),
  3889. 'medium' => t('Medium'),
  3890. 'short' => t('Short'),
  3891. );
  3892. }
  3893. /**
  3894. * Modify existing date types.
  3895. *
  3896. * Allows other modules to modify existing date types like 'long'. Called by
  3897. * _system_date_format_types_build(). For instance, A module may use this hook
  3898. * to apply settings across all date types, such as locking all date types so
  3899. * they appear to be provided by the system.
  3900. *
  3901. * @param $types
  3902. * A list of date types. Each date type is keyed by the machine-readable name
  3903. * and the values are associative arrays containing:
  3904. * - is_new: Set to FALSE to override previous settings.
  3905. * - module: The name of the module that created the date type.
  3906. * - type: The machine-readable date type name.
  3907. * - title: The human-readable date type name.
  3908. * - locked: Specifies that the date type is system-provided.
  3909. */
  3910. function hook_date_format_types_alter(&$types) {
  3911. foreach ($types as $name => $type) {
  3912. $types[$name]['locked'] = 1;
  3913. }
  3914. }
  3915. /**
  3916. * Define additional date formats.
  3917. *
  3918. * This hook is used to define the PHP date format strings that can be assigned
  3919. * to date types in the administrative interface. A module can provide date
  3920. * format strings for the core-provided date types ('long', 'medium', and
  3921. * 'short'), or for date types defined in hook_date_format_types() by itself
  3922. * or another module.
  3923. *
  3924. * Since date formats can be locale-specific, you can specify the locales that
  3925. * each date format string applies to. There may be more than one locale for a
  3926. * format. There may also be more than one format for the same locale. For
  3927. * example d/m/Y and Y/m/d work equally well in some locales. You may wish to
  3928. * define some additional date formats that aren't specific to any one locale,
  3929. * for example, "Y m". For these cases, the 'locales' component of the return
  3930. * value should be omitted.
  3931. *
  3932. * Providing a date format here does not normally assign the format to be
  3933. * used with the associated date type -- a user has to choose a format for each
  3934. * date type in the administrative interface. There is one exception: locale
  3935. * initialization chooses a locale-specific format for the three core-provided
  3936. * types (see locale_get_localized_date_format() for details). If your module
  3937. * needs to ensure that a date type it defines has a format associated with it,
  3938. * call @code variable_set('date_format_' . $type, $format); @endcode
  3939. * where $type is the machine-readable name defined in hook_date_format_types(),
  3940. * and $format is a PHP date format string.
  3941. *
  3942. * @return
  3943. * A list of date formats to offer as choices in the administrative
  3944. * interface. Each date format is a keyed array consisting of three elements:
  3945. * - 'type': The date type name that this format can be used with, as
  3946. * declared in an implementation of hook_date_format_types().
  3947. * - 'format': A PHP date format string to use when formatting dates. It
  3948. * can contain any of the formatting options described at
  3949. * http://php.net/manual/function.date.php
  3950. * - 'locales': (optional) An array of 2 and 5 character locale codes,
  3951. * defining which locales this format applies to (for example, 'en',
  3952. * 'en-us', etc.). If your date format is not language-specific, leave this
  3953. * array empty.
  3954. *
  3955. * @see hook_date_format_types()
  3956. */
  3957. function hook_date_formats() {
  3958. return array(
  3959. array(
  3960. 'type' => 'mymodule_extra_long',
  3961. 'format' => 'l jS F Y H:i:s e',
  3962. 'locales' => array('en-ie'),
  3963. ),
  3964. array(
  3965. 'type' => 'mymodule_extra_long',
  3966. 'format' => 'l jS F Y h:i:sa',
  3967. 'locales' => array('en', 'en-us'),
  3968. ),
  3969. array(
  3970. 'type' => 'short',
  3971. 'format' => 'F Y',
  3972. 'locales' => array(),
  3973. ),
  3974. );
  3975. }
  3976. /**
  3977. * Alter date formats declared by another module.
  3978. *
  3979. * Called by _system_date_format_types_build() to allow modules to alter the
  3980. * return values from implementations of hook_date_formats().
  3981. */
  3982. function hook_date_formats_alter(&$formats) {
  3983. foreach ($formats as $id => $format) {
  3984. $formats[$id]['locales'][] = 'en-ca';
  3985. }
  3986. }
  3987. /**
  3988. * Alters the delivery callback used to send the result of the page callback to the browser.
  3989. *
  3990. * Called by drupal_deliver_page() to allow modules to alter how the
  3991. * page is delivered to the browser.
  3992. *
  3993. * This hook is intended for altering the delivery callback based on
  3994. * information unrelated to the path of the page accessed. For example,
  3995. * it can be used to set the delivery callback based on a HTTP request
  3996. * header (as shown in the code sample). To specify a delivery callback
  3997. * based on path information, use hook_menu() or hook_menu_alter().
  3998. *
  3999. * This hook can also be used as an API function that can be used to explicitly
  4000. * set the delivery callback from some other function. For example, for a module
  4001. * named MODULE:
  4002. * @code
  4003. * function MODULE_page_delivery_callback_alter(&$callback, $set = FALSE) {
  4004. * static $stored_callback;
  4005. * if ($set) {
  4006. * $stored_callback = $callback;
  4007. * }
  4008. * elseif (isset($stored_callback)) {
  4009. * $callback = $stored_callback;
  4010. * }
  4011. * }
  4012. * function SOMEWHERE_ELSE() {
  4013. * $desired_delivery_callback = 'foo';
  4014. * MODULE_page_delivery_callback_alter($desired_delivery_callback, TRUE);
  4015. * }
  4016. * @endcode
  4017. *
  4018. * @param $callback
  4019. * The name of a function.
  4020. *
  4021. * @see drupal_deliver_page()
  4022. */
  4023. function hook_page_delivery_callback_alter(&$callback) {
  4024. // jQuery sets a HTTP_X_REQUESTED_WITH header of 'XMLHttpRequest'.
  4025. // If a page would normally be delivered as an html page, and it is called
  4026. // from jQuery, deliver it instead as an Ajax response.
  4027. if (isset($_SERVER['HTTP_X_REQUESTED_WITH']) && $_SERVER['HTTP_X_REQUESTED_WITH'] == 'XMLHttpRequest' && $callback == 'drupal_deliver_html_page') {
  4028. $callback = 'ajax_deliver';
  4029. }
  4030. }
  4031. /**
  4032. * Alters theme operation links.
  4033. *
  4034. * @param $theme_groups
  4035. * An associative array containing groups of themes.
  4036. *
  4037. * @see system_themes_page()
  4038. */
  4039. function hook_system_themes_page_alter(&$theme_groups) {
  4040. foreach ($theme_groups as $state => &$group) {
  4041. foreach ($theme_groups[$state] as &$theme) {
  4042. // Add a foo link to each list of theme operations.
  4043. $theme->operations[] = array(
  4044. 'title' => t('Foo'),
  4045. 'href' => 'admin/appearance/foo',
  4046. 'query' => array('theme' => $theme->name)
  4047. );
  4048. }
  4049. }
  4050. }
  4051. /**
  4052. * Alters inbound URL requests.
  4053. *
  4054. * @param $path
  4055. * The path being constructed, which, if a path alias, has been resolved to a
  4056. * Drupal path by the database, and which also may have been altered by other
  4057. * modules before this one.
  4058. * @param $original_path
  4059. * The original path, before being checked for path aliases or altered by any
  4060. * modules.
  4061. * @param $path_language
  4062. * The language of the path.
  4063. *
  4064. * @see drupal_get_normal_path()
  4065. */
  4066. function hook_url_inbound_alter(&$path, $original_path, $path_language) {
  4067. // Create the path user/me/edit, which allows a user to edit their account.
  4068. if (preg_match('|^user/me/edit(/.*)?|', $path, $matches)) {
  4069. global $user;
  4070. $path = 'user/' . $user->uid . '/edit' . $matches[1];
  4071. }
  4072. }
  4073. /**
  4074. * Alters outbound URLs.
  4075. *
  4076. * @param $path
  4077. * The outbound path to alter, not adjusted for path aliases yet. It won't be
  4078. * adjusted for path aliases until all modules are finished altering it, thus
  4079. * being consistent with hook_url_inbound_alter(), which adjusts for all path
  4080. * aliases before allowing modules to alter it. This may have been altered by
  4081. * other modules before this one.
  4082. * @param $options
  4083. * A set of URL options for the URL so elements such as a fragment or a query
  4084. * string can be added to the URL.
  4085. * @param $original_path
  4086. * The original path, before being altered by any modules.
  4087. *
  4088. * @see url()
  4089. */
  4090. function hook_url_outbound_alter(&$path, &$options, $original_path) {
  4091. // Use an external RSS feed rather than the Drupal one.
  4092. if ($path == 'rss.xml') {
  4093. $path = 'http://example.com/rss.xml';
  4094. $options['external'] = TRUE;
  4095. }
  4096. // Instead of pointing to user/[uid]/edit, point to user/me/edit.
  4097. if (preg_match('|^user/([0-9]*)/edit(/.*)?|', $path, $matches)) {
  4098. global $user;
  4099. if ($user->uid == $matches[1]) {
  4100. $path = 'user/me/edit' . $matches[2];
  4101. }
  4102. }
  4103. }
  4104. /**
  4105. * Alter the username that is displayed for a user.
  4106. *
  4107. * Called by format_username() to allow modules to alter the username that's
  4108. * displayed. Can be used to ensure user privacy in situations where
  4109. * $account->name is too revealing.
  4110. *
  4111. * @param $name
  4112. * The string that format_username() will return.
  4113. *
  4114. * @param $account
  4115. * The account object passed to format_username().
  4116. *
  4117. * @see format_username()
  4118. */
  4119. function hook_username_alter(&$name, $account) {
  4120. // Display the user's uid instead of name.
  4121. if (isset($account->uid)) {
  4122. $name = t('User !uid', array('!uid' => $account->uid));
  4123. }
  4124. }
  4125. /**
  4126. * Provide replacement values for placeholder tokens.
  4127. *
  4128. * This hook is invoked when someone calls token_replace(). That function first
  4129. * scans the text for [type:token] patterns, and splits the needed tokens into
  4130. * groups by type. Then hook_tokens() is invoked on each token-type group,
  4131. * allowing your module to respond by providing replacement text for any of
  4132. * the tokens in the group that your module knows how to process.
  4133. *
  4134. * A module implementing this hook should also implement hook_token_info() in
  4135. * order to list its available tokens on editing screens.
  4136. *
  4137. * @param $type
  4138. * The machine-readable name of the type (group) of token being replaced, such
  4139. * as 'node', 'user', or another type defined by a hook_token_info()
  4140. * implementation.
  4141. * @param $tokens
  4142. * An array of tokens to be replaced. The keys are the machine-readable token
  4143. * names, and the values are the raw [type:token] strings that appeared in the
  4144. * original text.
  4145. * @param $data
  4146. * (optional) An associative array of data objects to be used when generating
  4147. * replacement values, as supplied in the $data parameter to token_replace().
  4148. * @param $options
  4149. * (optional) An associative array of options for token replacement; see
  4150. * token_replace() for possible values.
  4151. *
  4152. * @return
  4153. * An associative array of replacement values, keyed by the raw [type:token]
  4154. * strings from the original text.
  4155. *
  4156. * @see hook_token_info()
  4157. * @see hook_tokens_alter()
  4158. */
  4159. function hook_tokens($type, $tokens, array $data = array(), array $options = array()) {
  4160. $url_options = array('absolute' => TRUE);
  4161. if (isset($options['language'])) {
  4162. $url_options['language'] = $options['language'];
  4163. $language_code = $options['language']->language;
  4164. }
  4165. else {
  4166. $language_code = NULL;
  4167. }
  4168. $sanitize = !empty($options['sanitize']);
  4169. $replacements = array();
  4170. if ($type == 'node' && !empty($data['node'])) {
  4171. $node = $data['node'];
  4172. foreach ($tokens as $name => $original) {
  4173. switch ($name) {
  4174. // Simple key values on the node.
  4175. case 'nid':
  4176. $replacements[$original] = $node->nid;
  4177. break;
  4178. case 'title':
  4179. $replacements[$original] = $sanitize ? check_plain($node->title) : $node->title;
  4180. break;
  4181. case 'edit-url':
  4182. $replacements[$original] = url('node/' . $node->nid . '/edit', $url_options);
  4183. break;
  4184. // Default values for the chained tokens handled below.
  4185. case 'author':
  4186. $name = ($node->uid == 0) ? variable_get('anonymous', t('Anonymous')) : $node->name;
  4187. $replacements[$original] = $sanitize ? filter_xss($name) : $name;
  4188. break;
  4189. case 'created':
  4190. $replacements[$original] = format_date($node->created, 'medium', '', NULL, $language_code);
  4191. break;
  4192. }
  4193. }
  4194. if ($author_tokens = token_find_with_prefix($tokens, 'author')) {
  4195. $author = user_load($node->uid);
  4196. $replacements += token_generate('user', $author_tokens, array('user' => $author), $options);
  4197. }
  4198. if ($created_tokens = token_find_with_prefix($tokens, 'created')) {
  4199. $replacements += token_generate('date', $created_tokens, array('date' => $node->created), $options);
  4200. }
  4201. }
  4202. return $replacements;
  4203. }
  4204. /**
  4205. * Alter replacement values for placeholder tokens.
  4206. *
  4207. * @param $replacements
  4208. * An associative array of replacements returned by hook_tokens().
  4209. * @param $context
  4210. * The context in which hook_tokens() was called. An associative array with
  4211. * the following keys, which have the same meaning as the corresponding
  4212. * parameters of hook_tokens():
  4213. * - 'type'
  4214. * - 'tokens'
  4215. * - 'data'
  4216. * - 'options'
  4217. *
  4218. * @see hook_tokens()
  4219. */
  4220. function hook_tokens_alter(array &$replacements, array $context) {
  4221. $options = $context['options'];
  4222. if (isset($options['language'])) {
  4223. $url_options['language'] = $options['language'];
  4224. $language_code = $options['language']->language;
  4225. }
  4226. else {
  4227. $language_code = NULL;
  4228. }
  4229. $sanitize = !empty($options['sanitize']);
  4230. if ($context['type'] == 'node' && !empty($context['data']['node'])) {
  4231. $node = $context['data']['node'];
  4232. // Alter the [node:title] token, and replace it with the rendered content
  4233. // of a field (field_title).
  4234. if (isset($context['tokens']['title'])) {
  4235. $title = field_view_field('node', $node, 'field_title', 'default', $language_code);
  4236. $replacements[$context['tokens']['title']] = drupal_render($title);
  4237. }
  4238. }
  4239. }
  4240. /**
  4241. * Provide information about available placeholder tokens and token types.
  4242. *
  4243. * Tokens are placeholders that can be put into text by using the syntax
  4244. * [type:token], where type is the machine-readable name of a token type, and
  4245. * token is the machine-readable name of a token within this group. This hook
  4246. * provides a list of types and tokens to be displayed on text editing screens,
  4247. * so that people editing text can see what their token options are.
  4248. *
  4249. * The actual token replacement is done by token_replace(), which invokes
  4250. * hook_tokens(). Your module will need to implement that hook in order to
  4251. * generate token replacements from the tokens defined here.
  4252. *
  4253. * @return
  4254. * An associative array of available tokens and token types. The outer array
  4255. * has two components:
  4256. * - types: An associative array of token types (groups). Each token type is
  4257. * an associative array with the following components:
  4258. * - name: The translated human-readable short name of the token type.
  4259. * - description: A translated longer description of the token type.
  4260. * - needs-data: The type of data that must be provided to token_replace()
  4261. * in the $data argument (i.e., the key name in $data) in order for tokens
  4262. * of this type to be used in the $text being processed. For instance, if
  4263. * the token needs a node object, 'needs-data' should be 'node', and to
  4264. * use this token in token_replace(), the caller needs to supply a node
  4265. * object as $data['node']. Some token data can also be supplied
  4266. * indirectly; for instance, a node object in $data supplies a user object
  4267. * (the author of the node), allowing user tokens to be used when only
  4268. * a node data object is supplied.
  4269. * - tokens: An associative array of tokens. The outer array is keyed by the
  4270. * group name (the same key as in the types array). Within each group of
  4271. * tokens, each token item is keyed by the machine name of the token, and
  4272. * each token item has the following components:
  4273. * - name: The translated human-readable short name of the token.
  4274. * - description: A translated longer description of the token.
  4275. * - type (optional): A 'needs-data' data type supplied by this token, which
  4276. * should match a 'needs-data' value from another token type. For example,
  4277. * the node author token provides a user object, which can then be used
  4278. * for token replacement data in token_replace() without having to supply
  4279. * a separate user object.
  4280. *
  4281. * @see hook_token_info_alter()
  4282. * @see hook_tokens()
  4283. */
  4284. function hook_token_info() {
  4285. $type = array(
  4286. 'name' => t('Nodes'),
  4287. 'description' => t('Tokens related to individual nodes.'),
  4288. 'needs-data' => 'node',
  4289. );
  4290. // Core tokens for nodes.
  4291. $node['nid'] = array(
  4292. 'name' => t("Node ID"),
  4293. 'description' => t("The unique ID of the node."),
  4294. );
  4295. $node['title'] = array(
  4296. 'name' => t("Title"),
  4297. 'description' => t("The title of the node."),
  4298. );
  4299. $node['edit-url'] = array(
  4300. 'name' => t("Edit URL"),
  4301. 'description' => t("The URL of the node's edit page."),
  4302. );
  4303. // Chained tokens for nodes.
  4304. $node['created'] = array(
  4305. 'name' => t("Date created"),
  4306. 'description' => t("The date the node was posted."),
  4307. 'type' => 'date',
  4308. );
  4309. $node['author'] = array(
  4310. 'name' => t("Author"),
  4311. 'description' => t("The author of the node."),
  4312. 'type' => 'user',
  4313. );
  4314. return array(
  4315. 'types' => array('node' => $type),
  4316. 'tokens' => array('node' => $node),
  4317. );
  4318. }
  4319. /**
  4320. * Alter the metadata about available placeholder tokens and token types.
  4321. *
  4322. * @param $data
  4323. * The associative array of token definitions from hook_token_info().
  4324. *
  4325. * @see hook_token_info()
  4326. */
  4327. function hook_token_info_alter(&$data) {
  4328. // Modify description of node tokens for our site.
  4329. $data['tokens']['node']['nid'] = array(
  4330. 'name' => t("Node ID"),
  4331. 'description' => t("The unique ID of the article."),
  4332. );
  4333. $data['tokens']['node']['title'] = array(
  4334. 'name' => t("Title"),
  4335. 'description' => t("The title of the article."),
  4336. );
  4337. // Chained tokens for nodes.
  4338. $data['tokens']['node']['created'] = array(
  4339. 'name' => t("Date created"),
  4340. 'description' => t("The date the article was posted."),
  4341. 'type' => 'date',
  4342. );
  4343. }
  4344. /**
  4345. * Alter batch information before a batch is processed.
  4346. *
  4347. * Called by batch_process() to allow modules to alter a batch before it is
  4348. * processed.
  4349. *
  4350. * @param $batch
  4351. * The associative array of batch information. See batch_set() for details on
  4352. * what this could contain.
  4353. *
  4354. * @see batch_set()
  4355. * @see batch_process()
  4356. *
  4357. * @ingroup batch
  4358. */
  4359. function hook_batch_alter(&$batch) {
  4360. // If the current page request is inside the overlay, add ?render=overlay to
  4361. // the success callback URL, so that it appears correctly within the overlay.
  4362. if (overlay_get_mode() == 'child') {
  4363. if (isset($batch['url_options']['query'])) {
  4364. $batch['url_options']['query']['render'] = 'overlay';
  4365. }
  4366. else {
  4367. $batch['url_options']['query'] = array('render' => 'overlay');
  4368. }
  4369. }
  4370. }
  4371. /**
  4372. * Provide information on Updaters (classes that can update Drupal).
  4373. *
  4374. * An Updater is a class that knows how to update various parts of the Drupal
  4375. * file system, for example to update modules that have newer releases, or to
  4376. * install a new theme.
  4377. *
  4378. * @return
  4379. * An associative array of information about the updater(s) being provided.
  4380. * This array is keyed by a unique identifier for each updater, and the
  4381. * values are subarrays that can contain the following keys:
  4382. * - class: The name of the PHP class which implements this updater.
  4383. * - name: Human-readable name of this updater.
  4384. * - weight: Controls what order the Updater classes are consulted to decide
  4385. * which one should handle a given task. When an update task is being run,
  4386. * the system will loop through all the Updater classes defined in this
  4387. * registry in weight order and let each class respond to the task and
  4388. * decide if each Updater wants to handle the task. In general, this
  4389. * doesn't matter, but if you need to override an existing Updater, make
  4390. * sure your Updater has a lighter weight so that it comes first.
  4391. *
  4392. * @see drupal_get_updaters()
  4393. * @see hook_updater_info_alter()
  4394. */
  4395. function hook_updater_info() {
  4396. return array(
  4397. 'module' => array(
  4398. 'class' => 'ModuleUpdater',
  4399. 'name' => t('Update modules'),
  4400. 'weight' => 0,
  4401. ),
  4402. 'theme' => array(
  4403. 'class' => 'ThemeUpdater',
  4404. 'name' => t('Update themes'),
  4405. 'weight' => 0,
  4406. ),
  4407. );
  4408. }
  4409. /**
  4410. * Alter the Updater information array.
  4411. *
  4412. * An Updater is a class that knows how to update various parts of the Drupal
  4413. * file system, for example to update modules that have newer releases, or to
  4414. * install a new theme.
  4415. *
  4416. * @param array $updaters
  4417. * Associative array of updaters as defined through hook_updater_info().
  4418. * Alter this array directly.
  4419. *
  4420. * @see drupal_get_updaters()
  4421. * @see hook_updater_info()
  4422. */
  4423. function hook_updater_info_alter(&$updaters) {
  4424. // Adjust weight so that the theme Updater gets a chance to handle a given
  4425. // update task before module updaters.
  4426. $updaters['theme']['weight'] = -1;
  4427. }
  4428. /**
  4429. * Alter the default country list.
  4430. *
  4431. * @param $countries
  4432. * The associative array of countries keyed by ISO 3166-1 country code.
  4433. *
  4434. * @see country_get_list()
  4435. * @see _country_get_predefined_list()
  4436. */
  4437. function hook_countries_alter(&$countries) {
  4438. // Elbonia is now independent, so add it to the country list.
  4439. $countries['EB'] = 'Elbonia';
  4440. }
  4441. /**
  4442. * Control site status before menu dispatching.
  4443. *
  4444. * The hook is called after checking whether the site is offline but before
  4445. * the current router item is retrieved and executed by
  4446. * menu_execute_active_handler(). If the site is in offline mode,
  4447. * $menu_site_status is set to MENU_SITE_OFFLINE.
  4448. *
  4449. * @param $menu_site_status
  4450. * Supported values are MENU_SITE_OFFLINE, MENU_ACCESS_DENIED,
  4451. * MENU_NOT_FOUND and MENU_SITE_ONLINE. Any other value than
  4452. * MENU_SITE_ONLINE will skip the default menu handling system and be passed
  4453. * for delivery to drupal_deliver_page() with a NULL
  4454. * $default_delivery_callback.
  4455. * @param $path
  4456. * Contains the system path that is going to be loaded. This is read only,
  4457. * use hook_url_inbound_alter() to change the path.
  4458. */
  4459. function hook_menu_site_status_alter(&$menu_site_status, $path) {
  4460. // Allow access to my_module/authentication even if site is in offline mode.
  4461. if ($menu_site_status == MENU_SITE_OFFLINE && user_is_anonymous() && $path == 'my_module/authentication') {
  4462. $menu_site_status = MENU_SITE_ONLINE;
  4463. }
  4464. }
  4465. /**
  4466. * Register information about FileTransfer classes provided by a module.
  4467. *
  4468. * The FileTransfer class allows transferring files over a specific type of
  4469. * connection. Core provides classes for FTP and SSH. Contributed modules are
  4470. * free to extend the FileTransfer base class to add other connection types,
  4471. * and if these classes are registered via hook_filetransfer_info(), those
  4472. * connection types will be available to site administrators using the Update
  4473. * manager when they are redirected to the authorize.php script to authorize
  4474. * the file operations.
  4475. *
  4476. * @return array
  4477. * Nested array of information about FileTransfer classes. Each key is a
  4478. * FileTransfer type (not human readable, used for form elements and
  4479. * variable names, etc), and the values are subarrays that define properties
  4480. * of that type. The keys in each subarray are:
  4481. * - 'title': Required. The human-readable name of the connection type.
  4482. * - 'class': Required. The name of the FileTransfer class. The constructor
  4483. * will always be passed the full path to the root of the site that should
  4484. * be used to restrict where file transfer operations can occur (the $jail)
  4485. * and an array of settings values returned by the settings form.
  4486. * - 'file': Required. The include file containing the FileTransfer class.
  4487. * This should be a separate .inc file, not just the .module file, so that
  4488. * the minimum possible code is loaded when authorize.php is running.
  4489. * - 'file path': Optional. The directory (relative to the Drupal root)
  4490. * where the include file lives. If not defined, defaults to the base
  4491. * directory of the module implementing the hook.
  4492. * - 'weight': Optional. Integer weight used for sorting connection types on
  4493. * the authorize.php form.
  4494. *
  4495. * @see FileTransfer
  4496. * @see authorize.php
  4497. * @see hook_filetransfer_info_alter()
  4498. * @see drupal_get_filetransfer_info()
  4499. */
  4500. function hook_filetransfer_info() {
  4501. $info['sftp'] = array(
  4502. 'title' => t('SFTP (Secure FTP)'),
  4503. 'file' => 'sftp.filetransfer.inc',
  4504. 'class' => 'FileTransferSFTP',
  4505. 'weight' => 10,
  4506. );
  4507. return $info;
  4508. }
  4509. /**
  4510. * Alter the FileTransfer class registry.
  4511. *
  4512. * @param array $filetransfer_info
  4513. * Reference to a nested array containing information about the FileTransfer
  4514. * class registry.
  4515. *
  4516. * @see hook_filetransfer_info()
  4517. */
  4518. function hook_filetransfer_info_alter(&$filetransfer_info) {
  4519. if (variable_get('paranoia', FALSE)) {
  4520. // Remove the FTP option entirely.
  4521. unset($filetransfer_info['ftp']);
  4522. // Make sure the SSH option is listed first.
  4523. $filetransfer_info['ssh']['weight'] = -10;
  4524. }
  4525. }
  4526. /**
  4527. * @} End of "addtogroup hooks".
  4528. */
  4529. /**
  4530. * @addtogroup callbacks
  4531. * @{
  4532. */
  4533. /**
  4534. * Return the URI for an entity.
  4535. *
  4536. * Callback for hook_entity_info().
  4537. *
  4538. * @param $entity
  4539. * The entity to return the URI for.
  4540. *
  4541. * @return
  4542. * An associative array with the following elements:
  4543. * - 'path': The URL path for the entity.
  4544. * - 'options': (optional) An array of options for the url() function.
  4545. * The actual entity URI can be constructed by passing these elements to
  4546. * url().
  4547. */
  4548. function callback_entity_info_uri($entity) {
  4549. return array(
  4550. 'path' => 'node/' . $entity->nid,
  4551. );
  4552. }
  4553. /**
  4554. * Return the label of an entity.
  4555. *
  4556. * Callback for hook_entity_info().
  4557. *
  4558. * @param $entity
  4559. * The entity for which to generate the label.
  4560. * @param $entity_type
  4561. * The entity type; e.g., 'node' or 'user'.
  4562. *
  4563. * @return
  4564. * An unsanitized string with the label of the entity.
  4565. *
  4566. * @see entity_label()
  4567. */
  4568. function callback_entity_info_label($entity, $entity_type) {
  4569. return empty($entity->title) ? 'Untitled entity' : $entity->title;
  4570. }
  4571. /**
  4572. * Return the language code of the entity.
  4573. *
  4574. * Callback for hook_entity_info().
  4575. *
  4576. * The language callback is meant to be used primarily for temporary alterations
  4577. * of the property value.
  4578. *
  4579. * @param $entity
  4580. * The entity for which to return the language.
  4581. * @param $entity_type
  4582. * The entity type; e.g., 'node' or 'user'.
  4583. *
  4584. * @return
  4585. * The language code for the language of the entity.
  4586. *
  4587. * @see entity_language()
  4588. */
  4589. function callback_entity_info_language($entity, $entity_type) {
  4590. return $entity->language;
  4591. }
  4592. /**
  4593. * @} End of "addtogroup callbacks".
  4594. */
  4595. /**
  4596. * @defgroup update_api Update versions of API functions
  4597. * @{
  4598. * Functions that are similar to normal API functions, but do not invoke hooks.
  4599. *
  4600. * These simplified versions of core API functions are provided for use by
  4601. * update functions (hook_update_N() implementations).
  4602. *
  4603. * During database updates the schema of any module could be out of date. For
  4604. * this reason, caution is needed when using any API function within an update
  4605. * function - particularly CRUD functions, functions that depend on the schema
  4606. * (for example by using drupal_write_record()), and any functions that invoke
  4607. * hooks.
  4608. *
  4609. * Instead, a simplified utility function should be used. If a utility version
  4610. * of the API function you require does not already exist, then you should
  4611. * create a new function. The new utility function should be named
  4612. * _update_N_mymodule_my_function(). N is the schema version the function acts
  4613. * on (the schema version is the number N from the hook_update_N()
  4614. * implementation where this schema was introduced, or a number following the
  4615. * same numbering scheme), and mymodule_my_function is the name of the original
  4616. * API function including the module's name.
  4617. *
  4618. * Examples:
  4619. * - _update_6000_mymodule_save(): This function performs a save operation
  4620. * without invoking any hooks using the 6.x schema.
  4621. * - _update_7000_mymodule_save(): This function performs the same save
  4622. * operation using the 7.x schema.
  4623. *
  4624. * The utility function should not invoke any hooks, and should perform database
  4625. * operations using functions from the
  4626. * @link database Database abstraction layer, @endlink
  4627. * like db_insert(), db_update(), db_delete(), db_query(), and so on.
  4628. *
  4629. * If a change to the schema necessitates a change to the utility function, a
  4630. * new function should be created with a name based on the version of the schema
  4631. * it acts on. See _update_7000_bar_get_types() and _update_7001_bar_get_types()
  4632. * in the code examples that follow.
  4633. *
  4634. * For example, foo.install could contain:
  4635. * @code
  4636. * function foo_update_dependencies() {
  4637. * // foo_update_7010() needs to run after bar_update_7000().
  4638. * $dependencies['foo'][7010] = array(
  4639. * 'bar' => 7000,
  4640. * );
  4641. *
  4642. * // foo_update_7036() needs to run after bar_update_7001().
  4643. * $dependencies['foo'][7036] = array(
  4644. * 'bar' => 7001,
  4645. * );
  4646. *
  4647. * return $dependencies;
  4648. * }
  4649. *
  4650. * function foo_update_7000() {
  4651. * // No updates have been run on the {bar_types} table yet, so this needs
  4652. * // to work with the 6.x schema.
  4653. * foreach (_update_6000_bar_get_types() as $type) {
  4654. * // Rename a variable.
  4655. * }
  4656. * }
  4657. *
  4658. * function foo_update_7010() {
  4659. * // Since foo_update_7010() is going to run after bar_update_7000(), it
  4660. * // needs to operate on the new schema, not the old one.
  4661. * foreach (_update_7000_bar_get_types() as $type) {
  4662. * // Rename a different variable.
  4663. * }
  4664. * }
  4665. *
  4666. * function foo_update_7036() {
  4667. * // This update will run after bar_update_7001().
  4668. * foreach (_update_7001_bar_get_types() as $type) {
  4669. * }
  4670. * }
  4671. * @endcode
  4672. *
  4673. * And bar.install could contain:
  4674. * @code
  4675. * function bar_update_7000() {
  4676. * // Type and bundle are confusing, so we renamed the table.
  4677. * db_rename_table('bar_types', 'bar_bundles');
  4678. * }
  4679. *
  4680. * function bar_update_7001() {
  4681. * // Database table names should be singular when possible.
  4682. * db_rename_table('bar_bundles', 'bar_bundle');
  4683. * }
  4684. *
  4685. * function _update_6000_bar_get_types() {
  4686. * db_query('SELECT * FROM {bar_types}')->fetchAll();
  4687. * }
  4688. *
  4689. * function _update_7000_bar_get_types() {
  4690. * db_query('SELECT * FROM {bar_bundles'})->fetchAll();
  4691. * }
  4692. *
  4693. * function _update_7001_bar_get_types() {
  4694. * db_query('SELECT * FROM {bar_bundle}')->fetchAll();
  4695. * }
  4696. * @endcode
  4697. *
  4698. * @see hook_update_N()
  4699. * @see hook_update_dependencies()
  4700. */
  4701. /**
  4702. * @} End of "defgroup update_api".
  4703. */