add_theme_page() WordPress Function
If you're looking to add a new page to your WordPress site, the add_theme_page() function is the perfect tool for the job. This function allows you to add a new page to your site's admin area, complete with its own menu item. Best of all, you can entirely customize the new page to suit your needs.
add_theme_page( string $page_title, string $menu_title, string $capability, string $menu_slug, callable $callback = '', int $position = null ) #
Adds a submenu page to the Appearance 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 'themes.php'as the $parent_slug argument. This means the new page will be added as a sub menu to the Appearance 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.
Source
File: wp-admin/includes/plugin.php
function add_theme_page( $page_title, $menu_title, $capability, $menu_slug, $callback = '', $position = null ) {
return add_submenu_page( 'themes.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. |
| 2.0.0 | Introduced. |