Add a filter for the sitemaps url

[pls78]

Context

• We want to add a filter to modify the sitemap URL.

Summary

This PR can be summarized in the following changelog entry:

• Adds a filter to modify the sitemap's URL. Props to @ashujangra.

Relevant technical choices:

• N/A

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

• Follow the instructions here to move your WordPress installation to a subdirectory

  • this is needed because we want to check the case where the site URL is different than the home URL

• in wp-content/mu-plugins create a new file filter.php and copy-paste the following in it:

  <?php
  
  add_filter('wpseo_sitemap_public_url', 'custom_url');
  function custom_url( $current_url) {
  error_log("The current sitemap URL is: $current_url");
  return $current_url;
  }
  

• Access any Yoast SEO page

• Open your debug.log file and verify you get a line like The current sitemap URL is YOUR_SPECIFIC_SITEMAP_URL

  • this ensures the filter gets triggered

• Visit the URL in the debug message and verify your sitemap is shown

  • this ensures the filter gets called with the correct parameter

Relevant test scenarios

• Changes should be tested with the browser console open
• Changes should be tested on different posts/pages/taxonomies/custom post types/custom taxonomies
• Changes should be tested on different editors (Default Block/Gutenberg/Classic/Elementor/other)
• Changes should be tested on different browsers
• Changes should be tested on multisite

Test instructions for QA when the code is in the RC

• QA should use the same steps as above.

Impact check

This PR affects the following parts of the plugin, which may require extra testing:

• N/A

UI changes

• This PR changes the UI in the plugin. I have added the 'UI change' label to this PR.

Other environments

• This PR also affects Shopify. I have added a changelog entry starting with [shopify-seo], added test instructions for Shopify and attached the Shopify label to this PR.

Documentation

• I have written documentation for this change. See Add documentation for wpseo_sitemap_public_url filter #324.

Quality assurance

• I have tested this code to the best of my abilities.
• During testing, I had activated all plugins that Yoast SEO provides integrations for.
• I have added unit tests to verify the code works as intended.
• If any part of the code is behind a feature flag, my test instructions also cover cases where the feature flag is switched off.
• I have written this PR in accordance with my team's definition of done.
• I have checked that the base branch is correctly set.

Innovation

• No innovation project is applicable for this PR.
• This PR falls under an innovation project. I have attached the innovation label.
• I have added my hours to the WBSO document.

Fixes #

[coveralls]

Pull Request Test Coverage Report for Build 2f4be287dafd91ecbc28b424cebd91a5b2466c54

Details

• 0 of 1 (0.0%) changed or added relevant line in 1 file are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage decreased (-2.8%) to 54.622%

---

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
inc/sitemaps/class-sitemaps-renderer.php	0	1	0.0%

Totals
Change from base Build 8c9d68c6f642df45df311e8b92dd7196c8db4c7b:	-2.8%
Covered Lines:	29694
Relevant Lines:	54590

---

💛 - Coveralls