wpseek.com
A WordPress-centric search engine for devs and theme authors



add_users_page › WordPress Function

Since2.1.3
Deprecatedn/a
› add_users_page ( $page_title, $menu_title, $capability, $menu_slug, $callback = '', $position = null )
Parameters: (6)
  • (string) $page_title The text to be displayed in the title tags of the page when the menu is selected.
    Required: Yes
  • (string) $menu_title The text to be used for the menu.
    Required: Yes
  • (string) $capability The capability required for this menu to be displayed to the user.
    Required: Yes
  • (string) $menu_slug The slug name to refer to this menu by (should be unique for this menu).
    Required: Yes
  • (callable) $callback Optional. The function to be called to output the content for this page.
    Required: No
    Default: (empty)
  • (int) $position Optional. The position in the menu order this item should appear.
    Required: No
    Default: null
Returns:
  • (string|false) The resulting page's hook_suffix, or false if the user does not have the capability required.
Defined at:
Codex:
Change Log:
  • 5.3.0

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.


Related Functions: add_pages_page, add_posts_page, add_menu_page, add_user_meta, add_query_arg

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