add_utility_page

Advertisement

Deprecated Deprecated

This function has been deprecated. Use add_menu_page() instead.

Summery Summery

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

Syntax Syntax

add_utility_page( string $page_title, string $menu_title, string $capability, string $menu_slug, callable $function = '', string $icon_url = '' )

Description 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 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).

$function

(callable) (Optional) The function to be called to output the content for this page.

Default value: ''

$icon_url

(string) (Optional) The url to the icon to be used for this menu.

Default value: ''

Return Return

(string) The resulting page's hook_suffix.

Source Source

File: wp-admin/includes/deprecated.php

function add_utility_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $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, $function, $icon_url, $_wp_last_utility_menu);
}

Advertisement

Changelog Changelog

Changelog
Version Description
4.5.0 Use add_menu_page()
2.7.0 Introduced.

See also See also

Advertisement

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.