Action Bar: Add `Action Bar visibility` general setting #41015

ntsekouras · 2025-01-14T06:15:22Z

This PR adds a new general setting (wpcom_show_action_bar) to conditionally show the Action Bar on the front end of a site. It adds the interface for the classic wp-admin interface and its default value is true to preserve current behavior where we always show the Action Bar.

The main issue will need two more PRs to be complete that I'll create and link shortly:

wpcom to check this option and not enqueue the Action Bar
calypso to add UI for this setting.

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?

I saw that some other settings are being tracked. Do we need to do the same for this one?

Testing instructions:

For now (until I create the other PRs) you can go in classic wp-admin interface and check the UI for this new setting and observe that its value is being updated properly and defaults to true.

github-actions · 2025-01-14T06:16:17Z

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 a "[Type]" label (Bug, Enhancement, Janitorial, Task).
✅ 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:

Ensure all required checks appearing at the bottom of this PR are passing.
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.
Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

Mu Wpcom plugin:

Next scheduled release: WordPress.com Simple releases happen semi-continuously (PCYsg-Jjm-p2).

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

github-actions · 2025-01-14T06:16:21Z

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/action-bar-visibility-general-setting 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-mu-wpcom-plugin add/action-bar-visibility-general-setting

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

ntsekouras · 2025-01-15T05:39:05Z

projects/packages/jetpack-mu-wpcom/src/features/wpcom-admin-interface/wpcom-admin-interface.php

+ * The setting is displayed only if the has the wp-admin interface selected.
+ */
+function wpcomsh_wpcom_show_action_bar_settings_field() {
+	add_settings_field( 'wpcom_show_action_bar', '', 'wpcom_show_action_bar_display', 'general', 'default' );


I realized that atomic sites don't show the Action Bar and I'm wondering whether we should check about the type before adding this setting ( at least for now ). 🤔

Yeah, we should check if the site is Simple before running this.

Alternatively, if there are no plans to bring the action bar to Atomic sites, you could implement this logic directly in the wpcom repo, which only runs on Simple sites.

There is an issue asking for the action bar in atomic sites: Automattic/wp-calypso#36795

In order to do that, I think we should move the actionbar mu-plugin from wpcom repo to jetpack-wpcom-mu-plugin or something like that.

In order to do that, I think we should move the actionbar mu-plugin from wpcom repo to jetpack-wpcom-mu-plugin or something like that.

Yes. @cbravobernal is something you're working on? My linked issue with yours are kind of co-dependent.

Not yet, I was checking how to do it while I found this task and decided to wait. Feel free to take it if you feel more comfortable tackling all together.

@cbravobernal sounds good. I'll see what's decided about atomic and handle these two issues accordingly.

if there are no plans to bring the action bar to Atomic sites, you could implement this logic directly in the wpcom repo, which only runs on Simple sites.

I would also recommend keeping things together in the dotcom codebase for now. It will make it easier to move things around when/if we eventually bring the action bar to WoA sites.

Sounds good. I'll port these changes to dotcom.

mmtr · 2025-01-15T09:47:21Z

projects/packages/jetpack-mu-wpcom/src/features/wpcom-admin-interface/wpcom-admin-interface.php

+ * The setting is stored in the `wpcom_show_action_bar` option.
+ * The setting is displayed only if the has the wp-admin interface selected.
+ */
+function wpcomsh_wpcom_show_action_bar_settings_field() {


The wpcom-admin-interface.php file was intended to contain logic involving the different admin interfaces (Default, Classic), so I'd move this part to somewhere else. Maybe you can add a new features/action-bar/action-bar.php file?

Also, this isn't a wpcomsh function, so I'd remove that prefix.

Suggested change

function wpcomsh_wpcom_show_action_bar_settings_field() {

function wpcom_show_action_bar_settings_field() {

mmtr · 2025-01-15T09:49:02Z

projects/packages/jetpack-mu-wpcom/src/features/wpcom-admin-interface/wpcom-admin-interface.php

+ * The setting is displayed only if the has the wp-admin interface selected.
+ */
+function wpcomsh_wpcom_show_action_bar_settings_field() {
+	add_settings_field( 'wpcom_show_action_bar', '', 'wpcom_show_action_bar_display', 'general', 'default' );


Yeah, we should check if the site is Simple before running this.

Alternatively, if there are no plans to bring the action bar to Atomic sites, you could implement this logic directly in the wpcom repo, which only runs on Simple sites.

Action Bar: Add Action Bar visibility general setting

ca6f9a1

ntsekouras added [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it [Status] In Progress [Status] Needs Team Review [Plugin] mu wpcom jetpack-mu-wpcom plugin labels Jan 14, 2025

ntsekouras requested review from simison, jeherve, mmtr and Copons January 14, 2025 06:15

ntsekouras self-assigned this Jan 14, 2025

github-actions bot added the [mu wpcom Feature] Wpcom Admin Interface label Jan 14, 2025

github-actions bot added the [Package] Jetpack mu wpcom WordPress.com Features label Jan 14, 2025

ntsekouras mentioned this pull request Jan 14, 2025

Add site setting to hide the Action Bar Automattic/wp-calypso#98318

Open

8 tasks

ntsekouras commented Jan 15, 2025

View reviewed changes

mmtr reviewed Jan 15, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Action Bar: Add `Action Bar visibility` general setting #41015

Action Bar: Add `Action Bar visibility` general setting #41015

ntsekouras commented Jan 14, 2025

github-actions bot commented Jan 14, 2025

github-actions bot commented Jan 14, 2025 •

edited

Loading

ntsekouras Jan 15, 2025

mmtr Jan 15, 2025

cbravobernal Jan 15, 2025

ntsekouras Jan 15, 2025

cbravobernal Jan 15, 2025 •

edited

Loading

ntsekouras Jan 15, 2025

jeherve Jan 15, 2025

ntsekouras Jan 15, 2025

mmtr Jan 15, 2025

mmtr Jan 15, 2025

	function wpcomsh_wpcom_show_action_bar_settings_field() {
	function wpcom_show_action_bar_settings_field() {

Action Bar: Add Action Bar visibility general setting #41015

Are you sure you want to change the base?

Action Bar: Add Action Bar visibility general setting #41015

Conversation

ntsekouras commented Jan 14, 2025

Other information:

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

Testing instructions:

github-actions bot commented Jan 14, 2025

github-actions bot commented Jan 14, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cbravobernal Jan 15, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Action Bar: Add `Action Bar visibility` general setting #41015

Action Bar: Add `Action Bar visibility` general setting #41015

github-actions bot commented Jan 14, 2025 •

edited

Loading

cbravobernal Jan 15, 2025 •

edited

Loading