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

Allow the site owner to run extra code before the cache loads #40920

Open
wants to merge 3 commits into
base: trunk
Choose a base branch
from

Conversation

donnchawp
Copy link
Contributor

We want technical site owners to be able to interact with the cache in Boost before it's served. This means loading and executing code before the plugin runs. This allows the site owner to modify the conditions of the site, such as cookies or even the URL before the cache is checked.
This code runs before WordPress loads.

Proposed changes:

  • In Boost_Cache, load the file wp-content/boost-cache-extra.php if it exists.

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

Does this pull request change what data or activity we track or use?

Testing instructions:

  • Apply PR
  • Create a file called wp-content/boost-cache-extra.php and add this code:
<?php
error_log( 'Extra! Extra!' );
  • Load the page and check your PHP error log and you should see the 'Extra! Extra' message.

@donnchawp donnchawp added [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it [Status] Needs Team Review [Plugin] Boost A feature to speed up the site and improve performance. [Boost Feature] Page Cache labels Jan 9, 2025
@donnchawp donnchawp added this to the boost/next milestone Jan 9, 2025
@donnchawp donnchawp requested a review from a team January 9, 2025 11:42
@donnchawp donnchawp self-assigned this Jan 9, 2025
Copy link
Contributor

github-actions bot commented Jan 9, 2025

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖


The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.


Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!


Boost plugin:

  • Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

Copy link
Member

@dilirity dilirity left a comment

Choose a reason for hiding this comment

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

Nice! :shipit:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Boost Feature] Page Cache [Plugin] Boost A feature to speed up the site and improve performance. [Status] Needs Team Review [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants