wpseo_sitemaps_supported_user_roles

The Yoast SEO wpseo sitemaps supported user roles hook.

Description

apply_filters( 'wpseo_sitemaps_supported_user_roles', (unknown) $user_roles ); 

Parameters (1)

0. $user_roles (unknown)
The user roles.

Usage

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

Defined (1)

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

/inc/options/class-wpseo-option-xml.php  
  1. $filtered_user_roles = apply_filters( 'wpseo_sitemaps_supported_user_roles', $user_roles );