add_options_page()
云策文档标注
概述
add_options_page() 函数用于在 WordPress 后台的“设置”主菜单下添加一个子菜单页面。它是 add_submenu_page() 的包装函数，简化了选项页面的创建过程。
关键要点
- 函数将页面添加为“设置”菜单的子菜单，通过指定父菜单 slug 为 'options-general.php' 实现。
- 参数包括页面标题、菜单标题、所需权限、菜单 slug、回调函数和位置，其中权限参数用于控制菜单显示。
- 返回值为页面的 hook_suffix 或 false（如果用户权限不足），输出函数需验证用户权限。
- 菜单 slug 中的空格在 URL 生成时会被移除，可能导致权限错误。
- 应在 admin_menu 钩子中调用此函数，避免过早挂钩导致权限问题。
代码示例
// 基本示例：在 admin_menu 钩子中注册选项页面
function wpdocs_my_plugin_menu() {
add_options_page(
__( 'My Options', 'textdomain' ),
__( 'My Plugin', 'textdomain' ),
'manage_options',
'my-plugin.php',
'my_plugin_page'
);
}
add_action( 'admin_menu', 'wpdocs_my_plugin_menu' );注意事项
- 确保在 admin_menu 钩子中调用函数，而非 admin_init，以避免权限错误。
- 输出函数必须检查用户是否具有所需权限，以增强安全性。
- 菜单 slug 应唯一，避免空格，防止 URL 生成问题。
原文内容
Adds a submenu page to the Settings 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.
$positionintoptional-
The position in the menu order this item should appear.
Default:
null
Source
function add_options_page( $page_title, $menu_title, $capability, $menu_slug, $callback = '', $position = null ) {
return add_submenu_page( 'options-general.php', $page_title, $menu_title, $capability, $menu_slug, $callback, $position );
}
Skip to note 4 content
Codex
Object Oriented options page helper / view
/** * Class for registering a new settings page under Settings. */ class WPDocs_Options_Page { /** * Constructor. */ function __construct() { add_action( 'admin_menu', array( $this, 'admin_menu' ) ); } /** * Registers a new settings page under Settings. */ function admin_menu() { add_options_page( __( 'Page Title', 'textdomain' ), __( 'Circle Tree Login', 'textdomain' ), 'manage_options', 'options_page_slug', array( $this, 'settings_page' ) ); } /** * Settings page display callback. */ function settings_page() { echo __( 'This is the page content', 'textdomain' ); } } new WPDocs_Options_Page;Skip to note 5 content
Codex
Basic Example
Typical usage occurs in a function registered with the ‘admin_menu’ hook (see Adding Administration Menus):
/** * Registers a new options page under Settings. */ function wpdocs_my_plugin_menu() { add_options_page( __( 'My Options', 'textdomain' ), __( 'My Plugin', 'textdomain' ), 'manage_options', 'my-plugin.php', 'my_plugin_page' ); }Skip to note 6 content
Dave
Please hook this to admin_menu (not admin_init as seen in other articles on the web).
Per the documentation for the wrapped add_sub_menu_page():