option_page_capability_<option_page>

Filters the capability required when using the Settings API.

Description

apply_filters( 'option_page_capability_<option_page>', (string) $capability ); 

By default, the options groups for all registered settings require the manage_options capability. This filter is required to change the capability required for a certain options page.

Parameters (1)

0. $capability (string)
The capability used for the page, which is manage_options by default.

Usage

To run the hook, copy the example below.
  1. $capability = apply_filters( 'option_page_capability_{$option_page}', $capability ); 
  2.  
  3. if ( !empty( $capability ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the option_page_capability_<option_page> callback 
  2. function filter_option_page_capability_option_page( $capability ) { 
  3. // make filter magic happen here... 
  4. return $capability
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( "option_page_capability_{$option_page}", 'filter_option_page_capability_option_page', 10, 1 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( "option_page_capability_{$option_page}", 'filter_option_page_capability_option_page', 10, 1 ); 

Defined (1)

The filter is defined in the following location(s).

/wp-admin/options.php  
  1. $capability = apply_filters( "option_page_capability_{$option_page}", $capability );