WordPress filter hook

wpseo_xml_sitemap_img

Fired by 5 WordPress plugins, running on 10.4M+ sites between them.

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

How to use wpseo_xml_sitemap_img

It's a filter: your callback receives the value and 1 more argument, and must return the (changed) value. Add this to your theme's functions.php or a small custom plugin:

functions.php
add_filter( 'wpseo_xml_sitemap_img', function( $image, $post ) {
	// Change $image here.
	return $image;
}, 10, 2 );

Argument names come from Yoast SEO's source. Other plugins may pass different values: check the call in the plugin you're targeting below.

5 plugins that fire wpseo_xml_sitemap_img

Sorted by active installs. Each entry shows where the plugin calls the hook and what it passes.

  1. Yoast SEO icon Yoast SEO10+ million installs apply_filters( 'wpseo_xml_sitemap_img', $image, $post ) inc/sitemaps/class-sitemap-image-parser.php:367
  2. Page Builder by SiteOrigin icon Page Builder by SiteOrigin400,000+ installs apply_filters( 'wpseo_xml_sitemap_img', array( 'src' => $src, ), $post ) compat/yoast.php:66
  3. Super Sitemap for SEO icon Super Sitemap for SEO20+ installs apply_filters( 'wpseo_xml_sitemap_img', true ) admin/class-super-sitemap-for-seo-helper.php:376
  4. Integration of Yoast wordpress SEO module with mqtranslate module icon Integration of Yoast wordpress SEO module with mqtranslate module10+ installs apply_filters( 'wpseo_xml_sitemap_img', $image, $p ) inc/class-sitemaps-mqtranslate-integr.php:855
  5. Fabrement Lite icon Fabrement LiteFewer than 10 installs apply_filters( 'wpseo_xml_sitemap_img', $item, $post ) src/Modules/Seo/Integration/YoastIntegration.php:178

Need a customisation built on this hook?

Tell us what you want to change and which plugin it's for. We'll write it, test it and send it back as a small plugin.