add_plugins_page() wordpress function and usage This text is not used because the data attribute has a value

add_plugins_page() wordpress function and usage

Home / WordPress / WordPress Wiki / add_plugins_page() wordpress function and usage

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.

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_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

Return

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

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.

Sample Usage

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' );

 

0 0 votes
Article Rating
Subscribe
Notify of
guest
0 Comments
Inline Feedbacks
View all comments