WordPress核心数据

命名空间:核心.

选择器

can用户

返回当前用户是否可以对给定REST资源执行给定操作。

调用它可能会通过canUser()解析器。

https://developer.wordpress.org/rest-api/reference网站/

参数

  • 状态 :数据状态。
  • 行动 一串:要检查的操作。其中之一:“创建”、“读取”、“更新”、“删除”。
  • 资源 一串:要检查的REST资源,例如“媒体”或“帖子”。
  • 身份证件 实体记录密钥:要检查的剩余资源的可选ID。

退换商品

  • 布尔|未定义:用户是否可以执行操作,或未定义如果OPTIONS请求仍在进行中。

canUserEditEntityRecord(用户编辑实体记录)

返回当前用户是否可以编辑给定实体。

调用它可能会通过canUser()解析器。

https://developer.wordpress.org/rest-api/reference网站/

参数

  • 状态 :数据状态。
  • 友善的 一串:实体类型。
  • 名称 一串:实体名称。
  • 记录Id 实体记录密钥:记录的id。

退换商品

  • 布尔|未定义:用户是否可以编辑,或未定义如果OPTIONS请求仍在进行中。

获取作者

已弃用自11.3起。呼叫者应使用select('core').getUsers({who:'authors'})而不是。

返回所有可用作者。

参数

  • 状态 :数据状态。
  • 查询 获取记录HttpQuery:要包含在请求中的查询参数的可选对象。有关有效的查询参数,请参阅用户页面在REST API手册中,并查看列出用户检索用户.

退换商品

  • ET.用户[]:作者列表。

获取自动保存

返回文章和作者的自动保存。

参数

  • 状态 :状态树。
  • postType(后类型) 一串:父帖子的类型。
  • 帖子Id 实体记录密钥:父帖子的id。
  • 作者ID 实体记录密钥:作者的id。

退换商品

  • EntityRecord |未定义:文章和作者的自动保存。

获取自动保存

返回文章的最新自动保存。

可能会返回多个自动保存,因为后端为每个帖子的每个作者存储一个自动保存。

参数

  • 状态 :状态树。
  • postType(后类型) 一串:父帖子的类型。
  • 帖子Id 实体记录密钥:父帖子的id。

退换商品

  • 数组<any>|未定义:文章的自动保存数组,如果没有则为未定义数组。

获取块模式类别

检索已注册块图案类别的列表。

参数

  • 状态 :数据状态。

退换商品

  • 数组<any>:块图案类别列表。

获取块模式

检索已注册块模式的列表。

参数

  • 状态 :数据状态。

退换商品

  • 数组<any>:块模式列表。

获取当前主题

返回当前主题。

参数

  • 状态 :数据状态。

退换商品

  • 任何:当前主题。

getCurrentThemeGlobalStyles修订版

已弃用自WordPress 6.5.0起。呼叫者应使用select('core').getRevisions('root','globalStyles',${recordKey})相反,其中记录密钥是全局样式父帖子的id。

返回当前全局样式主题的修订。

参数

  • 状态 :数据状态。

退换商品

  • 数组<object>|null:当前全局样式。

获取当前用户

返回当前用户。

参数

  • 状态 :数据状态。

退换商品

  • ET.User<'编辑'>:当前用户对象。

获取默认模板ID

返回用于呈现给定查询的默认模板。

参数

  • 状态 :数据状态。
  • 查询 模板查询:查询。

退换商品

  • 一串:给定查询的默认模板id。

获取编辑的实体记录

返回与其编辑内容合并的指定实体记录。

参数

  • 状态 :状态树。
  • 友善的 一串:实体类型。
  • 名称 一串:实体名称。
  • 记录Id 实体记录密钥:记录ID。

退换商品

  • ET.Updataable<实体记录>|错误:实体记录与其编辑内容合并。

获取嵌入预览

返回给定URL的嵌入预览。

参数

  • 状态 :数据状态。
  • 网址 一串:嵌入式URL。

退换商品

  • 任何:如果尚未获取预览,则为未定义,否则为从嵌入预览API获取的预览。

按种类获取实体

已弃用自WordPress 6.0以来。改用getEntitiesConfig

返回给定种类的已加载实体。

参数

  • 状态 :数据状态。
  • 友善的 一串:实体类型。

退换商品

  • 数组<any>:配置匹配类型的实体数组。

获取实体配置

返回给定类型的已加载实体。

参数

  • 状态 :数据状态。
  • 友善的 一串:实体类型。

退换商品

  • 数组<any>:配置匹配类型的实体数组。

获取实体

已弃用自WordPress 6.0以来。改用getEntityConfig

返回给定种类和名称的实体配置。

参数

  • 状态 :数据状态。
  • 友善的 一串:实体类型。
  • 名称 一串:实体名称。

退换商品

  • 任何:实体配置

获取实体配置

返回给定种类和名称的实体配置。

参数

  • 状态 :数据状态。
  • 友善的 一串:实体类型。
  • 名称 一串:实体名称。

退换商品

  • 任何:实体配置

获取实体记录

按键返回实体的记录对象。退换商品无效的如果尚未收到值,如果已知值实体不存在,则为未定义,如果存在并收到了实体对象,则为实体对象。

参数

  • 状态 :状态树
  • 友善的 一串:实体类型。
  • 名称 一串:实体名称。
  • 钥匙 实体记录密钥:记录的密钥
  • 查询 获取记录HttpQuery:可选查询。如果请求特定字段,字段必须始终包含ID。有关有效的查询参数,请参阅参考并选择实体类型。然后查看可用的参数“Retrieve a[Entity kind]”。

退换商品

  • EntityRecord |未定义:记录。

获取实体记录编辑

返回指定实体记录的编辑。

参数

  • 状态 :状态树。
  • 友善的 一串:实体类型。
  • 名称 一串:实体名称。
  • 记录Id 实体记录密钥:记录ID。

退换商品

  • 可选<any>:实体记录的编辑。

获取实体记录非瞬态编辑

返回指定实体记录的非暂时编辑。

临时编辑不会创建撤消级别,并且不考虑进行更改检测。它们在实体的配置中定义。

参数

  • 状态 :状态树。
  • 友善的 一串:实体类型。
  • 名称 一串:实体名称。
  • 记录Id 实体记录密钥:记录ID。

退换商品

  • 可选<any>:实体记录的非暂时编辑。

获取实体记录

返回实体的记录。

参数

  • 状态 :状态树
  • 友善的 一串:实体类型。
  • 名称 一串:实体名称。
  • 查询 获取记录HttpQuery:可选术语查询。如果请求特定字段,字段必须始终包含ID。有关有效的查询参数,请参阅参考并选择实体类型。然后查看“List[Entity kind]s”的可用参数。

退换商品

  • EntityRecord[]|空:记录。

获取实体记录总计项

返回给定查询的实体可用记录总数(忽略分页)。

参数

  • 状态 :状态树
  • 友善的 一串:实体类型。
  • 名称 一串:实体名称。
  • 查询 获取记录HttpQuery:可选术语查询。如果请求特定字段,字段必须始终包含ID。有关有效的查询参数,请参阅参考并选择实体类型。然后查看“List[Entity kind]s”的可用参数。

退换商品

  • number |空:number | null。

获取实体记录总页面

返回给定查询的可用页数。

参数

  • 状态 :状态树
  • 友善的 一串:实体类型。
  • 名称 一串:实体名称。
  • 查询 获取记录HttpQuery:可选术语查询。如果请求特定字段,字段必须始终包含ID。有关有效的查询参数,请参阅参考并选择实体类型。然后查看“List[Entity kind]s”的可用参数。

退换商品

  • number |空:number | null。

获取最后一个实体删除错误

返回指定实体记录的上次删除错误。

参数

  • 状态 :状态树。
  • 友善的 一串:实体类型。
  • 名称 一串:实体名称。
  • 记录Id 实体记录密钥:记录ID。

退换商品

  • 任何:实体记录的保存错误。

获取最后实体保存错误

返回指定实体记录的上次保存错误。

参数

  • 状态 :状态树。
  • 友善的 一串:实体类型。
  • 名称 一串:实体名称。
  • 记录Id 实体记录密钥:记录ID。

退换商品

  • 任何:实体记录的保存错误。

获取原始实体记录

按键返回实体的记录对象,其属性映射到其原始值。

参数

  • 状态 :状态树。
  • 友善的 一串:实体类型。
  • 名称 一串:实体名称。
  • 钥匙 实体记录密钥:记录的密钥。

退换商品

  • EntityRecord |未定义:具有实体原始属性的对象。

获取重做编辑

已弃用自6.3起

返回实体记录编辑历史(如果有)的当前撤消偏移量的下一个编辑。

参数

  • 状态 :状态树。

退换商品

  • 可选<any>:编辑。

按不同编辑获取引用

当编辑的值发生更改时,返回新的引用。这对于通过使用严格等式比较返回值来推断状态之间的编辑位置很有用。

用法

const hasEditOccurred=(getReferenceByDistinctEdits(beforeState)==按DistinctEdits获取引用(在状态之后));

参数

  • 状态编辑器状态。

退换商品

  • 仅当发生编辑时其引用才会更改的值。

获取修订版

返回父实体的单个特定修订。

参数

  • 状态 :状态树
  • 友善的 一串:实体类型。
  • 名称 一串:实体名称。
  • 记录密钥 实体记录密钥:要获取其修订的实体记录的键。
  • 修订密钥 实体记录密钥:修订的密钥。
  • 查询 获取记录HttpQuery:可选查询。如果请求特定字段,字段必须始终包含ID。有关有效的查询参数,请参阅中的修订架构REST API手册。然后查看可用的参数“检索[实体种类]”。

退换商品

  • 修订记录|记录<PropertyKey,never>|未定义:记录。

获取修订

返回实体的修订。

参数

  • 状态 :状态树
  • 友善的 一串:实体类型。
  • 名称 一串:实体名称。
  • 记录密钥 实体记录密钥:要获取其修订的实体记录的键。
  • 查询 获取记录HttpQuery:可选查询。如果请求特定字段,字段必须始终包含ID。有关有效的查询参数,请参阅中的修订方案REST API手册。然后查看可用的参数“检索[实体种类]”。

退换商品

  • 修订记录[]|null:记录。

获取主题支持

返回主题支持索引中的数据。

参数

  • 状态 :数据状态。

退换商品

  • 任何:索引数据。

获取取消编辑

已弃用自6.3起

返回实体记录编辑历史(如果有)的当前撤消偏移的上一次编辑。

参数

  • 状态 :状态树。

退换商品

  • 可选<any>:编辑。

获取用户模式类别

检索已注册的用户模式类别。

参数

  • 状态 :数据状态。

退换商品

  • 阵列<UserPatternCategory>:用户模式类别数组。

获取用户查询结果

返回查询ID返回的所有用户。

参数

  • 状态 :数据状态。
  • 查询ID 一串:查询ID。

退换商品

  • ET.User<'编辑'>[]:用户列表。

具有实体记录的编辑

如果指定的实体记录有编辑,则返回true,否则返回false。

参数

  • 状态 :状态树。
  • 友善的 一串:实体类型。
  • 名称 一串:实体名称。
  • 记录Id 实体记录密钥:记录ID。

退换商品

  • 布尔值:实体记录是否有编辑。

具有实体记录

如果已收到给定参数集的记录,则返回true,否则返回false。

参数

  • 状态 :状态树
  • 友善的 一串:实体类型。
  • 名称 一串:实体名称。
  • 查询 获取记录HttpQuery:可选术语查询。有关有效的查询参数,请参阅参考并选择实体类型。然后查看“List[Entity kind]s”的可用参数。

退换商品

  • 布尔值:是否已收到实体记录。

hasFetched自动保存

如果自动保存的REST请求已完成,则返回true。

参数

  • 状态 :状态树。
  • postType(后类型) 一串:父帖子的类型。
  • 帖子Id 实体记录密钥:父帖子的id。

退换商品

  • 布尔值:如果REST请求已完成,则为True。否则为False。

hasRedo(已恢复)

如果实体记录编辑历史记录的当前撤消偏移量有下一次编辑,则返回true,否则返回false。

参数

  • 状态 :状态树。

退换商品

  • 布尔值:是否有下一次编辑。

has撤消

如果实体记录编辑历史记录的当前撤消偏移量有以前的编辑,则返回true,否则返回false。

参数

  • 状态 :状态树。

退换商品

  • 布尔值:是否有以前的编辑。

是自动保存实体记录

如果指定的实体记录是自动保存的,则返回true,否则返回false。

参数

  • 状态 :状态树。
  • 友善的 一串:实体类型。
  • 名称 一串:实体名称。
  • 记录Id 实体记录密钥:记录ID。

退换商品

  • 布尔值:实体记录是否自动保存。

正在删除实体记录

如果指定的实体记录正在删除,则返回true,否则返回false。

参数

  • 状态 :状态树。
  • 友善的 一串:实体类型。
  • 名称 一串:实体名称。
  • 记录Id 实体记录密钥:记录ID。

退换商品

  • 布尔值:实体记录是否正在删除。

是预览嵌入回退

确定返回的预览是否为oEmbed链接回退。

WordPress可以配置为在URL不可嵌入的情况下返回一个简单的链接。我们需要能够根据从oEmbed预览API获得的信息来确定URL是否可嵌入。

参数

  • 状态 :数据状态。
  • 网址 一串:嵌入式URL。

退换商品

  • 布尔值:URL的预览是否为oEmbed链接回退。

正在请求嵌入预览

如果正在请求嵌入预览数据,则返回true,否则返回false。

参数

  • 状态 :数据状态。
  • 网址 一串:预览将用于的URL。

退换商品

  • 布尔值:是否正在请求嵌入预览。

是保存实体记录

如果指定的实体记录正在保存,则返回true,否则返回false。

参数

  • 状态 :状态树。
  • 友善的 一串:实体类型。
  • 名称 一串:实体名称。
  • 记录ID 实体记录密钥:记录ID。

退换商品

  • 布尔值:实体记录是否保存。

行动

添加实体

返回用于添加新实体的操作对象。

参数

  • 实体 阵列:已收到实体。

退换商品

  • 对象:Action对象。

删除实体记录

已触发删除实体记录的操作。

参数

  • 友善的 一串:已删除实体的类型。
  • 名称 一串:已删除实体的名称。
  • 记录Id 一串:已删除实体的记录ID。
  • 查询 ?对象:DELETE API调用的特殊查询参数。
  • 选项 [对象]:删除选项。
  • 选项__不稳定获取 [功能]:仅供内部使用。要调用的函数,而不是apiFetch()。必须返回承诺。
  • 选项.throwOnError [布尔值]:如果为false,此操作将禁止所有异常。默认为false。

编辑实体记录

返回触发实体记录编辑的操作对象。

参数

  • 友善的 一串:编辑的实体记录的类型。
  • 名称 一串:编辑的实体记录的名称。
  • 记录Id 数字|字符串:编辑的实体记录的记录ID。
  • 编辑 对象:编辑。
  • 选项 对象:编辑选项。
  • options.undo忽略 [布尔值]:是否忽略撤消历史中的编辑。

退换商品

  • 对象:Action对象。

接收默认模板ID

返回用于设置给定查询模板的操作对象。

参数

  • 查询 对象:查找查询。
  • 模板ID 一串:解析的模板id。

退换商品

  • 对象:Action对象。

接收实体记录

返回用于发出已接收实体记录的信号的操作对象。

参数

  • 友善的 一串:收到的实体记录的类型。
  • 名称 一串:收到的实体记录的名称。
  • 记录 数组|对象:收到的记录。
  • 查询 ?对象:查询对象。
  • 使缓存失效 ?布尔值:应使查询缓存无效。
  • 编辑 ?对象:编辑以重置。
  • ?对象:有关分页的元信息。

退换商品

  • 对象:Action对象。

接收导航回退Id

返回一个动作对象,用信号表示已接收到回退导航菜单id。

参数

  • 回退Id 整数:后备导航菜单的id

退换商品

  • 对象:Action对象。

接收修订

已触发接收修订项目的操作。

参数

  • 友善的 一串:收到的实体记录修订的类型。
  • 名称 一串:收到的实体记录修订的名称。
  • 记录密钥 数字|字符串:要获取其修订的实体记录的键。
  • 记录 数组|对象:收到的修订。
  • 查询 ?对象:查询对象。
  • 使缓存失效 ?布尔值:应使查询缓存无效。
  • ?对象:有关分页的元信息。

接收主题支持

已弃用由于WP 5.9,这不再有用,直接使用选择器。

返回用于发出已收到索引的信号的操作对象。

退换商品

  • 对象:Action对象。

接收上传权限

已弃用自WP 5.9以来,请改用receiveUserPermission。

返回一个操作对象,该对象用于发出已收到上载权限的信号。

参数

  • hasUploadPermissions(具有上传权限) 布尔值:用户是否有上传文件的权限?

退换商品

  • 对象:Action对象。

重做

触发的操作,用于对实体记录(如果有)重做上次撤消的编辑。

保存编辑的实体记录

已触发保存实体记录编辑的操作。

参数

  • 友善的 一串:实体的类型。
  • 名称 一串:实体的名称。
  • 记录Id 对象:记录的ID。
  • 选项 对象:保存选项。

保存实体记录

已触发保存实体记录的操作。

参数

  • 友善的 一串:接收实体的类型。
  • 名称 一串:接收实体的名称。
  • 记录 对象:要保存的记录。
  • 选项 对象:保存选项。
  • 选项.is自动保存 [布尔值]:这是否是自动保存。
  • 选项__不稳定获取 [功能]:仅供内部使用。要调用的函数,而不是apiFetch()。必须返回承诺。
  • 选项.throwOnError [布尔值]:如果为false,此操作将禁止所有异常。默认为false。

解开

触发操作以撤消对实体记录的最后一次编辑(如果有)。