add_comments_page() – Function | Developer.WordPress.org

Adds a 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_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:''
$positionintoptional: The position in the menu order this item should appear.
Default:null

Return

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

Source

function add_comments_page( $page_title, $menu_title, $capability, $menu_slug, $callback = '', $position = null ) {
	return add_submenu_page( 'edit-comments.php', $page_title, $menu_title, $capability, $menu_slug, $callback, $position );
}

View all references View on Trac View on GitHub

Uses	Description
add_submenu_page()`wp-admin/includes/plugin.php`	Adds a submenu page.

Changelog

Version	Description
5.3.0	Added the `$position` parameter.
2.7.0	Introduced.

User Contributed Notes

Codex 9 years ago

Add admin page under Comments menu

add_action('admin_menu', 'wpdocs_my_plugin_menu');

function wpdocs_my_plugin_menu() {
    add_comments_page( __( 'My Plugin Comments', 'textdomain' ), __( 'My Plugin Comments', 'textdomain' ), 'read', 'my-unique-identifier', 'my_plugin_function' );
}

add_comments_page( string $page_title, string $menu_title, string $capability, string $menu_slug, callable $callback = '', int $position = null ): string|false

In this article

Description

Parameters

Return

Source

Changelog

User Contributed Notes

add_comments_page( string $page_title, string $menu_title, string $capability, string $menu_slug, callable $callback = '', int $position = null ): string|false

In this article

Description

Parameters

Return

Source

Related

Changelog

User Contributed Notes