Hooks provided by the Shortcut module.
<?php
/**
* @file
* Hooks provided by the Shortcut module.
*/
/**
* @addtogroup hooks
* @{
*/
/**
* Return the name of a default shortcut set for the provided user account.
*
* This hook allows modules to define default shortcut sets for a particular
* user that differ from the site-wide default (for example, a module may want
* to define default shortcuts on a per-role basis).
*
* The default shortcut set is used only when the user does not have any other
* shortcut set explicitly assigned to them.
*
* Note that only one default shortcut set can exist per user, so when multiple
* modules implement this hook, the last (i.e., highest weighted) module which
* returns a valid shortcut set name will prevail.
*
* @param $account
* The user account whose default shortcut set is being requested.
* @return
* The name of the shortcut set that this module recommends for that user, if
* there is one.
*/
function hook_shortcut_default_set($account) {
// Use a special set of default shortcuts for administrators only.
if (in_array(variable_get('user_admin_role', 0), $account->roles)) {
return variable_get('mymodule_shortcut_admin_default_set');
}
}
/**
* @} End of "addtogroup hooks".
*/
Name | Description |
---|---|
hook_shortcut_default_set | Return the name of a default shortcut set for the provided user account. |