Skip to content

Add a filter to customize the URL for page caching check in Site Health#7426

Open
zetrider wants to merge 8 commits intoWordPress:trunkfrom
zetrider:site-status-persistent-page-cache-url
Open

Add a filter to customize the URL for page caching check in Site Health#7426
zetrider wants to merge 8 commits intoWordPress:trunkfrom
zetrider:site-status-persistent-page-cache-url

Conversation

@zetrider
Copy link
Copy Markdown

Trac ticket: https://core.trac.wordpress.org/ticket/62101


This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

@github-actions
Copy link
Copy Markdown

Hi @zetrider! 👋

Thank you for your contribution to WordPress! 💖

It looks like this is your first pull request to wordpress-develop. Here are a few things to be aware of that may help you out!

No one monitors this repository for new pull requests. Pull requests must be attached to a Trac ticket to be considered for inclusion in WordPress Core. To attach a pull request to a Trac ticket, please include the ticket's full URL in your pull request description.

Pull requests are never merged on GitHub. The WordPress codebase continues to be managed through the SVN repository that this GitHub repository mirrors. Please feel free to open pull requests to work on any contribution you are making.

More information about how GitHub pull requests can be used to contribute to WordPress can be found in the Core Handbook.

Please include automated tests. Including tests in your pull request is one way to help your patch be considered faster. To learn about WordPress' test suites, visit the Automated Testing page in the handbook.

If you have not had a chance, please review the Contribute with Code page in the WordPress Core Handbook.

The Developer Hub also documents the various coding standards that are followed:

Thank you,
The WordPress Project

@github-actions
Copy link
Copy Markdown

github-actions bot commented Sep 23, 2024

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props zetrider, mukesh27, martinkrcho.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@github-actions
Copy link
Copy Markdown

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

  • The Plugin and Theme Directories cannot be accessed within Playground.
  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

Copy link
Copy Markdown
Member

@mukeshpanchal27 mukeshpanchal27 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. The changes looks good to me.

@martinkrcho
Copy link
Copy Markdown

@zetrider could you address the outstanding feedback? It's couple of small things and I believe this could be ready for merge.

@mukeshpanchal27
Copy link
Copy Markdown
Member

@zetrider could you address the outstanding feedback? It's couple of small things and I believe this could be ready for merge.

Yes. Once the feedback addressed i will approve and move the ticket in 6.8 milestone for visibility

zetrider and others added 3 commits January 9, 2025 14:10
Co-authored-by: Mukesh Panchal <mukeshpanchal27@users.noreply.github.com>
Co-authored-by: Mukesh Panchal <mukeshpanchal27@users.noreply.github.com>
Co-authored-by: Mukesh Panchal <mukeshpanchal27@users.noreply.github.com>
@zetrider
Copy link
Copy Markdown
Author

zetrider commented Jan 9, 2025

Thanks guys, good catch, done.

Copy link
Copy Markdown
Member

@mukeshpanchal27 mukeshpanchal27 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the updates. One final doc changes.

Co-authored-by: Mukesh Panchal <mukeshpanchal27@users.noreply.github.com>
*
* @return string The URL for checking page caching.
*/
public function get_persistent_page_cache_url() {
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This shouldn't be a public method that we have to maintain. If anything it should be private, but I don't think we need an extra method for this in the first place.

*
* @param string $url The URL used for checking page caching. Default home URL.
*/
return apply_filters( 'site_status_persistent_page_cache_url', home_url( '/' ) );
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The original ticket mentions desire to test multiple different sites, for example on a multilingual or ecommerce site. But this is not possible if this is just a single filterable URL.

If testing of multiple pages is desired, then this should be an array of URLs.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants