Added Sitemap public url when home_url() != site_url(). #21594
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Note: This will help users who are using wordpress as headles. Their wp backend is hosted on another url/subdomain and frontend is installed on other server. that case home_url() which useually a frontend app url. the current will return 404 error for main-sitemap.xsl as this file won't exist on frontend app. I have added a filter which will help those users to overwrite with backend path. After that their backend will have the sitemap and they can write their code to download and store in their public directory. It will help them to keep their sitemap updated overtime.
Context
Overwrite the XML public path.
Summary
If someone are using WordPress as a headless CMS, where their backend is hosted on WordPress and the frontend is in Next.js/react or any other tech. In that scenario , the SITE_URL (backend URL) and Home URL (frontend URL) are different. let's say backend.example.com, and the frontend URL is example.com.
That user will struggle with the XML sitemap. Cause as per google they will require their xml site map like example.com/sitemap.xml or example.com/sitemap_index.xml but since WordPress is hosted on backend.example.com, the example.com/sitemap_index.xml does not work. Even backend.example.com/sitemap_index.xml will not work cause the current code which i had investigated found that home_url has preference over site_url. Due to that main-sitemap.xsl will return 404 or not found.
I have added 1 filter which will help developers to overwrite the URL in case if they want.
This PR can be summarized in the following changelog entry:
Fixes a bug on Sitemap URL.
*
Relevant technical choices:
Test instructions
Test instructions for the acceptance test before the PR gets merged
This PR can be acceptance tested by following these steps:
Simply keep Different Site URL and Home URL different. and then check sitemap_index.xml at any URL.
Relevant test scenarios
Test instructions for QA when the code is in the RC
QA can test this PR by following these steps:
Impact check
This PR affects the following parts of the plugin, which may require extra testing:
UI changes
Other environments
[shopify-seo]
, added test instructions for Shopify and attached theShopify
label to this PR.Documentation
Quality assurance
Innovation
innovation
label.Fixes #