add_options_page() WordPress Function
The add_options_page function allows you to add a new options page to the WordPress admin panel. The function takes three arguments: the page title, the menu title, and the capability required to view the page. The first argument is the page title. This is the title that will be displayed at the top of the page. The second argument is the menu title. This is the title that will be displayed in the WordPress admin menu. The third argument is the capability required to view the page. This argument determines who will be able to see the page in the WordPress admin menu. By default, only administrators will be able to see the page.
add_options_page( string $page_title, string $menu_title, string $capability, string $menu_slug, callable $callback = '', int $position = null ) #
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_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 value: ''
- $position
(int)(Optional) The position in the menu order this item should appear.
Default value: 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_slugargument. This means the new options page will be added as a sub menu to the Settings menu. - The
$capabilityparameter 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
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 );
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 5.3.0 | Added the $position parameter. |
| 1.5.0 | Introduced. |