npm包 kasia-plugin-wp-api-all-terms 使用教程

前言

Kasia是一个WordPress主题开发库，提供了一整套的开发模板和组件库。其中，kasia-plugin-wp-api-all-terms可以让我们通过WordPress REST API获取所有分类术语的详细信息。

安装

安装该npm包非常简单，只需要在命令行中执行以下命令即可：

npm install kasia-plugin-wp-api-all-terms

使用

使用kasia-plugin-wp-api-all-terms获取WordPress分类术语信息非常方便，只需要调用getTerms方法即可。该方法包含三个参数：

1. taxonomy：必填项，表示要获取的分类法
2. params：选填项，用于筛选结果的参数
3. output：选填项，表示要输出的结果形式（默认为json）

示例代码

const getTerms = require('kasia-plugin-wp-api-all-terms');

getTerms('category', { parent: 0 }, 'object')
  .then(terms => console.log(terms))
  .catch(error => console.log(error));

参数

getTerms方法的参数列表如下：

taxonomy (必填项)

要获取的分类法，可以是自定义分类法名字（比如my_custom_taxonomy）或默认的分类法（比如category或post_tag）。

params (可选项)

用于筛选结果的参数，可以是：

1. include：包含特定术语ID的列表，使用逗号分隔
2. exclude：排除特定术语ID的列表，使用逗号分隔
3. slug：通过术语别名获取术语信息
4. parent：过滤父级术语ID，0表示顶级术语
5. hide_empty：是否隐藏空的术语，true或false
6. number：返回数量限制，0表示不限制
7. offset：跳过前n个术语
8. orderby：排序字段，默认是id
9. order：排序方式，默认是desc
10. meta_key：筛选元数据的键名
11. meta_value：筛选元数据的键值

output (可选项)

表示要输出的结果形式，可以是：

• object：返回对象格式(string)：{ 标签名字: { count: 1, slug: "标签别名", term_group: 0, term_id: 1, taxonomy: "分类法名字", description: "标签描述", parent: 0 } }。
• id：返回术语ID的数组格式，比如[1,2,3]
• name：返回术语名字的数组格式，比如["foo","bar","baz"]

总结

以上是关于kasia-plugin-wp-api-all-terms npm包的详细说明与使用方法介绍。希望本篇文章能为您在WordPress分类术语查询过程中提供一些帮助。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066efd4c49986ca68d8a97