- md5
- c7ca672be6ef44ddc369791decd0a3e0
- sha1
- 17688515708f205a561c2f7f224c6da86b04b475
- sha256
- 656d939be67ef91a0fc894976acb86bca56c239f638e1c3382f5c644d00adc9a
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160
<?php
/**
* Entity actions API.
*
* An action definition is the serializable subset of the DataViews Action
* API: every property that is plain data (`id`, `label`, `isPrimary`,
* `supportsBulk`, `context`, `modalHeader`, …). Properties that are
* JavaScript callbacks, components, or elements (`callback`, `RenderModal`,
* `isEligible`, `icon`, a `label` that depends on the items, …) cannot be
* declared here. They are provided by a script module registered for the
* entity along with its actions: its default export maps action ids to the
* properties of each action that are JavaScript. An entity can have several
* modules. Each module applies to the actions it was registered with, see
* {@see wp_get_registered_entity_action_modules()}.
*
* Actions are registered on the `wp_entity_actions_api_init` action, and only there,
* with {@see wp_register_entity_actions()} and {@see wp_unregister_entity_actions()}. The
* other functions read the registry. WordPress core registers its own
* actions the same way, from packages/core-actions.
*
* @package WordPress
* @subpackage Entity Actions
* @since 7.2.0
*/
/**
* Registers actions for an entity, see
* {@see WP_Entity_Actions_Registry::register()}.
*
* It only runs on the `wp_entity_actions_api_init` action.
*
* @since 7.2.0
*
* @param string $origin Who registers the actions: `core`, or
* the slug of the plugin or theme.
* @param string $kind The entity kind (e.g. `postType`).
* @param string $name The entity name (e.g. `page`).
* @param array[] $actions The list of action definitions, each with an `id`.
* @param string|null $script_module The id of the script module providing
* the JavaScript parts of the actions, if any.
* @return string[] The ids of the actions registered, in the order of the
* call. Empty when none is.
*/
function wp_register_entity_actions( $origin, $kind, $name, $actions, $script_module = null ) {
return WP_Entity_Actions_Registry::get_instance()->register( $origin, $kind, $name, $actions, $script_module );
}
/**
* Unregisters actions of an entity, see
* {@see WP_Entity_Actions_Registry::unregister()}.
*
* It only runs on the `wp_entity_actions_api_init` action.
*
* @since 7.2.0
*
* @param string $kind The entity kind (e.g. `postType`).
* @param string $name The entity name (e.g. `page`).
* @param string[]|null $ids The ids of the actions to unregister. Default
* null, every action of the entity.
* @return array[] The list of the definitions unregistered, in
* registration order. Empty when none is.
*/
function wp_unregister_entity_actions( $kind, $name, $ids = null ) {
return WP_Entity_Actions_Registry::get_instance()->unregister( $kind, $name, $ids );
}
/**
* Returns the actions registered for the given entity.
*
* @since 7.2.0
*
* @param string $kind The entity kind (e.g. `postType`).
* @param string $name The entity name (e.g. `page`).
* @return array[] The list of registered action definitions, in
* registration order. Empty until the `init` action has
* completed: a read before then is refused.
*/
function wp_get_registered_entity_actions( $kind, $name ) {
return WP_Entity_Actions_Registry::get_instance()->get_registered( $kind, $name );
}
/**
* Returns the script modules registered for the given entity.
*
* @since 7.2.0
*
* @param string $kind The entity kind (e.g. `postType`).
* @param string $name The entity name (e.g. `page`).
* @return array[] {
* The script modules, in registration order. Empty until the `init`
* action has completed: a read before then is refused.
*
* @type array ...$0 {
* @type string $id The id of the script module.
* @type string[] $actions The ids of the actions the module applies
* to, in registration order.
* }
* }
*/
function wp_get_registered_entity_action_modules( $kind, $name ) {
return WP_Entity_Actions_Registry::get_instance()->get_registered_action_modules( $kind, $name );
}
/**
* Returns the ids of all script modules registered for any entity.
*
* @since 7.2.0
*
* @return array<string, array<string, string[]>> The lists of module ids,
* keyed by kind, then by
* name. Empty until the
* `init` action has
* completed: a read before
* then is refused.
*/
function wp_get_all_registered_entity_action_modules() {
return WP_Entity_Actions_Registry::get_instance()->get_all_registered_action_modules();
}
/**
* Declares the script modules of the entity actions as dependencies of the
* editor script, see _wp_add_entity_modules_to_editor_script().
*
* The actions are loaded by `usePostActions()` of the editor script, so every
* screen showing them loads it.
*
* The `admin_footer` action passes it no argument, so the global registry is
* used. In other scenarios (tests), the scripts are given directly.
*
* @since 7.2.0
* @access private
*
* @param WP_Scripts|null $scripts The scripts registry. Defaults to the global one.
*/
function _wp_add_entity_action_modules_to_editor_script( $scripts = null ) {
_wp_add_entity_modules_to_editor_script( $scripts, 'wp_get_all_registered_entity_action_modules' );
}
/**
* Preloads the actions of the post types the editors list.
*
* The editors read them from the `/wp/v2/entity-actions` route as they load,
* see `useEntityActions()` in
* packages/editor/src/dataviews/entity-actions-loader.ts in Gutenberg. The
* post editor reads those of the edited post in its actions menu. The site
* editor reads those of the edited post, if any, and of the post types of the
* screen it opens on, whose lists show the actions of their items. A path must
* match the request of the `getEntityActionsConfig` core data resolver, see
* packages/core-data/src/resolvers.js in Gutenberg.
*
* @since 7.2.0
* @access private
*
* @param mixed $paths REST API paths to preload.
* @param mixed $context Optional. Block editor context. Default null.
* @return mixed Filtered preload paths. See _wp_add_entity_preload_paths().
*/
function _wp_preload_entity_actions( $paths, $context = null ) {
return _wp_add_entity_preload_paths( $paths, $context, '/wp/v2/entity-actions' );
}
The same content is in 5 releases, WordPress 7.2-beta2 to 7.2-RC1. See them all, or every version of this file.