wpseo_sitemap_<type>_urlset

Filters the `urlset` for a sitemap by type.

Description

apply_filters( 'wpseo_sitemap_<type>_urlset', (unknown) $urlset ); 

Parameters (1)

0. $urlset (unknown)
The urlset.

Usage

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

Defined (1)

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

/inc/sitemaps/class-sitemaps-renderer.php  
  1. $xml = apply_filters( "wpseo_sitemap_{$type}_urlset", $urlset );