add_users_page()函数是Wordpress函数,将子菜单页添加到用户/配置文件主菜单。
add_users_page( string $page_title, string $menu_title, string $capability, string $menu_slug, callable $function = ”, int $position = null )
说明(Description)
此函数具有用于确定菜单中是否包含页面的功能。
连接以处理页面输出的函数必须检查用户是否也具有所需的功能。
参数(Parameters)
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
$page_title | (string) | 必需 | 选择菜单时要在页面标题标记中显示的文本。 |
$menu_title | (string) | 必需 | 用于菜单的文本。 |
$capability | (string) | 必需 | 向用户显示此菜单所需的功能。 |
$menu_slug | (string) | 必需 | 用于引用此菜单的slug名称(对于此菜单应是唯一的)。 |
$function | (callable) | 可选 | 要调用以输出此页内容的函数。 |
$position | (int) | 可选 | 此项在菜单中的显示顺序。 |
返回(Return)
(string|false)结果页的hook_后缀,如果用户没有所需的功能,则为false。
源码(Source)
/**
* Add sub menu 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.
*
* @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
* @param string $menu_title The text to be used for the menu
* @param string $capability The capability required for this menu to be displayed to the user.
* @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
* @param callback $function The function to be called to output the content for this page.
*
* @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
*/
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 );
}
更新版本 | 源码位置 | 使用 | 被使用 |
---|---|---|---|
5.3.0 | wp-admin/includes/plugin.php:1566 | 0 | 2 |
笔记(Notes)
基本示例