README

用于从 WordPress.org API 获取信息的客户端。WordPress.org API 的文档位于 此处。

安装

composer require camrymps/wordpress.org-api

入门指南

use WordPressOrgApi\WordPress as WordPressClient;

$client = new WordPressClient;
$client = new WordPressClient(true); // Returns all responses as associative arrays (optional)

使用方法

checkVersion()

返回当前支持的 WordPress 版本信息。

$client->checkVersion();

searchThemes([$params])

返回带有相关信息的主题列表。

$client->searchThemes();

$client->searchThemes([
    "search" => "foo",
    "fields" => [
        "description" => true
    ]
]);

getTheme($slug[, $params])

返回特定主题的信息。

$client->getTheme("twentyseventeen");

$client->getTheme("twentyseventeen", [
    "fields" => [
        "description" => true
    ]
]);

getHotThemeTags([$params])

返回最受欢迎的主题标签列表。

$client->getHotThemeTags()

$client->getHotThemeTags([
    "number" => 10
]);

getThemeFeatureList()

返回有效的主题标签列表。

$client->getThemeFeatureList();

searchPlugins([$params])

返回带有相关信息的插件列表。

$client->searchPlugins();

$client->searchPlugins([
    "search" => "foo",
    "fields" => [
        "description" => true
    ]
]);

getPlugin($slug[, $params])

返回特定插件的信息。

$client->getPlugin("jetpack");

$client->getPlugin("jetpack", [
    "fields" => [
        "description" => true
    ]
]);

getHotPluginTags([$params])

返回最受欢迎的插件标签列表。

$client->getHotPluginTags();

$client->getHotPluginTags([
    "number" => 10
]);

getPopularImportPlugins()

返回 WordPress 插件目录中最受欢迎的导入插件列表。

$client->getPopularImportPlugins();

参数

有关上述方法可以使用的高级参数的详细列表，请参阅位于 此处 的 WordPress.org API。

异步

只需将 "Async" 添加到方法名末尾即可异步使用所有方法。例如

$promise = $client->getThemeAsync("twentyseventeen");

$promise->then(
    function($theme) {
        var_dump($theme);
    }
);