zao-web/wp-api-connect-ui

提供通过OAuth1.0在WordPress REST API上连接到另一个WordPress安装的UI。此插件是WP API Connect的UI包装器。

安装: 8

依赖: 0

建议者: 0

安全: 0

星标: 0

关注者: 5

分支: 7

公开问题: 0

类型:wordpress-plugin

v0.2.6 2017-03-09 19:41 UTC

This package is not auto-updated.

Last update: 2024-09-20 21:07:01 UTC


README

贡献者: Zao
捐赠链接: http://zao.is
标签
需要至少 4.7.0
已测试到 4.7.3
稳定标签 0.2.6
许可证: GPLv2
许可证URI: https://gnu.ac.cn/licenses/gpl-2.0.html

描述

提供通过WordPress REST APIOAuth1连接到另一个WordPress安装的UI。此插件是WP API Connect的UI包装器。

注意事项

  • 要使用此插件,您需要从插件的根目录运行composer install以拉取所需的依赖项,或下载此zip文件
  • 连接到服务器的服务器上需要安装WP REST API插件OAuth插件
  • 您需要在服务器上创建一个 '客户端应用程序'。在保存服务器URL后,此插件设置页面将为您提供说明。

使用方法

一旦您通过设置屏幕创建了一个成功的API连接,您可以使用插件提供的API辅助函数/过滤器。如果连接成功,辅助函数和过滤器都返回一个Zao\WP_API\OAuth1\Connect对象(此处为示例用法),您可以使用它来发送API请求。

过滤器是提供辅助函数的替代方案,以便您可以在其他插件或主题中使用而不必检查function_exists。为此,请简单地使用$api = apply_filters( 'wp_api_connect_ui_api_object', false );。如果wp_api_connect_ui_api_object函数不可用,您将返回原始值false。无论是使用函数还是过滤器,您都需要在发送请求之前检查返回的$api对象是否是WP_Error对象(is_wp_error)或Zao\WP_API_Connect对象(is_a( $api, 'Zao\WP_API\OAuth1\Connect' ))。

// Get API object
$api = apply_filters( 'wp_api_connect_ui_api_object', false );

// If WP_Error, find out what happened.
if ( is_wp_error( $api ) ) {
	echo '<xmp>'. print_r( $api->get_error_message(), true ) .'</xmp>';
}

// If a Zao\WP_API\OAuth1\Connect object is returned, you're good to go.
if ( is_a( $api, 'Zao\WP_API\OAuth1\Connect' ) ) {

	$schema = $api->get_api_description();

	// Let's take a look at the API schema
	echo '<xmp>$schema: '. print_r( $schema, true ) .'</xmp>';
}

安装

手动安装

  1. 将整个/wp-api-connect-ui目录上传到/wp-content/plugins/目录。
  2. /wp-content/plugins/wp-api-connect-ui目录内运行composer install
  3. 通过WordPress的“插件”菜单激活WP API Connect UI。
  4. 更新连接设置。

要避免步骤2,下载此zip文件,解压文件,然后按照步骤1、3和4进行。

常见问题解答

屏幕截图(自0.2.0以来有些过时)

  1. 设置 设置

  2. 保存设置后,需要认证。保存设置后,需要认证。

  3. 成功的认证通知,展示了可用的路由。成功的认证通知,展示了可用的路由。

变更日志

0.2.6

  • 更新 wp-api-connect 依赖,从 composer 中移除 Ryan McCue 的 Requests 库,因为它现在存在于 WP 核心中。
  • 重命名插件
  • 为“可选头”部分添加切换按钮。

0.2.5

  • 更新 wp-api-connect 依赖,修复一个变量(针对旧模式)应使用对象属性的拼写错误。

0.2.4

  • 更新 wp-api-connect 依赖,修复一些错误并在 auth_request 方法中。

0.2.3

  • 修复一些认证步骤逻辑,并确保发现调用不要太频繁。
  • 更新 wp-api-connect 依赖,修复一些错误并添加到请求参数的过滤器。

0.2.2

  • 现在所有步骤都可用“可选头”字段,以确保在发现过程中发送正确的头。
  • 更新 wp-api-connect 依赖,使我们能够使用自己的 API 发现库来使用 WP http API,并在存在的情况下正确传递任何头。

0.2.1

  • 更新 composer 文件以指向 WP API Connect 的正确 packagist 仓库。

0.2.0

  • 更新以修复一些安全问题并与新的 OAuth 插件版本一起工作。

0.1.0

  • 首次发布