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

Add submenu page to the Settings main menu.


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.


Top ↑

Parameters 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


Top ↑

Return Return

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


Top ↑

More Information More Information

  • This function is a simple wrapper for a call to add_submenu_page(), passing the received arguments and specifying ‘options-general.php‘ as the $parent_slug argument. This means the new options page will be added as a sub menu to the Settings menu.
  • The $capability parameter is used to determine whether or not the page is included in the menu based on the Roles and Capabilities) of the current user.
  • The function handling the output of the options page should also verify the user’s capabilities.
  • If there are spaces in the slug, then these will be stripped out when the URL is generated. This will result in an error message telling you that you do not have sufficient permissions to view the page.


Top ↑

Source Source

File: wp-admin/includes/plugin.php

function add_options_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
	return add_submenu_page( 'options-general.php', $page_title, $menu_title, $capability, $menu_slug, $function, $position );
}

Top ↑

Changelog Changelog

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

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    Contributed by Codex

    Object Oriented options page helper / view

    /**
     * Class for registering a new settings page under Settings.
     */
    class WPDocs_Options_Page {
    
    	/**
    	 * Constructor.
    	 */
    	function __construct() {
    		add_action( 'admin_menu', array( $this, 'admin_menu' ) );
    	}
    
    	/**
    	 * Registers a new settings page under Settings.
    	 */
    	function admin_menu() {
    		add_options_page(
    			__( 'Page Title', 'textdomain' ),
    			__( 'Circle Tree Login', 'textdomain' ),
    			'manage_options',
    			'options_page_slug',
    			array(
    				$this,
    				'settings_page'
    			)
    		);
    	}
    
    	/**
    	 * Settings page display callback.
    	 */
    	function settings_page() {
    		echo __( 'This is the page content', 'textdomain' );
    	}
    }
    
    new WPDocs_Options_Page;
    
  2. Skip to note 2 content
    Contributed by Codex

    Basic Example

    Typical usage occurs in a function registered with the ‘admin_menu’ hook (see Adding Administration Menus):

    /**
     * Registers a new options page under Settings.
     */
    function wpdocs_my_plugin_menu() {
    	add_options_page( 
    		__( 'My Options', 'textdomain' ),
    		__( 'My Plugin', 'textdomain' ),
    		'manage_options',
    		'my-plugin.php',
    		'my_plugin_page'
    	);
    }
    

You must log in before being able to contribute a note or feedback.