add_menu_page( string $page_title, string $menu_title, string $capability, string $menu_slug, callable $callback = '', string $icon_url = '', int|float $position = null ): string

Description

Parameters

$page_titlestring

The text to be displayed in the title tags of the page when the menu is selected.

$menu_titlestring

The text to be used for the menu.

$capabilitystring

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

$menu_slugstring

The slug name to refer to this menu by. Should be unique for this menu page and only include lowercase alphanumeric, dashes, and underscores characters to be compatible with sanitize_key().

$callbackcallableoptional

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

$icon_urlstringoptional

The URL to the icon to be used for this menu. <em> Pass a base64-encoded SVG using a data URI, which will be colored to match the color scheme. This should begin with 'data:image/svg+xml;base64,'. </em> Pass the name of a Dashicons helper class to use a font icon, e.g. 'dashicons-chart-pie'. * Pass 'none' to leave div.wp-menu-image empty so an icon can be added via CSS.Default: ''

$positionint|floatoptional

The position in the menu order this item should appear.Default: null

Return

string

The resulting page's hook_suffix.

Uses · 8

• plugin_basename()Gets the basename of a plugin.
• sanitize_title()Sanitizes a string into a slug, which can be used in URLs or HTML attributes.
• get_plugin_page_hookname()Gets the hook name for the administrative page of a plugin.
• current_user_can()Returns whether the current user has the specified capability.
• add_action()Adds a callback function to an action hook.
• set_url_scheme()Sets the scheme for a URL.
• _doing_it_wrong()Marks something as being incorrectly called.
• __()Retrieves the translation of $text.

Used by · 2

• add_object_page()Add a top-level menu page in the 'objects' section.
• add_utility_page()Add a top-level menu page in the 'utility' section.

Source

View on Trac ↗View on GitHub ↗

1391function add_menu_page( $page_title, $menu_title, $capability, $menu_slug, $callback = '', $icon_url = '', $position = null ) {1392	global $menu, $admin_page_hooks, $_registered_pages, $_parent_pages;1393 1394	$menu_slug = plugin_basename( $menu_slug );1395 1396	$admin_page_hooks[ $menu_slug ] = sanitize_title( $menu_title );1397 1398	$hookname = get_plugin_page_hookname( $menu_slug, '' );1399 1400	if ( ! empty( $callback ) && ! empty( $hookname ) && current_user_can( $capability ) ) {1401		add_action( $hookname, $callback );1402	}1403 1404	if ( empty( $icon_url ) ) {1405		$icon_url   = 'dashicons-admin-generic';1406		$icon_class = 'menu-icon-generic ';1407	} else {1408		$icon_url   = set_url_scheme( $icon_url );1409		$icon_class = '';1410	}1411 1412	$new_menu = array( $menu_title, $capability, $menu_slug, $page_title, 'menu-top ' . $icon_class . $hookname, $hookname, $icon_url );1413 1414	if ( null !== $position && ! is_numeric( $position ) ) {1415		_doing_it_wrong(1416			__FUNCTION__,1417			sprintf(1418				/* translators: %s: add_menu_page() */1419				__( 'The seventh parameter passed to %s should be numeric representing menu position.' ),1420				'<code>add_menu_page()</code>'1421			),1422			'6.0.0'1423		);1424		$position = null;1425	}1426 1427	if ( null === $position || ! is_numeric( $position ) ) {1428		$menu[] = $new_menu;1429	} elseif ( isset( $menu[ (string) $position ] ) ) {1430		$collision_avoider = (int) base_convert( substr( md5( $menu_slug . $menu_title ), -4 ), 16, 10 ) * 0.00001;1431		$position          = (string) ( $position + $collision_avoider );1432		$menu[ $position ] = $new_menu;1433	} else {1434		/*1435		 * Cast menu position to a string.1436		 *1437		 * This allows for floats to be passed as the position. PHP will normally cast a float to an1438		 * integer value, this ensures the float retains its mantissa (positive fractional part).1439		 *1440		 * A string containing an integer value, eg "10", is treated as a numeric index.1441		 */1442		$position          = (string) $position;1443		$menu[ $position ] = $new_menu;1444	}1445 1446	$_registered_pages[ $hookname ] = true;1447 1448	// No parent as top level.1449	$_parent_pages[ $menu_slug ] = false;1450 1451	return $hookname;1452}

History

Introduced in 1.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.0.4 tag, from src/wp-admin/includes/plugin.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.