add_users_page

The timeline below displays how wordpress function add_users_page has changed across different WordPress versions. If a version is not listed, refer to the next available version below.

WordPress Version: 6.1

/**
 * Adds a submenu page to the Users/Profile main menu.
 *
 * This function takes a capability which will be used to determine whether
 * or not a page is included in the menu.
 *
 * The function which is hooked in to handle the output of the page must check
 * that the user has the required capability as well.
 *
 * @since 2.1.3
 * @since 5.3.0 Added the `$position` parameter.
 *
 * @param string   $page_title The text to be displayed in the title tags of the page when the menu is selected.
 * @param string   $menu_title The text to be used for the menu.
 * @param string   $capability The capability required for this menu to be displayed to the user.
 * @param string   $menu_slug  The slug name to refer to this menu by (should be unique for this menu).
 * @param callable $callback   Optional. The function to be called to output the content for this page.
 * @param int      $position   Optional. The position in the menu order this item should appear.
 * @return string|false The resulting page's hook_suffix, or false if the user does not have the capability required.
 */
function add_users_page($page_title, $menu_title, $capability, $menu_slug, $callback = '', $position = null)
{
    if (current_user_can('edit_users')) {
        $parent = 'users.php';
    } else {
        $parent = 'profile.php';
    }
    return add_submenu_page($parent, $page_title, $menu_title, $capability, $menu_slug, $callback, $position);
}

WordPress Version: 5.9

/**
 * Adds a submenu page to the Users/Profile main menu.
 *
 * This function takes a capability which will be used to determine whether
 * or not a page is included in the menu.
 *
 * The function which is hooked in to handle the output of the page must check
 * that the user has the required capability as well.
 *
 * @since 2.1.3
 * @since 5.3.0 Added the `$position` parameter.
 *
 * @param string   $page_title The text to be displayed in the title tags of the page when the menu is selected.
 * @param string   $menu_title The text to be used for the menu.
 * @param string   $capability The capability required for this menu to be displayed to the user.
 * @param string   $menu_slug  The slug name to refer to this menu by (should be unique for this menu).
 * @param callable $function   Optional. The function to be called to output the content for this page.
 * @param int      $position   Optional. The position in the menu order this item should appear.
 * @return string|false The resulting page's hook_suffix, or false if the user does not have the capability required.
 */
function add_users_page($page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null)
{
    if (current_user_can('edit_users')) {
        $parent = 'users.php';
    } else {
        $parent = 'profile.php';
    }
    return add_submenu_page($parent, $page_title, $menu_title, $capability, $menu_slug, $function, $position);
}

WordPress Version: 5.4

/**
 * Add submenu page to the Users/Profile main menu.
 *
 * This function takes a capability which will be used to determine whether
 * or not a page is included in the menu.
 *
 * The function which is hooked in to handle the output of the page must check
 * that the user has the required capability as well.
 *
 * @since 2.1.3
 * @since 5.3.0 Added the `$position` parameter.
 *
 * @param string   $page_title The text to be displayed in the title tags of the page when the menu is selected.
 * @param string   $menu_title The text to be used for the menu.
 * @param string   $capability The capability required for this menu to be displayed to the user.
 * @param string   $menu_slug  The slug name to refer to this menu by (should be unique for this menu).
 * @param callable $function   The function to be called to output the content for this page.
 * @param int      $position   The position in the menu order this item should appear.
 * @return string|false The resulting page's hook_suffix, or false if the user does not have the capability required.
 */
function add_users_page($page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null)
{
    if (current_user_can('edit_users')) {
        $parent = 'users.php';
    } else {
        $parent = 'profile.php';
    }
    return add_submenu_page($parent, $page_title, $menu_title, $capability, $menu_slug, $function, $position);
}

WordPress Version: 5.3

/**
 * Add submenu page to the Users/Profile main menu.
 *
 * This function takes a capability which will be used to determine whether
 * or not a page is included in the menu.
 *
 * The function which is hooked in to handle the output of the page must check
 * that the user has the required capability as well.
 *
 * @since 2.1.3
 * @since 5.3.0 Added the `$position` parameter.
 *
 * @param string   $page_title The text to be displayed in the title tags of the page when the menu is selected.
 * @param string   $menu_title The text to be used for the menu.
 * @param string   $capability The capability required for this menu to be displayed to the user.
 * @param string   $menu_slug  The slug name to refer to this menu by (should be unique for this menu).
 * @param callable $function   The function to be called to output the content for this page.
 * @param int      $position   The position in the menu order this item should appear.
 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
 */
function add_users_page($page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null)
{
    if (current_user_can('edit_users')) {
        $parent = 'users.php';
    } else {
        $parent = 'profile.php';
    }
    return add_submenu_page($parent, $page_title, $menu_title, $capability, $menu_slug, $function, $position);
}

WordPress Version: 5.1

/**
 * Add submenu page to the Users/Profile main menu.
 *
 * This function takes a capability which will be used to determine whether
 * or not a page is included in the menu.
 *
 * The function which is hooked in to handle the output of the page must check
 * that the user has the required capability as well.
 *
 * @since 2.1.3
 *
 * @param string   $page_title The text to be displayed in the title tags of the page when the menu is selected.
 * @param string   $menu_title The text to be used for the menu.
 * @param string   $capability The capability required for this menu to be displayed to the user.
 * @param string   $menu_slug  The slug name to refer to this menu by (should be unique for this menu).
 * @param callable $function   The function to be called to output the content for this page.
 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
 */
function add_users_page($page_title, $menu_title, $capability, $menu_slug, $function = '')
{
    if (current_user_can('edit_users')) {
        $parent = 'users.php';
    } else {
        $parent = 'profile.php';
    }
    return add_submenu_page($parent, $page_title, $menu_title, $capability, $menu_slug, $function);
}

WordPress Version: 4.4

/**
 * Add submenu page to the Users/Profile main menu.
 *
 * This function takes a capability which will be used to determine whether
 * or not a page is included in the menu.
 *
 * The function which is hooked in to handle the output of the page must check
 * that the user has the required capability as well.
 *
 * @param string   $page_title The text to be displayed in the title tags of the page when the menu is selected.
 * @param string   $menu_title The text to be used for the menu.
 * @param string   $capability The capability required for this menu to be displayed to the user.
 * @param string   $menu_slug  The slug name to refer to this menu by (should be unique for this menu).
 * @param callable $function   The function to be called to output the content for this page.
 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
 */
function add_users_page($page_title, $menu_title, $capability, $menu_slug, $function = '')
{
    if (current_user_can('edit_users')) {
        $parent = 'users.php';
    } else {
        $parent = 'profile.php';
    }
    return add_submenu_page($parent, $page_title, $menu_title, $capability, $menu_slug, $function);
}

WordPress Version: 4.1

/**
 * Add sub menu page to the Users/Profile main menu.
 *
 * This function takes a capability which will be used to determine whether
 * or not a page is included in the menu.
 *
 * The function which is hooked in to handle the output of the page must check
 * that the user has the required capability as well.
 *
 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
 * @param string $menu_title The text to be used for the menu
 * @param string $capability The capability required for this menu to be displayed to the user.
 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
 * @param callback $function The function to be called to output the content for this page.
 *
 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
 */
function add_users_page($page_title, $menu_title, $capability, $menu_slug, $function = '')
{
    if (current_user_can('edit_users')) {
        $parent = 'users.php';
    } else {
        $parent = 'profile.php';
    }
    return add_submenu_page($parent, $page_title, $menu_title, $capability, $menu_slug, $function);
}

WordPress Version: 3.7

/**
 * Add sub menu page to the Users/Profile main menu.
 *
 * This function takes a capability which will be used to determine whether
 * or not a page is included in the menu.
 *
 * The function which is hooked in to handle the output of the page must check
 * that the user has the required capability as well.
 *
 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
 * @param string $menu_title The text to be used for the menu
 * @param string $capability The capability required for this menu to be displayed to the user.
 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
 * @param callback $function The function to be called to output the content for this page.
 *
 * @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required.
 */
function add_users_page($page_title, $menu_title, $capability, $menu_slug, $function = '')
{
    if (current_user_can('edit_users')) {
        $parent = 'users.php';
    } else {
        $parent = 'profile.php';
    }
    return add_submenu_page($parent, $page_title, $menu_title, $capability, $menu_slug, $function);
}