Hide sharing buttons in Blog Posts block in the editor #25346

wojtekn · 2022-08-01T10:33:33Z

Fixes #25329

Changes proposed in this Pull Request:

Blog Posts block is rendered in the editor via REST request and still displays sharing buttons. I'm adding additional checks to remove those from the editor, to match frontend behavior.

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?

Jetpack product discussion

N/A

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

No

Testing instructions:

Start a Jetpack environment
Go to WP Admin
Install a WordPress.com Editing Toolkit plugin
Enable Sharing buttons in Jetpack -> Settings -> Sharing (works in Jetpack's offline mode)
Configure sharing buttons to display them on "Front Page, Archive Pages, and Search Results", "Posts", and "Pages"
Add a new page with a Blog Posts block (and not Posts Lists)
Confirm sharing buttons are not displayed under each post in the list of posts in the block shown in the editor

Alternatively, use an Atomic site with the Jetpack Beta plugin and use this PR branch there.

matticbot · 2022-08-01T10:33:38Z

Caution: This PR has changes that must be merged to WordPress.com
Hello wojtekn! These changes need to be synced to WordPress.com - If you 're an a11n, please commandeer and confirm D85150-code works as expected before merging this PR. Once this PR is merged, please commit the changes to WP.com. Thank you!
This revision will be updated with each commit to this PR

github-actions · 2022-08-01T10:34:37Z

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.
✅ All commits were linted before commit.
✅ 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 (other than "Required review") 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 you’ve done so, switch to the "[Status] Needs Review" label; someone from Jetpack Crew will then review this PR and merge it to be included in the next Jetpack release.

Jetpack plugin:

Next scheduled release: September 6, 2022.
Scheduled code freeze: August 30, 2022.

danielbachhuber · 2022-08-01T15:29:19Z

projects/plugins/jetpack/modules/sharedaddy/sharing-service.php

@@ -942,6 +942,11 @@ function sharing_display( $text = '', $echo = false ) {
 		return $text;
 	}

+	// Prevent from rendering sharing buttons in block which is fetched from REST endpoint by editor
+	if ( defined( 'REST_REQUEST' ) && REST_REQUEST ) {


@coder-karen @jeherve Just to confirm, we'd like to always remove the share buttons in REST API responses?

If we wanted to sometimes include share buttons in the REST API response, an alternative approach might be:

Only include share buttons in the REST API response when share buttons are enabled for the post type.

Don't ever include share buttons in the REST API response when it's a dynamic block request.

🤔 I should think we'd not want it in the REST API response, but if we did it would be when they're enabled for the post type.

Given that the injected sharing buttons require enqueued JS to function further down in the chain, I'm not sure why anyone would want the button content to show up in REST API responses 🤔

This tested well for me, and I think it'd be safe to ship and observe for any issue requests that pop up.

When the editor requests this block, it appends the context GET param set to the edit value. I could include it in the condition to address @danielbachhuber concerns. What do you think?

That could work, assuming the main intention is to hide the sharing buttons in the editor. That would tie in with the original linked issue.

Perhaps determining which REST API conditions to include sharing buttons in could be for a separate PR, with this one just removing them from the editor. That said I'll be releasing 11.2 in a few hours so I'm not sure if any of this should be a blocker. Given that the issue itself (share button output in the editor) has been around for quite some time it may be better that I don't try to rush this in to 11.2, then we can make sure all cases are covered.

Or I can just merge as is, like @samiff suggested we can look out for any issues as is, though we could perhaps refine what we do and don't want to include in a further PR. I'll do this then unless anything comes up in the next few hours.

@coder-karen I've just added that additional check and retested it - it still works as expected.

Yes it does. I'll merge this as is, then I think we can follow up in another PR should we need to be stricter with the REST API conditions.

github-actions · 2022-08-02T11:40:50Z

Great news! One last step: head over to your WordPress.com diff, D85150-code, and deploy it.
Once you've done so, come back to this PR and add a comment with your SVN changeset ID (e.g. r12345-wpcom).

Thank you!

…#25346)

wojtekn · 2022-08-02T11:45:57Z

r249967-wpcom

coder-karen · 2022-08-02T11:46:47Z

Cherry-picked to release branch in b3b1455

wojtekn added 2 commits August 1, 2022 12:28

Hide sharing buttons from Blog Posts when it is rendered in the editor

2670813

changelog

76bdba8

wojtekn self-assigned this Aug 1, 2022

matticbot added the Touches WP.com Files label Aug 1, 2022

github-actions bot added [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Status] In Progress [Feature] Sharing Post sharing, sharing buttons labels Aug 1, 2022

wojtekn requested a review from a team August 1, 2022 10:44

wojtekn marked this pull request as ready for review August 1, 2022 10:44

wojtekn added [Status] Needs Team Review and removed [Status] In Progress labels Aug 1, 2022

danielbachhuber reviewed Aug 1, 2022

View reviewed changes

coder-karen added the [Status] Needs Cherry-Pick label Aug 1, 2022

coder-karen added this to the jetpack/11.2 milestone Aug 1, 2022

samiff added [Status] Ready to Merge Go ahead, you can push that green button! Media and removed [Status] Needs Team Review labels Aug 1, 2022

samiff previously approved these changes Aug 1, 2022

View reviewed changes

wojtekn added 2 commits August 2, 2022 13:00

Add a check for editor context to avoid catching other requests

9050a06

Ignore nonce warning as it is not relevant here

f640f8e

wojtekn dismissed samiff’s stale review via f640f8e August 2, 2022 11:05

coder-karen approved these changes Aug 2, 2022

View reviewed changes

coder-karen merged commit 9b67937 into trunk Aug 2, 2022

coder-karen deleted the fix/sharing-buttons-in-editor branch August 2, 2022 11:38

github-actions bot removed the [Status] Ready to Merge Go ahead, you can push that green button! label Aug 2, 2022

coder-karen pushed a commit that referenced this pull request Aug 2, 2022

[not verified] Hide sharing buttons in Blog Posts block in the editor (…

b3b1455

…#25346)

coder-karen removed the [Status] Needs Cherry-Pick label Aug 2, 2022

This was referenced Jan 17, 2023

Sharing buttons are added to the rest API output #7361

Closed

Sharing: do not include buttons in REST API responses #28412

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Hide sharing buttons in Blog Posts block in the editor #25346

Hide sharing buttons in Blog Posts block in the editor #25346

wojtekn commented Aug 1, 2022 •

edited

Loading

matticbot commented Aug 1, 2022

github-actions bot commented Aug 1, 2022 •

edited

Loading

danielbachhuber Aug 1, 2022

coder-karen Aug 1, 2022

samiff Aug 1, 2022 •

edited

Loading

wojtekn Aug 1, 2022

coder-karen Aug 2, 2022

coder-karen Aug 2, 2022

wojtekn Aug 2, 2022

coder-karen Aug 2, 2022

github-actions bot commented Aug 2, 2022

wojtekn commented Aug 2, 2022

coder-karen commented Aug 2, 2022

Hide sharing buttons in Blog Posts block in the editor #25346

Hide sharing buttons in Blog Posts block in the editor #25346

Conversation

wojtekn commented Aug 1, 2022 • edited Loading

Changes proposed in this Pull Request:

Other information:

Jetpack product discussion

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

Testing instructions:

matticbot commented Aug 1, 2022

github-actions bot commented Aug 1, 2022 • edited Loading

danielbachhuber Aug 1, 2022

Choose a reason for hiding this comment

coder-karen Aug 1, 2022

Choose a reason for hiding this comment

samiff Aug 1, 2022 • edited Loading

Choose a reason for hiding this comment

wojtekn Aug 1, 2022

Choose a reason for hiding this comment

coder-karen Aug 2, 2022

Choose a reason for hiding this comment

coder-karen Aug 2, 2022

Choose a reason for hiding this comment

wojtekn Aug 2, 2022

Choose a reason for hiding this comment

coder-karen Aug 2, 2022

Choose a reason for hiding this comment

github-actions bot commented Aug 2, 2022

wojtekn commented Aug 2, 2022

coder-karen commented Aug 2, 2022

wojtekn commented Aug 1, 2022 •

edited

Loading

github-actions bot commented Aug 1, 2022 •

edited

Loading

samiff Aug 1, 2022 •

edited

Loading