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

Content Options: Ensure excerpt_length is an int to prevent fatal errors #40389

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

Conversation

coder-karen
Copy link
Contributor

Proposed changes:

  • This PR ensures $excerpt_length is cast to an int if it is not already an int, to prevent fatal errors. We first check if it's numeric though, as casting a string such as 'Hello' to int will return 0, which isn't ideal for an excerpt length. If it isn't numeric, we'll use the default 55.
  • One occurrence was reported internally - see p1732862467954599-slack-C034JEXD1RD - possibly due to a custom filter hooking into excerpt_length and returning a string.

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

p1732862467954599-slack-C034JEXD1RD

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

No.

Testing instructions:

  • I'm unsure how to replicate the issue in practice, but to test Content Options generally to ensure no issues are introduced you can add the Dara theme to a test site. Open up the customizer and select Content Options. Ensure you don't have a post excerpt set on at least one post.
  • It is however to test $excerpt_length as a string by adding $excerpt_length = 'Test'; underneath the apply_filter line.

Copy link
Contributor

github-actions bot commented Nov 29, 2024

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

  • To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin, and enable the fix/content-options-excerpt-length-cast branch.

    • For jetpack-mu-wpcom changes, also add define( 'JETPACK_MU_WPCOM_LOAD_VIA_BETA_PLUGIN', true ); to your wp-config.php file.
  • To test on Simple, run the following command on your sandbox:

    bin/jetpack-downloader test jetpack fix/content-options-excerpt-length-cast
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin fix/content-options-excerpt-length-cast
    

Interested in more tips and information?

  • In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
  • Read more about our development workflow here: PCYsg-eg0-p2
  • Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

Copy link
Contributor

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 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!

@coder-karen coder-karen marked this pull request as ready for review November 29, 2024 11:44
@coder-karen coder-karen requested a review from a team November 29, 2024 11:44
Copy link
Contributor

@fgiannar fgiannar left a comment

Choose a reason for hiding this comment

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

LGTM! Many thanks for the fix, Karen!

@fgiannar fgiannar added [Status] Ready to Merge Go ahead, you can push that green button! and removed [Status] Needs Team Review labels Nov 29, 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.

2 participants