add_submenu_page()WP 1.5.0

Add a submenu page. 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.

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.

No Hooks.

Return

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

Usage

add_submenu_page( $parent_slug, $page_title, $menu_title, $capability, $menu_slug, $callback, $position );
$parent_slug(string) (required)
The slug name for the parent menu (or the file name of a standard WordPress admin page).
$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 and only include lowercase alphanumeric, dashes, and underscores characters to be compatible with sanitize_key().
$callback(callable)
The function to be called to output the content for this page.
Default: ''
$position(int|float)
The position in the menu order this item should appear.
Default: null

Examples

0

#1 A submenu for the custom-created menu

If you try to add a menu item to the main section that you created yourself using add_menu_page(), the first item will be a copy of the created item add_menu_page(). This can be seen throughout the entire WordPress menu.

If you need a submenu item in this scenario, you first need to create a take of the main menu and then add a submenu:

add_action( 'admin_menu', function(){

	add_menu_page( 'Main additional menu', 'My main menu', 'manage_options', 'my-top-level-slug' );

	add_submenu_page( 'my-top-level-slug', 'main additional menu', 'my main menu', 'manage_options', 'my-top-level-slug' );

	add_submenu_page( 'my-top-level-slug', 'my-submenu', 'my-submenu settings page', 'manage_options', 'my-secondary-slug', 'page_callback_function' );

} );
0

#2 Let's add a submenu to the "Tools" menu of the admin panel:

// Let's add a submenu to the "Tools" menu of the admin panel:
add_action( 'admin_menu', 'register_my_custom_submenu_page' );

function register_my_custom_submenu_page() {

	add_submenu_page(
		'tools.php',
		'Additional Tool Page',
		'Tool Name',
		'manage_options',
		'my-custom-submenu-page',
		'my_custom_submenu_page_callback'
	);
}

// page content
function my_custom_submenu_page_callback() {
	?>
	<div class="wrap">
		<h2><?= get_admin_page_title() ?></h2>
	</div>
	<?php
}
0

#3 Hide the page from the menu, but it will still be working

To hide a submenu item link from the main admin menu, set null or 'options.php' to the first parameter:

<?php
// Hide the page from the menu, but it will still be working
add_action( 'admin_menu', 'register_my_custom_submenu_page' );

function register_my_custom_submenu_page() {

	add_submenu_page(
		null,  //or 'options.php'
		'Arbitrary submenu page',
		'Arbitrary submenu page',
		'manage_options',
		'my-custom-submenu-page',
		'my_custom_submenu_page_callback'
	);
}

// page content
function my_custom_submenu_page_callback() {
	?>
	<div class="wrap">
		<h2>Hidden Page Title</h2>
	</div>
	<?php
}

Now going to the /wp-admin/tools.php?page=my-custom-submenu-page page, we will see the page, but it will not be visible in the admin menu:

0

#4 Without the function of the settings page (unofficially)

The official documentation does not have this.

In the $menu_slug parameter, you can specify the path to the options page, from the plugins directory. In this case, we do not need to specify the function which is responsible for the code of the options page. For options pages we will have a separate file.

Suppose our settings page file is in the root of the plugin folder and called options.php, then the plugin settings page is registered as follows:

add_action( 'admin_menu', 'add_options_page' );

function add_options_page(){

	add_submenu_page( 
		'options-general.php', 
		'Page title', 
		'Menu item name', 
		'manage_options', 
		basename( __DIR__ ) . '/options.php'
	);
}

Here basename( __DIR__ ) . '/options.php' equals to `plugin_folder_name/options.php'.

0

#5 Checking the presence of a submenu item

See add_menu_page() for examples

Notes

  • Global. Array. $submenu
  • Global. Array. $menu
  • Global. Array. $_wp_real_parent_file
  • Global. true|false. $_wp_submenu_nopriv
  • Global. Array. $_registered_pages
  • Global. Array. $_parent_pages

Changelog

Since 1.5.0 Introduced.
Since 5.3.0 Added the $position parameter.

Code of add_submenu_page() WP 6.0.1

function add_submenu_page( $parent_slug, $page_title, $menu_title, $capability, $menu_slug, $callback = '', $position = null ) {
	global $submenu, $menu, $_wp_real_parent_file, $_wp_submenu_nopriv,
		$_registered_pages, $_parent_pages;

	$menu_slug   = plugin_basename( $menu_slug );
	$parent_slug = plugin_basename( $parent_slug );

	if ( isset( $_wp_real_parent_file[ $parent_slug ] ) ) {
		$parent_slug = $_wp_real_parent_file[ $parent_slug ];
	}

	if ( ! current_user_can( $capability ) ) {
		$_wp_submenu_nopriv[ $parent_slug ][ $menu_slug ] = true;
		return false;
	}

	/*
	 * If the parent doesn't already have a submenu, add a link to the parent
	 * as the first item in the submenu. If the submenu file is the same as the
	 * parent file someone is trying to link back to the parent manually. In
	 * this case, don't automatically add a link back to avoid duplication.
	 */
	if ( ! isset( $submenu[ $parent_slug ] ) && $menu_slug !== $parent_slug ) {
		foreach ( (array) $menu as $parent_menu ) {
			if ( $parent_menu[2] === $parent_slug && current_user_can( $parent_menu[1] ) ) {
				$submenu[ $parent_slug ][] = array_slice( $parent_menu, 0, 4 );
			}
		}
	}

	$new_sub_menu = array( $menu_title, $capability, $menu_slug, $page_title );

	if ( null !== $position && ! is_numeric( $position ) ) {
		_doing_it_wrong(
			__FUNCTION__,
			sprintf(
				/* translators: %s: add_submenu_page() */
				__( 'The seventh parameter passed to %s should be numeric representing menu position.' ),
				'<code>add_submenu_page()</code>'
			),
			'5.3.0'
		);
		$position = null;
	}

	if (
		null === $position ||
		( ! isset( $submenu[ $parent_slug ] ) || $position >= count( $submenu[ $parent_slug ] ) )
	) {
		$submenu[ $parent_slug ][] = $new_sub_menu;
	} else {
		// Test for a negative position.
		$position = max( $position, 0 );
		if ( 0 === $position ) {
			// For negative or `0` positions, prepend the submenu.
			array_unshift( $submenu[ $parent_slug ], $new_sub_menu );
		} else {
			// Grab all of the items before the insertion point.
			$before_items = array_slice( $submenu[ $parent_slug ], 0, $position, true );
			// Grab all of the items after the insertion point.
			$after_items = array_slice( $submenu[ $parent_slug ], $position, null, true );
			// Add the new item.
			$before_items[] = $new_sub_menu;
			// Merge the items.
			$submenu[ $parent_slug ] = array_merge( $before_items, $after_items );
		}
	}

	// Sort the parent array.
	ksort( $submenu[ $parent_slug ] );

	$hookname = get_plugin_page_hookname( $menu_slug, $parent_slug );
	if ( ! empty( $callback ) && ! empty( $hookname ) ) {
		add_action( $hookname, $callback );
	}

	$_registered_pages[ $hookname ] = true;

	/*
	 * Backward-compatibility for plugins using add_management_page().
	 * See wp-admin/admin.php for redirect from edit.php to tools.php.
	 */
	if ( 'tools.php' === $parent_slug ) {
		$_registered_pages[ get_plugin_page_hookname( $menu_slug, 'edit.php' ) ] = true;
	}

	// No parent as top level.
	$_parent_pages[ $menu_slug ] = $parent_slug;

	return $hookname;
}