W3cubDocs

/WordPress

add_users_page( string $page_title, string $menu_title, string $capability, string $menu_slug, callable $function = '', int $position = null )

Add submenu page to the Users/Profile main menu.

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.

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).

$function

(callable) (Optional) The function to be called to output the content for this page.

Default value: ''

$position

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

Default value: null

Return

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

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.

Source

File: wp-admin/includes/plugin.php 

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

Uses

Uses Description
wp-admin/includes/plugin.php: add_submenu_page()

Add a submenu page.
wp-includes/capabilities.php: current_user_can()

Returns whether the current user has the specified capability.

Changelog

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

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/add_users_page