add_options_page( string $page_title, string $menu_title, string $capability, string $menu_slug, callable $callback = '', int $position = null ): string|false
Adds a submenu page to the Settings main menu.
Contents
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_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).
-
$callback
callable Optional -
The function to be called to output the content for this page.
Default:
''
-
$position
int Optional -
The position in the menu order this item should appear.
Default:
null
Return
string|false The resulting page's hook_suffix, or false if the user does not have the capability required.
More Information
- This function is a simple wrapper for a call to add_submenu_page() , passing the received arguments and specifying ‘
options-general.php
‘ as the$parent_slug
argument. This means the new options page will be added as a sub menu to the Settings menu. - The
$capability
parameter is used to determine whether or not the page is included in the menu based on the Roles and Capabilities) of the current user. - The function handling the output of the options page should also verify the user’s capabilities.
- If there are spaces in the
slug
, then these will be stripped out when the URL is generated. This will result in an error message telling you that you do not have sufficient permissions to view the page.
Source
File: wp-admin/includes/plugin.php
.
View all references
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 );
}
Changelog
Version | Description |
---|---|
5.3.0 | Added the $position parameter. |
1.5.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
Object Oriented options page helper / view
Basic Example
Typical usage occurs in a function registered with the ‘admin_menu’ hook (see Adding Administration Menus):
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():