W3cubDocs

/WordPress

add_utility_page( string $page_title, string $menu_title, string $capability, string $menu_slug, callable $callback = ”, string $icon_url = ” ): string

Add a top-level menu page in the ‘utility’ section.

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:''
$icon_urlstringoptional: The URL to the icon to be used for this menu.

Default:''

Return

string The resulting page’s hook_suffix.

Source

function add_utility_page( $page_title, $menu_title, $capability, $menu_slug, $callback = '', $icon_url = '') {
	_deprecated_function( __FUNCTION__, '4.5.0', 'add_menu_page()' );

	global $_wp_last_utility_menu;

	$_wp_last_utility_menu++;

	return add_menu_page($page_title, $menu_title, $capability, $menu_slug, $callback, $icon_url, $_wp_last_utility_menu);
}

View all references View on Trac View on GitHub

Changelog

Version	Description
4.5.0	Use add_menu_page()
2.7.0	Introduced.