Adds a 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_titlestringrequired

The text to be displayed in the title tags of the page when the menu is selected.

$menu_titlestringrequired

The text to be used for the menu.

$capabilitystringrequired

The capability required for this menu to be displayed to the user.

$menu_slugstringrequired

The slug name to refer to this menu by (should be unique for this menu).

$callbackcallableoptional

The function to be called to output the content for this page.

Default:''

$positionintoptional

The position in the menu order this item should appear.

Default:null

Return

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

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 all references View on Trac View on GitHub

Changelog