function shortcut_default_set

Same name in other branches
  1. 9 core/modules/shortcut/shortcut.module \shortcut_default_set()
  2. 8.9.x core/modules/shortcut/shortcut.module \shortcut_default_set()
  3. 10 core/modules/shortcut/shortcut.module \shortcut_default_set()

Returns the default shortcut set for a given user account.

Parameters

object $account: (optional) The user account whose default shortcut set will be returned. If not provided, the function will return the currently logged-in user's default shortcut set.

Return value

An object representing the default shortcut set.

5 calls to shortcut_default_set()
ShortcutSetsTestCase::testShortcutSetUnassign in modules/shortcut/shortcut.test
Tests unassigning a shortcut set.
shortcut_current_displayed_set in modules/shortcut/shortcut.module
Returns the current displayed shortcut set for the provided user account.
shortcut_set_add_form_submit in modules/shortcut/shortcut.admin.inc
Submit handler for shortcut_set_add_form().
shortcut_set_switch in modules/shortcut/shortcut.admin.inc
Form callback: builds the form for switching shortcut sets.
shortcut_set_switch_submit in modules/shortcut/shortcut.admin.inc
Submit handler for shortcut_set_switch().

File

modules/shortcut/shortcut.module, line 521

Code

function shortcut_default_set($account = NULL) {
    global $user;
    if (!isset($account)) {
        $account = $user;
    }
    // Allow modules to return a default shortcut set name. Since we can only
    // have one, we allow the last module which returns a valid result to take
    // precedence. If no module returns a valid set, fall back on the site-wide
    // default, which is the lowest-numbered shortcut set.
    $suggestions = array_reverse(module_invoke_all('shortcut_default_set', $account));
    $suggestions[] = SHORTCUT_DEFAULT_SET_NAME;
    foreach ($suggestions as $name) {
        if ($shortcut_set = shortcut_set_load($name)) {
            break;
        }
    }
    return $shortcut_set;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.