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

Add submenu page to the Appearance main menu.


Description 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 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: ''


Top ↑

Return Return

(false|string) The resulting page's hook_suffix, or false if the user does not have the capability required.


Top ↑

Source Source

File: wp-admin/includes/plugin.php

function add_theme_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
	return add_submenu_page( 'themes.php', $page_title, $menu_title, $capability, $menu_slug, $function );
}


Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note content
    Contributed by johnnyhuy

    This is from the WordPress Codex, which states that add_theme_page must be called early. Therefore, calling the function in the ‘admin_init’ hook will make role capabilities invalid in regard to theme page created.

    Use the ‘admin_menu’ hook instead using an example as shown:

    function add_test_theme_page() {
    	add_theme_page( 'Theme Title Settings', 'Theme Menu Settings', 'manage_theme_options', 'test-theme-options', 'theme_option_page' );
    }
    add_action( 'admin_menu', 'add_test_theme_page' );
    
    function theme_option_page() {
    	echo 'This is a test theme options page!';
    }
    

You must log in before being able to contribute a note or feedback.