add_users_page( string $page_title, string $menu_title, string $capability, string $menu_slug, callable $callback = '', int $position = null ): string|false

Adds a submenu page to the Users/Profile main menu.

Contents

Description

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.

Top ↑

Parameters

$page_title string Required
The text to be displayed in the title tags of the page when the menu is selected.
$menu_title string Required
The text to be used for the menu.
$capability string Required
The capability required for this menu to be displayed to the user.
$menu_slug string Required
The slug name to refer to this menu by (should be unique for this menu).
$callback callable Optional
The function to be called to output the content for this page.

Default: ''

$position int Optional
The position in the menu order this item should appear.

Default: null

Top ↑

Return

string|false The resulting page's hook_suffix, or false if the user does not have the capability required.

Top ↑

More Information

  • NOTE: If you’re running into the »You do not have sufficient permissions to access this page.« message in a `wp_die() ` screen, then you’ve hooked too early. The hook you should use is `admin_menu`.
  • This function is a simple wrapper for a call to add_submenu_page() , passing the received arguments and specifying ‘users.php‘ or ‘profile.php‘ (depending upon the users’ capability) as the $parent_slug argument. This means the new page will be added as a sub-menu to the Users or Profile menu.
  • The Users menu is only available to users with the ability to edit other users. Users with capability below this level will see a Profile menu instead.

Top ↑

Source

File: wp-admin/includes/plugin.php. View all references 

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 );
}

View on Trac View on GitHub

Top ↑

Top ↑

Changelog

Changelog
Version Description
5.3.0 Added the $position parameter.
2.1.3 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Basic Example

    Typical usage occurs in a function registered with the ‘admin_menu‘ hook (see Adding Administration Menus):

    /**
 * Register a new page under "Users".
 */
function wpdocs_my_users_menu() {
	add_users_page(
		__( 'My Plugin Users', 'textdomain' ),
		__( 'My Plugin', 'textdomain' ),
		'read',
		'my-unique-identifier',
		'my_plugin_function'
	);
}
add_action('admin_menu', 'wpdocs_my_users_menu');

You must log in before being able to contribute a note or feedback.