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

Add submenu page to the Users/Profile main menu.


Description 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 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: ''


Top ↑

Return Return

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


Top ↑

Source Source

File: wp-admin/includes/plugin.php

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


Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note content
    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.