@wordpress/插件

WordPress的插件模块。

安装

安装模块

npm install@wordpress/plugins--保存

此包假定您的代码将在2015年欧洲标准+环境。如果您使用的环境对此类语言功能和API的支持有限或不支持,您应该包括polyfill发货@wordpress/babel预设在代码中。

插件API

获取插件

返回已注册的插件设置。

参数

  • 名称 一串:插件名称。

退换商品

  • WPPlugin|未定义:插件设置。

获取插件

返回没有范围或给定范围的所有已注册插件。

参数

  • 范围 一串:在插件区域内渲染时要使用的范围。默认情况下没有范围。

退换商品

  • WP插件[]:没有范围或给定范围的插件列表。

插件区域

呈现所有插件的组件填充一个隐藏的div。

用法

//使用ES5语法var el=反应创建元素;var插件区域=wp.plugins。插件区域;函数Layout(){return el(“div”,{scope:“my page”},“页面内容”,PluginArea);}
//使用ESNext语法从“@wordpress/plugins”导入{PluginArea};常量布局=()=>(<div>页面内容<PluginArea scope=“my-page”/></div>);

参数

  • 道具 {scope?:string;onError?:(name:WPPlugin['name'],error:error)=>void;}:
  • 道具镜 一串:
  • props.onError错误 (name:WPPlugin['name'],错误:错误)=>void:

退换商品

  • 组件:要渲染的组件。

寄存器插件

向编辑器注册插件。

用法

//使用ES5语法var el=反应创建元素;var片段=wp.element。碎片;var插件边栏=wp.editor。插入式边栏;var PluginSidebarMoreMenuItem=wp.editor。插件边栏更多菜单项;var寄存器插件=wp.plugins.registerPlugin;var moreIcon=React.createElement('svg');//。。。svg元素。函数Component(){返回el(碎片,{},埃尔(插件边栏更多菜单项,{target:'侧边栏名称',},'我的提要栏'),埃尔(插件提要栏,{name:'侧边栏名称',title:'我的提要栏',},'侧边栏内容'));}registerPlugin('插件名称'{图标:更多图标,渲染:组件,scope:'我的页面',} );
//使用ESNext语法从“@wordpress/editor”导入{PluginSidebar、PluginSiderbarMoreMenuItem};从“@wordpress/plugins”导入{registerPlugin};从“@wordpress/icons”导入{more};常量分量=()=>(<><PluginSidebarMoreMenuItem target=“sidebar-name”>我的工具条</PluginSidebarMoreMenuItem><PluginSidebar name=“sidebar-name”title=“我的侧边栏”>侧边栏的内容</PluginSidebar></>);registerPlugin('插件名称'{icon:更多,渲染:组件,scope:'我的页面',} );

参数

  • 名称 一串:标识插件的字符串。必须在所有注册插件中唯一。
  • 设置 插件设置:此插件的设置。

退换商品

  • 插件设置|null:最终插件设置对象。

取消注册插件

按名称注销插件。

用法

//使用ES5语法var unregisterPlugin=wp.plugins.unregister插件;unregisterPlugin(“插件名称”);
//使用ESNext语法从“@wordpress/plugins”导入{unregisterPlugin};unregisterPlugin(“插件名称”);

参数

  • 名称 一串:插件名称。

退换商品

  • WPPlugin|未定义:前一个插件设置对象(如果已成功注销);否则未定义.

使用插件上下文

返回插件上下文的钩子。

退换商品

  • 插件上下文:插件上下文

带插件上下文

用于将插件上下文注入封装组件的高阶组件。

参数

  • 将上下文映射到属性 (上下文:PluginContext,道具:T)=>T&PluginContext:在每次上下文更改时调用函数,期望返回props的对象以与组件自己的props合并。

退换商品

  • 组件:使用注入的上下文作为道具的增强组件。

参与此包

这是古腾堡项目的一部分。该项目组织为单回购。它由多个独立的软件包组成,每个包都有特定的用途。此monorepo中的包发布到净现值法并由使用WordPress(文字出版社)以及其他软件项目。

要了解更多关于对这个包或古腾堡整体贡献的信息,请阅读该项目的主要内容贡献者指南.