W3cubDocs

/WordPress

add_theme_page( string $page_title, string $menu_title, string $capability, string $menu_slug, callable $function = '', int $position = null )

Add 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).

$function

(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, $function = '', $position = null ) {
	return add_submenu_page( 'themes.php', $page_title, $menu_title, $capability, $menu_slug, $function, $position );
}

Uses

Uses Description
wp-admin/includes/plugin.php: add_submenu_page()

Add a submenu page.

Used By

Used By Description
wp-admin/includes/class-custom-image-header.php: Custom_Image_Header::init()

Set up the hooks for the Custom Header admin page.
wp-admin/includes/class-custom-background.php: Custom_Background::init()

Set up the hooks for the Custom Background admin page.

Changelog

Version Description
5.3.0 Added the $position parameter.
2.0.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/add_theme_page