Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Sitemap public url when home_url() != site_url(). #21594

Closed
wants to merge 1 commit into from

Conversation

ashujangra
Copy link

@ashujangra ashujangra commented Sep 3, 2024

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

  • 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.

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

  • 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. For example, comments in the Relevant technical choices, comments in the code, documentation on Confluence / shared Google Drive / Yoast developer portal, or other.

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 #

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 eveytime.
@pls78
Copy link
Member

pls78 commented Sep 6, 2024

Hi @ashujangra, I'm closing this PR in favor of Add a filter for the sitemaps url #21611(a couple of things needed to be fixed, I added test instructions for our QA team and gave props in the changelog line).
Thank you for your contribution!

@pls78 pls78 closed this Sep 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants