Add Command Palette support #121

priethor · 2025-04-25T11:58:27Z

What

This PR adds support for WordPress Command Palette/Core Commands (Cmd+K / Ctrl+K interface) by registering:

Core commands to navigate to SCF admin pages
"View All" commands for each Custom Post Type registered with SCF
"Add new" for each Custom Post Type registered with SCF

Implementation details

The commands are divided into admin and CPT command files.

Core commands are only registered when the current user has admin permissions
CPT commands are registered only when these conditions are met:
- The current user has enough capabilities to edit the CPT
- The CPT has enabled the show_ui setting

To prevent errors and optimize performance, JavaScript files for core and/or CPT commands will only be enqueued when needed.

Testing Instructions

Ensure you're using WordPress 6.3+ (Commands API was introduced in 6.3)
Ensure you have registered at least one CPT (e.g., "Books")
Press Cmd+K (Mac) or Ctrl+K (Windows) in the Block Editor
Type "SCF" or "Taxonomies" to see SCF-related admin commands
Type your CPT name ("Books") to see its related commands ("View books", "Add book")
Verify that commands correctly navigate to their respective pages
As an administrator, verify you can see both admin commands and CPT ones
As a user with limited permissions, verify that you only see commands you have access to. For example, an editor should only see CPT commands
Test with a WordPress version earlier than 6.3 to confirm that no errors occur

Recording

Grabacion.de.pantalla.2025-04-25.a.las.13.55.21.mov

Followups

Consider registering commands with useCommandLoader instead, which was introduced in WP 6.4.
Add tests
Implement a new REST endpoint for CPTs to avoid using acf_localize_data
Migrate to TypeScript

Includes a refactor to divide commands between core and post-type based: core commands require admin permissions, whereas post-types are dynamic and depend on their own capabilities.

…similar to modules

gziolo

I left some initial general feedback before trying to better understand how it exactly works. I will try to test it next.

assets/src/js/commands/admin-commands.js

gziolo · 2025-04-25T14:14:07Z

assets/src/js/commands/admin-commands.js

+	const { __ } = wp.i18n;
+	const { createElement } = wp.element;
+	const { Icon } = wp.components;
+	const commandStore = wp.data.dispatch( 'core/commands' );


It is possible to use import statements to let the build tackle detecting all dependencies. @cbravobernal added all necessary code to automate it. See:

Webpack configuration: update to be similar as Gutenberg / Core development #86

gziolo · 2025-04-25T14:15:57Z

assets/src/js/commands/admin-commands.js

+			description: command.description,
+			keywords: command.keywords,
+			callback: ( { close } ) => {
+				document.location = command.url;


Nit: the following could help remove some duplication from the command config a bit:

Suggested change

document.location = command.url;

document.location = adminUrl + command.url;

includes/assets.php

assets/src/js/commands/admin-commands.js

gziolo · 2025-04-25T14:46:07Z

You can also divide the work into two PRs since it’s fully functional and tests well. Command Palette support doesn’t have to be a Beta Feature because it’s a straightforward enhancement that anyone familiar with the concept should appreciate.

Follow-up work could include:

Refactoring JS files to TS.
Enhancing asset management to automatically detect dependencies in the build step.

However, we need to take a closer look at the functionality, particularly the strategy for when these commands become available, depending on the WP version, the presence of custom post types, and user permissions.

Co-authored-by: Greg Ziółkowski <grzegorz@gziolo.pl>

assets/src/js/commands/admin-commands.js

assets/src/js/commands/custom-post-type-commands.js

includes/admin/admin-commands.php

Co-authored-by: Greg Ziółkowski <grzegorz@gziolo.pl>

- Defer the script loading (defer was introduced in WP 6.3) - Defer script execution by using the priority queue (introduced in WP 5.0) Since the scripts will only be registered in versions with Command API support, which is 6.3+, we can use both

youknowriad · 2025-04-27T09:58:12Z

assets/src/js/commands/admin-commands.js

+/**
+ * Register admin commands for SCF
+ */
+queue.add( context, () => {


It's not really clear to me why you're using "priority-queue" here? Did you actually notice performance issues or something. Also potentially you can just use requestIdleCallback directly instead of using a queue with a single callback.

I did not notice any performance difference; I implemented the priority queue in parallel to defer the loading here.

Let's just get rid of it. I think defer is enough.

I simplified to a requestIdleCallback here before reading your answer. Should I get rid of that, too? It still seems overkill.

assets/src/js/commands/admin-commands.js

includes/admin/admin-commands.php

youknowriad · 2025-04-27T10:04:17Z

includes/admin/admin-commands.php

+	}
+
+	if ( ! empty( $custom_post_types ) ) {
+		acf_localize_data(


Personally, I'd argue that we should move away from localized variables like that as much as possible and instead use REST API endpoints. Do SCF has endpoints to retrieve these things, can't we just rely on Core endpoints for post types...?

I think the only endpoints registered are the ones that fetch custom post types and post fields, in every field you can chose to include it or not in the WP default API endpoints for posts fetching, but there are no internal endpoints to retrieve all post types or all post fields created with the plugin.

They are instead localizing the data:

secure-custom-fields/includes/assets.php

Line 603 in 8b71adb

acf_localize_data( $data_to_localize );

secure-custom-fields/includes/admin/post-types/admin-field-group.php

Line 151 in 8b71adb

acf_localize_data(

Moving everything to a REST API could be done, but this needs to define a new API structure, with its own documentation and decide the approach for the store handling ( using Redux based like wp-data, or move to React Query or something similar )

What's your opinion on that @youknowriad ?

There are two issues why using the Rest API would require some extra work and I didn't consider for this:

While it does a PHP function to retrieve SCF Post types (acf_get_acf_post_types), it doesn't have a custom enpoint to do so, just WordPress` built in endpoints.

More importantly, in order to show CPTs in the REST API, each CPT needs to enable the Show in REST API setting.

Therefore, my guess is we will need custom SCF endpoints for the admin that show all, as we will encounter a similar issue when implementing DataViews. What do you think about this approach, Riad?

We're on WordPress, so for me, we should be use the entities and core-data here. no need to duplicate things that exist.

More importantly, in order to show CPTs in the REST API, each CPT needs to enable the Show in REST API setting.

For me this is something that we should try to get rid of. Every CPT should be visible in the endpoints, I think this is a setting of another age.

That said, for now, a custom endpoint/entity could work if we're not ready to make all CPTs created by SCF show_in_rest true. Are there any valid reasons for not doing it?

Are there any valid reasons for not doing it?

If by this you mean a custom endpoint, the only reason not to do it right now is the extra complexity it adds to this PR, we should probably tackle that separately.

As per the existing setting, I wouldn't change an existing setting as we don't know all the cases or real users (e.g., having CPTs only for the admin to manage private data), though.

As per the existing setting, I wouldn't change an existing setting as we don't know all the cases or real users (e.g., having CPTs only for the admin to manage private data), though.

This is different than show_in_rest, this should be mostly handled by the public boolean.

Thinking a bit more about this:

Right now, we would need to use the types endpoint.

show_in_rest determines whether a custom post type gets its own endpoint, but also hides the CPT definition from the types endpoint.

In any case, the types endpoint doesn't return any information to know whether a type is a CPT and/or created by SCF (e.g., no post-type field)

Therefore, my inclination is to create a new endpoint for custom post types that ignores the show_in_rest. This will be needed, too, when migrating the Post Types screen to DataViews.

The ideal scenario is to actually use the types endpoint and add "metadata" to the post type. That said, I think it's a good interim solution to have a custom endpoint.

includes/assets.php

youknowriad

In parallel to this PR, I wonder if we should implement this PR within SCF (before it gets into Core) to enable the command palette everywhere.

youknowriad · 2025-04-28T11:55:38Z

So for me, the PR is fine. But I think we should ask ourselves what we want to do with these post types and any SCF UI going forward. Do we want to decouple the server and client and have a consistent data layer to communicate between both (ideally on top of core-data) or do we want to continue with these localized scripts which for me feels like hacks.

An investment in the core-data layer will help this PR but also any future PR that would like to rely on SCF entities in its client UI.

priethor · 2025-04-28T15:31:48Z

Do we want to decouple the server and client and have a consistent data layer to communicate between both (ideally on top of core-data) or do we want to continue with these localized scripts which for me feels like hacks.

I don't know if a hack, but it did feel like a dated approach that doesn't align with the current direction of core and modern architecture. I do agree with investing in decoupling server and client; the amount of data required in this PR is minimal, but as we move forward with new functionalities, it will pay off or even become necessary.

How do you all feel about this PR with the current approach, and then follow up with the new endpoint implementation?

youknowriad · 2025-04-28T15:38:12Z

How do you all feel about this PR with the current approach, and then follow up with the new endpoint implementation?

I'm ok with this personally, but I would try to avoid the acf script dependency, it seems this is not needed at all and we can just use any random global variable.

priethor added 19 commits April 23, 2025 18:39

First attempt at adding command palette support

5215215

Command polishing

d6006fe

Add commands for registered CPTs

4ec2af9

Refactor

18e250f

Refactor to use wp.scf

77bdff1

Refactor

b8894cf

Refactor to pass the data in acf.data.customPostTypes

6fce2a9

Fix redirections

f28d69d

Check capabilities before registering comands

6e4431c

Includes a refactor to divide commands between core and post-type based: core commands require admin permissions, whereas post-types are dynamic and depend on their own capabilities.

Filter post types that don't enable the setting "show in UI"

65485ac

Redo webpack config linting

b06b8a7

Redo webpack linting

f5a6cba

Apply linting

4c6f5da

Polish

c592beb

Refactor

3907d63

Fix coding standards in comments

60b8184

Ensure we only register the commands when the palette is available

af46e4a

Refactor to remove scf and acf prefixes, organizing files in folders …

b2d95ab

…similar to modules

Optimize return early

101de27

priethor added the [Type] Enhancement New feature or request label Apr 25, 2025

priethor self-assigned this Apr 25, 2025

priethor changed the title ~~First attempt at adding command palette support~~ Add Command Palette support Apr 25, 2025

gziolo reviewed Apr 25, 2025

View reviewed changes

assets/src/js/commands/admin-commands.js Outdated Show resolved Hide resolved

priethor and others added 3 commits April 25, 2025 16:51

Remove unnecessary script registration

4b6a953

Use the scf prefix in admin commands.

1a62407

Co-authored-by: Greg Ziółkowski <grzegorz@gziolo.pl>

Use scf prefix for CPT commands

47c480c

gziolo reviewed Apr 25, 2025

View reviewed changes

assets/src/js/commands/admin-commands.js Outdated Show resolved Hide resolved

gziolo reviewed Apr 25, 2025

View reviewed changes

assets/src/js/commands/custom-post-type-commands.js Outdated Show resolved Hide resolved

gziolo reviewed Apr 25, 2025

View reviewed changes

includes/admin/admin-commands.php Outdated Show resolved Hide resolved

priethor and others added 8 commits April 25, 2025 17:16

Only pass CPTs to the frontend when the array is not empty

9bed553

Co-authored-by: Greg Ziółkowski <grzegorz@gziolo.pl>

CPT commands: only add label as a keyword if not empty

dfa0104

Polish

54176c5

Refactor the depencies to user import statements

a23722c

Optimize scripts loading and execution

887f2cf

- Defer the script loading (defer was introduced in WP 6.3) - Defer script execution by using the priority queue (introduced in WP 5.0) Since the scripts will only be registered in versions with Command API support, which is 6.3+, we can use both

Update package-lock.json

9944ea2

Slight refactor

4def381

Assets: remove redundant registrations, prefix registered scritps

1df01fe

priethor force-pushed the add-command-palette-support branch from 764103d to 1df01fe Compare April 25, 2025 17:19

youknowriad reviewed Apr 27, 2025

View reviewed changes

assets/src/js/commands/admin-commands.js Show resolved Hide resolved

youknowriad reviewed Apr 27, 2025

View reviewed changes

includes/admin/admin-commands.php Show resolved Hide resolved

youknowriad reviewed Apr 27, 2025

View reviewed changes

includes/admin/admin-commands.php Outdated Show resolved Hide resolved

youknowriad reviewed Apr 27, 2025

View reviewed changes

includes/admin/admin-commands.php Outdated Show resolved Hide resolved

youknowriad reviewed Apr 27, 2025

View reviewed changes

includes/assets.php Show resolved Hide resolved

youknowriad reviewed Apr 27, 2025

View reviewed changes

priethor added 3 commits April 28, 2025 11:41

Remove redundant admin check

ccb0edc

Remove unnecesary checking of acf_get_acf_post_types

b5f9199

Change the priority queue to a simpler requestIdleCallback

71342ac

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Command Palette support #121

Add Command Palette support #121

priethor commented Apr 25, 2025 •

edited

Loading

gziolo left a comment

gziolo Apr 25, 2025

gziolo Apr 25, 2025

gziolo commented Apr 25, 2025

youknowriad Apr 27, 2025

priethor Apr 28, 2025 •

edited

Loading

youknowriad Apr 28, 2025

priethor Apr 28, 2025

youknowriad Apr 27, 2025

cbravobernal Apr 28, 2025

priethor Apr 28, 2025 •

edited

Loading

youknowriad Apr 28, 2025

priethor Apr 28, 2025 •

edited

Loading

youknowriad Apr 28, 2025

priethor Apr 28, 2025

youknowriad Apr 28, 2025 •

edited

Loading

youknowriad left a comment

youknowriad commented Apr 28, 2025

priethor commented Apr 28, 2025

youknowriad commented Apr 28, 2025

	document.location = command.url;
	document.location = adminUrl + command.url;

Add Command Palette support #121

Are you sure you want to change the base?

Add Command Palette support #121

Conversation

priethor commented Apr 25, 2025 • edited Loading

What

Implementation details

Testing Instructions

Recording

Followups

gziolo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gziolo commented Apr 25, 2025

Choose a reason for hiding this comment

priethor Apr 28, 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

priethor Apr 28, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

priethor Apr 28, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

youknowriad Apr 28, 2025 • edited Loading

Choose a reason for hiding this comment

youknowriad left a comment

Choose a reason for hiding this comment

youknowriad commented Apr 28, 2025

priethor commented Apr 28, 2025

youknowriad commented Apr 28, 2025

priethor commented Apr 25, 2025 •

edited

Loading

priethor Apr 28, 2025 •

edited

Loading

priethor Apr 28, 2025 •

edited

Loading

priethor Apr 28, 2025 •

edited

Loading

youknowriad Apr 28, 2025 •

edited

Loading