add_comments_page( string $page_title, string $menu_title, string $capability, string $menu_slug, callable $function = '', int $position = null )
Add submenu page to the Comments 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.
Source
File: wp-admin/includes/plugin.php
function add_comments_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
return add_submenu_page( 'edit-comments.php', $page_title, $menu_title, $capability, $menu_slug, $function, $position );
} Changelog
| Version | Description |
|---|---|
| 5.3.0 | Added the $position parameter. |
| 2.7.0 | Introduced. |
© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/add_comments_page