Function: add_options_page

add_options_page( string $page_title, string $menu_title, string $capability, string $menu_slug, callable $function )

Add submenu page to the Settings main menu.

Shortcut: aop

You can use above key combination to trigger the associated snippet for this function in the WordPress Snippets for Visual Studio Code extension. You can also use this shortcut to search for this function on this website.

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

Name Type(s) Default Value Description
$page_title string

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

$menu_title string

The text to be used for the menu.

$capability string

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

$menu_slug string

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

$function callable ''

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

Returns

false | string

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

WordPress Developer Newsletter

Stay informed of new chapter releases, important WordPress API updates and more.