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

Open Graph: Always output tags if they haven't been. #40213

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

Conversation

pablinos
Copy link
Contributor

@pablinos pablinos commented Nov 15, 2024

Currently we only output the Open Graph tags if the sharing or Publicize modules are enabled and there are no known conflicting plugins active.

Proposed changes:

This removes the module check, but adds a check where we capture the output of wp_head, and then see if any of the tags have been output already. If not then we render them.

This change means that the default behaviour is flipped, so that Open Graph tags are always rendered, unless they're disabled.

I'm also slightly concerned about using output buffering, as I don't know if that will affect performance adversely, or if it could cause other problems.

Fixes #39225

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)?

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

No.

Testing instructions:

  • Check that OG tags are rendered when using a block theme
  • Yoast already disables Jetpack OG rendering. There might be another plugin we can use for testing.
  • Add the web-stories plugin https://wordpress.org/plugins/web-stories/ , create a story and check that Open Graph tags are rendered

Currently we only output the Open Graph tags if the sharing or Publicize
modules are enabled and there are no known conflicting plugins active.

This removes the module check, but adds a check where we capture the
output of wp_head, and then see if any of the tags have been output
already. If not then we render them.
@pablinos pablinos added [Status] In Progress [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Extension] SEO labels Nov 15, 2024
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!


Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

  • WordPress.com Simple releases happen semi-continuously (PCYsg-Jjm-p2).
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for none scheduled (scheduled code freeze on undefined).

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

Copy link
Contributor

github-actions bot commented Nov 15, 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 try/open-graph-tag-detection branch.

  • To test on Simple, run the following command on your sandbox:

    bin/jetpack-downloader test jetpack try/open-graph-tag-detection
    

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

@pablinos pablinos requested a review from a team November 20, 2024 21:48
@pablinos pablinos marked this pull request as ready for review November 20, 2024 21:48
@pablinos pablinos self-assigned this Nov 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Extension] SEO [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Status] In Progress [Status] Needs Team Review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Jetpack share og: tags missing in FSE themes if you do not enable legacy sharing - JP 13.8-beta
1 participant