wpseo_sitemap_urlimages

Filter images to be included for the post in XML sitemap.

Description

apply_filters( 'wpseo_sitemap_urlimages', (array) $images, (int) $post_id ); 

Parameters (2)

0. $images (array)
Array of image items.
1. $post_id (int)
ID of the post.

Usage

To run the hook, copy the example below.
  1. $images = apply_filters( 'wpseo_sitemap_urlimages', $images, $post_id ); 
  2.  
  3. if ( !empty( $images ) ) { 
  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_urlimages callback 
  2. function filter_wpseo_sitemap_urlimages( $images, $post_id ) { 
  3. // make filter magic happen here... 
  4. return $images
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'wpseo_sitemap_urlimages', 'filter_wpseo_sitemap_urlimages', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'wpseo_sitemap_urlimages', 'filter_wpseo_sitemap_urlimages', 10, 2 ); 

Defined (1)

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

/inc/sitemaps/class-sitemap-image-parser.php  
  1. $images = apply_filters( 'wpseo_sitemap_urlimages', $images, $post->ID );