Skip to content

Like Block: Add support for Block Hooks API (Draft)#34732

Closed
TimBroddin wants to merge 1 commit intotrunkfrom
add/like-block-block-hooks-api
Closed

Like Block: Add support for Block Hooks API (Draft)#34732
TimBroddin wants to merge 1 commit intotrunkfrom
add/like-block-block-hooks-api

Conversation

@TimBroddin
Copy link
Copy Markdown
Contributor

Proposed changes:

  • Add the hooked_block_types filter
  • When should_hook_block() returns true it inserts the Like block inside a wp:group block, rendering correctly

CleanShot 2023-12-20 at 10 37 31@2x

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:

  1. Apply this PR & make sure jetpack watch is running
  2. Make should_hook_block() return true. (inside extensions/blocks/like/like.php)
  3. A block should be auto-inserted in the frontend & the editor & look right

@TimBroddin TimBroddin requested a review from a team December 20, 2023 09:38
@TimBroddin TimBroddin self-assigned this Dec 20, 2023
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Dec 20, 2023

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 add/like-block-block-hooks-api branch.

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

    bin/jetpack-downloader test jetpack add/like-block-block-hooks-api
    

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 [Block] Like [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ labels Dec 20, 2023
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Dec 20, 2023

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 January 9, 2024 (scheduled code freeze on January 8, 2024).

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

@github-actions github-actions bot added the [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. label Dec 20, 2023
*
* @return array The modified array of blocks to be hooked.
*/
function hooked_block_types( $hooked_blocks, $relative_position, $anchor_block, $context ) {
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.

Do you think we should make this available for both the sharing block and the like block, maybe via a new method in Jetpack_Gutenberg, so we can use the same strategy for both?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

That's certainly a possibility. However, at the moment, I'm still thinking about the logic that should go into should_hook_block().

Do you mean something along these lines?

function init_function() {
   if( should_hook_block() ) {
      Jetpack_Gutenberg::block_hook_insert_after_post_content( 'jetpack/like' ); 
   }
}


add_action( 'init', 'init_function');

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.

I was thinking about moving the whole hooked_block_types function to Jetpack_Gutenberg, and in there add both the like button and the sharing buttons blocks to the $hooked_blocks array, if the blocks are available. This way we hook into the hooked_block_types filter from one place only, with the same conditions and the same priority, and we can expand that list of supported Jetpack blocks later on.

Copy link
Copy Markdown
Contributor

@JuanLucha JuanLucha left a comment

Choose a reason for hiding this comment

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

Nice work!
Screenshot 2023-12-20 at 11 53 19

Note: I learned a lot about Block Hooks API reviewing this PR 🚀

@TimBroddin TimBroddin changed the title Like Block: Add support for Block Hooks API Like Block: Add support for Block Hooks API (Draft) Dec 21, 2023
@TimBroddin
Copy link
Copy Markdown
Contributor Author

I'm putting this PR in draft for a bit. I'm going to focus on the other areas first, and will then revisit.

@github-actions
Copy link
Copy Markdown
Contributor

This PR has been marked as stale. This happened because:

  • It has been inactive for the past 3 months.
  • It hasn’t been labeled `[Pri] BLOCKER`, `[Pri] High`, etc.

If this PR is still useful, please do a [trunk merge or rebase](https://github.com/Automattic/jetpack/blob/trunk/docs/git-workflow.md#keeping-your-branch-up-to-date) and otherwise make sure it's up to date and has clear testing instructions. You may also want to ping possible reviewers in case they've forgotten about it. Please close this PR if you think it's not valid anymore — if you do, please add a brief explanation.

If the PR is not updated (or at least commented on) in another month, it will be automatically closed.

@github-actions
Copy link
Copy Markdown
Contributor

This PR has been automatically closed as it has not been updated in some time. If you want to resume work on the PR, feel free to restore the branch and reopen the PR.

@github-actions github-actions bot closed this Apr 23, 2024
@github-actions github-actions bot deleted the add/like-block-block-hooks-api branch April 23, 2024 00:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[Block] Like [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Status] In Progress [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. [Status] Stale

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants