add_plugins_page( string $page_title, string $menu_title, string $capability, string $menu_slug, callable $function = '', int $position = null )

Add submenu page to the Plugins main menu.

Contents

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.

Top ↑

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: ''

$position

(int) (Optional) The position in the menu order this item should appear.

Default value: null

Top ↑

Return Return

(string|false) The resulting page's hook_suffix, or false if the user does not have the capability required.

Top ↑

More Information More Information

This function is a simple wrapper for a call to add_submenu_page(), passing the received arguments and specifying 'plugins.php' as the $parent_slug argument. This means the new page will be added as a sub-menu to the Plugins menu.

Top ↑

Top ↑

Source Source

File: wp-admin/includes/plugin.php 

function add_plugins_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
	return add_submenu_page( 'plugins.php', $page_title, $menu_title, $capability, $menu_slug, $function, $position );
}

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version Description
5.3.0 Added the $position parameter.
3.0.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Basic Plugin Page Example
    Typical usage occurs in a function registered with the admin_menu hook (see Adding Administration Menus):

    /**
 * Add a plugin page.
 */
function wpdocs_plugin_menu() {
	add_plugins_page(
		__( 'WPDocs Plugin Page', 'textdomain' ),
		__( 'WPDocs Plugin, 'textdomain' ),
		'read',
		'wpdocs-unique-identifier',
		'wpdocs_plugin_function'
	);
}
add_action( 'admin_menu', 'wpdocs_plugin_menu' );

    Expand full source codeCollapse full source code

You must log in before being able to contribute a note or feedback.