add_dashboard_page() WordPress Function
The add_dashboard_page() function allows you to add a new page to the WordPress admin panel. This function takes two parameters: the page title and the capability required to view the page.
add_dashboard_page( string $page_title, string $menu_title, string $capability, string $menu_slug, callable $callback = '', int $position = null ) #
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_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 '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
File: wp-admin/includes/plugin.php
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 );
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 5.3.0 | Added the $position parameter. |
| 2.7.0 | Introduced. |