innocode-digital / wp-innocode-community
此包已被 废弃 并不再维护。没有建议的替代包。
帮助将 Innocode Community 与网站集成。
0.3.0
2020-06-05 15:23 UTC
Requires
- php: >=7.1
- ext-json: *
- composer/installers: ~1.0
This package is auto-updated.
Last update: 2022-12-05 20:45:17 UTC
README
描述
帮助将 Innocode Community 与网站集成。
安装
-
首选方式是使用 Composer
composer require innocode-digital/wp-innocode-community
默认情况下,它将被安装为 必需插件。但可以通过
composer.json
中的extra.installer-paths
进行控制。 -
另一种方式是将此存储库克隆到
wp-content/mu-plugins/
或wp-content/plugins/
cd wp-content/plugins/ git clone git@github.com:innocode-digital/wp-innocode-community.git cd wp-innocode-community/ composer install
如果插件作为常规插件安装,请从插件页面激活 Community 或通过 WP-CLI: wp plugin activate wp-innocode-community
。
用法
添加所需常量(通常到 wp-config.php
)
define( 'INNOCODE_COMMUNITY_INSTANCE_URL', '' );
define( 'INNOCODE_COMMUNITY_CONSUMER_TOKEN', '' );
文档
获取 Innocode Community API 对象:
innocode_community();
注意:如果缺少所需的常量 INNOCODE_COMMUNITY_INSTANCE_URL
和/或 INNOCODE_COMMUNITY_CONSUMER_TOKEN
,则会触发错误。
获取一个源:
innocode_community()->get_feed( int $id, array $query_args = [], array $args = [] );
$id
- 源 ID。$query_args
- 查询参数。$args
- 请求参数。有关更多信息,请参阅 WP_Http::request()。
向 API 执行 HTTP 请求:
// Performs any HTTP request
innocode_community()->request( string $method, string $path, array $query_args = [], array $args = [] );
// Performs GET HTTP request
innocode_community()->get( string $path, array $query_args = [], array $args = [] );
$method
- 请求方法。接受GET
、POST
、HEAD
、PUT
、DELETE
、TRACE
、OPTIONS
或PATCH
。$path
- 端点路径。$query_args
- 查询参数。$args
- 请求参数。有关更多详细信息,请参阅 WP_Http::request()。
REST API
HTTP 方法 | 端点 | 函数 |
---|---|---|
GET | /innocode/v1/community/feeds/<id> |
通过 API 从社区获取源。 |
请求参数
名称 | 类型 | 描述 |
---|---|---|
id | int | 源 ID。必需 |