Skip to content

Sharing: only hook block to single post template on WP 6.5+#35905

Merged
jeherve merged 2 commits into
trunkfrom
fix/sharing-block-hooks-65
Feb 23, 2024
Merged

Sharing: only hook block to single post template on WP 6.5+#35905
jeherve merged 2 commits into
trunkfrom
fix/sharing-block-hooks-65

Conversation

@jeherve

@jeherve jeherve commented Feb 23, 2024

Copy link
Copy Markdown
Member

Proposed changes:

Follow-up to #35542

Core recently changed the definition of the filter we're using to automatically add the sharing block to post templates. As a result, our code is not compatible with WordPress 6.4 anymore:

PHP Fatal error:  Uncaught ArgumentCountError: Too few arguments to function Automattic\Jetpack\Extensions\Sharing_Button_Block\add_default_services_to_block(), 4 passed in /var/www/html/wp-includes/class-wp-hook.php on line 324 and exactly 5 expected in /usr/local/src/jetpack-monorepo/projects/plugins/jetpack/extensions/blocks/sharing-button/sharing-button.php:254

Let's gate that functionality to WordPress 6.5+ to avoid that error.

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

  • N/A

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

  • No

Testing instructions:

  • On a site running WordPress 6.4, go to Appearance > Site Editor
  • You should not get any Fatal error in your logs.
  • Using WP CLI, enable auto addition to the sharing buttons: wp option update jetpack_sharing_buttons_auto_add true
  • Using the WordPress Beta tester plugin, update your site to the current Bleeding edge version of WordPress
  • Go to Appearance > Site Editor > Template > Single Posts
  • See the sharing buttons at the bottom of the template.

Follow-up to #35542

Core recently changed the definition of the filter we're using to automatically add the sharing block to post templates. As a result, our code is not compatible with WordPress 6.4 anymore:

```
PHP Fatal error:  Uncaught ArgumentCountError: Too few arguments to function Automattic\Jetpack\Extensions\Sharing_Button_Block\add_default_services_to_block(), 4 passed in /var/www/html/wp-includes/class-wp-hook.php on line 324 and exactly 5 expected in /usr/local/src/jetpack-monorepo/projects/plugins/jetpack/extensions/blocks/sharing-button/sharing-button.php:254
```

Let's gate that functionality to WordPress 6.5+ to avoid that error.
@jeherve jeherve added Bug When a feature is broken and / or not performing as intended [Feature] Sharing Post sharing, sharing buttons [Status] Needs Review This PR is ready for review. [Pri] High [Status] Needs Team Review Obsolete. Use Needs Review instead. [Focus] Compatibility Ensuring our products play well with third-parties [Block] Sharing Buttons [Block] Sharing Button labels Feb 23, 2024
@jeherve jeherve requested review from a team and andrii-lysenko February 23, 2024 14:45
@jeherve jeherve self-assigned this Feb 23, 2024
@github-actions

github-actions Bot commented Feb 23, 2024

Copy link
Copy Markdown
Contributor

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/sharing-block-hooks-65 branch.

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

    bin/jetpack-downloader test jetpack fix/sharing-block-hooks-65
    

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

@github-actions github-actions Bot added the [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ label Feb 23, 2024
@github-actions

Copy link
Copy Markdown
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.


Once your PR is ready for review, check one last time that all required checks appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team Review" label and ask someone from your team review the code. Once reviewed, it can then be merged.
If you need an extra review from someone familiar with the codebase, you can update the labels from "[Status] Needs Team Review" to "[Status] Needs Review", and in that case Jetpack Approvers will do a final review of your PR.


Jetpack plugin:

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

  • WordPress.com Simple releases happen daily.
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for March 5, 2024 (scheduled code freeze on March 4, 2024).

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

@jeherve jeherve enabled auto-merge (squash) February 23, 2024 14:51

@andrii-lysenko andrii-lysenko left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This works good and runs with no errors.

@jeherve jeherve merged commit c6805fb into trunk Feb 23, 2024
@jeherve jeherve deleted the fix/sharing-block-hooks-65 branch February 23, 2024 16:59
@github-actions github-actions Bot removed [Status] Needs Review This PR is ready for review. [Status] Needs Team Review Obsolete. Use Needs Review instead. labels Feb 23, 2024
@github-actions github-actions Bot added this to the jetpack/13.2 milestone Feb 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[Block] Sharing Button [Block] Sharing Buttons Bug When a feature is broken and / or not performing as intended [Feature] Sharing Post sharing, sharing buttons [Focus] Compatibility Ensuring our products play well with third-parties [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Pri] High

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants