当前浏览:首页 / WordPress函数 / add_plugins_page()

add_plugins_page( string $page_title, string $menu_title, string $capability, string $menu_slug, callable $callback = '', int $position = null )

将子菜单页添加到插件主菜单

addmore...

menu_page 菜单页more...


描述

这个函数接受一个能力(capability),它将被用来确定一个页面是否包括在菜单中。

用于处理页面输出的函数必须检查用户是否具有所需的能力。


参数

$page_title

(string)(必填) 选中菜单时要在页面标题标签中显示的文本。

$menu_title

(string)(必填) 要用于菜单的文本。

$capability

(string)(必填) 向用户显示此菜单所需的能力。

$menu_slug

(string)(必填) 用于引用此菜单的slug名称(对于此菜单应是唯一的)。

$callback

(callable)(可选) 要调用以输出此页面内容的函数。

默认值: ''

$position

(int)(可选) 此项应出现在菜单顺序中的位置。

默认值: null


返回

(string|false) 返回结果页面的hook_suffix,如果用户不具备所需的能力则返回false。


更多信息

此函数是调用add_submenu_page()的简单包装器,传递接收到的参数并指定'plugins.php'作为$parent_slug参数。这意味着新页面将作为子菜单添加到插件菜单



源码

查看源码 官方文档


更新日志

版本描述
5.3.0添加了$position参数。
3.0.0开始引入

使用示例

  • 示例1

    基本插件页面示例
    典型用法出现在使用admin_menu挂钩注册的函数中(请参阅添加管理菜单):

    /**
     * Add a plugin page.
     */
    function wpdocs_plugin_menu() {
    	add_plugins_page(
    		__( 'WPDocs Plugin Page', 'textdomain' ),
    		__( 'WPDocs Plugin', 'textdomain' ),
    		'read',
    		'wpdocs-unique-identifier',
    		'wpdocs_plugin_function'
    	);
    }
    add_action( 'admin_menu', 'wpdocs_plugin_menu' );