wpseo_xml_sitemap_img

Filter image data to be included in XML sitemap for the post.

Description

apply_filters( 'wpseo_xml_sitemap_img', (array) $image, (object) $post ); 

Parameters (2)

0. $image (array)
{ Array of image data.
1. $post (object)
Post object.

Usage

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

Defined (1)

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

/inc/sitemaps/class-sitemap-image-parser.php  
  1. return apply_filters( 'wpseo_xml_sitemap_img', $image, $post );