add_menu_page()

Add a top level menu 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.

Signature

add_menu_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $icon_url = '', $position = null )

page_title

 (string) The text to be displayed in the title tags of the page when the menu is selected

menu_title

 (string) The text to be used for the menu

capability

 (string) The capability required for this menu to be displayed to the user.

menu_slug

 (string) The slug name to refer to this menu by (should be unique for this menu)

function

 (callback) The function to be called to output the content for this page.
Default: ''

icon_url

 (string) The url to the icon to be used for this menu. Using 'none' would leave div.wp-menu-image empty so an icon can be added as background with CSS.
Default: ''

position

 (int) The position in the menu order this one should appear
Default: null

Return

(string) The resulting page's hook_suffix

Source

function add_menu_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $icon_url = '', $position = null ) {
	global $menu, $admin_page_hooks, $_registered_pages, $_parent_pages;

	$menu_slug = plugin_basename( $menu_slug );

	$admin_page_hooks[$menu_slug] = sanitize_title( $menu_title );

	$hookname = get_plugin_page_hookname( $menu_slug, '' );

	if ( !empty( $function ) && !empty( $hookname ) && current_user_can( $capability ) )
		add_action( $hookname, $function );

	if ( empty($icon_url) ) {
		$icon_url = 'none';
		$icon_class = 'menu-icon-generic ';
	} else {
		$icon_url = set_url_scheme( $icon_url );
		$icon_class = '';
	}

14 more lines...

WP Trac GitHub Bitbucket