add_posts_page

Advertisement

Summery Summery

Add submenu page to the Posts main menu.

Syntax Syntax

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

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.

Parameters Parameters

$page_title

(Required) The text to be displayed in the title tags of the page when the menu is selected.

$menu_title

(Required) The text to be used for the menu.

$capability

(Required) The capability required for this menu to be displayed to the user.

$menu_slug

(Required) The slug name to refer to this menu by (should be unique for this menu).

$function

(Optional) The function to be called to output the content for this page.

Default value: ''

$position

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

Default value: null

Return Return

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

Source Source

File: wp-admin/includes/plugin.php

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

Advertisement

Changelog Changelog

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

Advertisement

Leave a Reply