云策 WordPress 开发者社区

块编辑器开发文档

命令数据

查看官方原文 ↗
💡 云策文档标注

概述

本文档描述了 WordPress 核心命令数据模块，包括用于管理命令和命令加载器的选择器和动作，适用于开发者扩展命令面板功能。

关键要点

  • 选择器：提供 getCommandLoaders、getCommands、getContext 和 isOpen 等方法，用于获取注册的命令加载器、静态命令、活动上下文和命令面板状态。
  • 动作：包括 close、open、registerCommand、registerCommandLoader、unregisterCommand 和 unregisterCommandLoader 等动作，用于控制命令面板的开关和命令的注册与注销。
  • 参数与返回：所有方法均接受 state 参数，部分方法支持 contextual 参数，返回类型包括数组、字符串、布尔值或动作对象。
📄 原文内容

Namespace: core/commands.

Selectors

getCommandLoaders

Returns the registered command loaders.

Parameters

  • state Object: State tree.
  • contextual boolean: Whether to return only contextual command loaders.

Returns

  • import('./actions').WPCommandLoaderConfig[]: The list of registered command loaders.

getCommands

Returns the registered static commands.

Parameters

  • state Object: State tree.
  • contextual boolean: Whether to return only contextual commands.

Returns

  • import('./actions').WPCommandConfig[]: The list of registered commands.

getContext

Returns whether the active context.

Parameters

  • state Object: State tree.

Returns

  • string: Context.

isOpen

Returns whether the command palette is open.

Parameters

  • state Object: State tree.

Returns

  • boolean: Returns whether the command palette is open.

Actions

close

Closes the command palette.

Returns

  • Object: action.

open

Opens the command palette.

Returns

  • Object: action.

registerCommand

Returns an action object used to register a new command.

Parameters

  • config WPCommandConfig: Command config.

Returns

  • Object: action.

registerCommandLoader

Register command loader.

Parameters

  • config WPCommandLoaderConfig: Command loader config.

Returns

  • Object: action.

unregisterCommand

Returns an action object used to unregister a command.

Parameters

  • name string: Command name.

Returns

  • Object: action.

unregisterCommandLoader

Unregister command loader hook.

Parameters

  • name string: Command loader name.

Returns

  • Object: action.