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