add_comments_page() │ WP 2.7.0

Adds a submenu page to the Comments main menu.

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.

No Hooks.

Return

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

Usage

add_comments_page( $page_title, $menu_title, $capability, $menu_slug, $callback, $position );

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

$callback(callable)

The function to be called to output the content for this page.
Default: ''

$position(int)

The position in the menu order this item should appear.
Default: null

Changelog

add_comments_page() add comments page code ^{WP 6.5.2}

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