add_pages_page() WordPress Function

The add_pages_page() function allows you to add a new page to your Wordpress site. This function takes two arguments: the page title and the page content. The page title is the text that will be displayed in the header of the page, and the page content is the text that will be displayed on the page itself.

add_pages_page( string $page_title, string $menu_title, string $capability, string $menu_slug, callable $callback = '', int $position = null ) #

Adds a submenu page to the Pages 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.


Top ↑

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

$callback

(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


Top ↑

Return

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


Top ↑

More Information

  • If you’re running into the »You do not have sufficient permissions to access this page.« message in a wp_die() screen, then you’ve hooked too early. The hook you should use is admin_menu.
  • This function is a simple wrapper for a call to add_submenu_page(), passing the received arguments and specifying ‘edit.php?post_type=page‘ as the $parent_slug argument. This means the new page will be added as a sub menu to the Pages menu.

Top ↑

Source

File: wp-admin/includes/plugin.php

function add_pages_page( $page_title, $menu_title, $capability, $menu_slug, $callback = '', $position = null ) {
	return add_submenu_page( 'edit.php?post_type=page', $page_title, $menu_title, $capability, $menu_slug, $callback, $position );
}


Top ↑

Changelog

Changelog
VersionDescription
5.3.0Added the $position parameter.
2.7.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by the Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.