add_dashboard_page() – Function | Developer.WordPress.org

Adds a submenu page to the Dashboard 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_titlestringrequired: The text to be displayed in the title tags of the page when the menu is selected.
$menu_titlestringrequired: The text to be used for the menu.
$capabilitystringrequired: The capability required for this menu to be displayed to the user.
$menu_slugstringrequired: The slug name to refer to this menu by (should be unique for this menu).
$callbackcallableoptional: The function to be called to output the content for this page.
Default:''
$positionintoptional: The position in the menu order this item should appear.
Default:null

Return

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

This function is a simple wrapper for a call to add_submenu_page(), passing the received arguments and specifying 'index.php' as the $parent_slug argument. This means the new page will be added as a sub-menu to the Dashboard 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.

If you’re running into the »You do not have sufficient permissions to access this page.« message on a wp_die() screen, then you’ve hooked too early. The hook you should use is admin_menu.

Source

function add_dashboard_page( $page_title, $menu_title, $capability, $menu_slug, $callback = '', $position = null ) {
	return add_submenu_page( 'index.php', $page_title, $menu_title, $capability, $menu_slug, $callback, $position );
}

View all references View on Trac View on GitHub

Uses	Description
add_submenu_page()`wp-admin/includes/plugin.php`	Adds a submenu page.

Changelog

Version	Description
5.3.0	Added the `$position` parameter.
2.7.0	Introduced.

User Contributed Notes

Codex 10 years ago

Typical usage occurs in a function registered with the ‘admin_menu’ hook:

/**
 * Add a page to the dashboard menu.
 */
function wpdocs_plugin_menu() {
	add_dashboard_page( __( 'WPDocs Plugin Dashboard', 'textdomain' ), __( 'WPDocs Plugin', 'textdomain' ), 'read', 'wpdocs-unique-identifier', 'wpdocs_plugin_function' );
}
add_action('admin_menu', 'wpdocs_plugin_menu');

add_dashboard_page( string $page_title, string $menu_title, string $capability, string $menu_slug, callable $callback = '', int $position = null ): string|false

In this article