首页 视频课程 主题开发课程第21章、REST API WordPress REST API 用户接口详细情况

WordPress REST API 用户接口详细情况

2023-06-11 / 474阅

WordPress REST API 用户接口详细情况

WordPress REST API 是 WordPress 提供的一种新型 API,它基于 HTTP 和 RESTful 架构,允许开发者以标准方法与 WordPress 进行交互。其中,用户接口是 WordPress REST API 中较为重要的一个接口之一,它允许用户对 WordPress 中的用户进行查询、创建、更新和删除等操作。

1. 查询用户

查询 WordPress 中的用户,需要使用 wp/v2/users 这个 REST API 地址。请求该地址时,可以传递一些参数来对用户进行筛选,比如按照用户名、邮箱等进行查询。下面是一个示例代码:

// 发送 GET 请求到 wp/v2/users
$response = wp_remote_get( 'http://example.com/wp-json/wp/v2/users' );

// 获取返回的数据
$data = wp_remote_retrieve_body( $response );

// 把 JSON 字符串解码成 PHP 数组
$results = json_decode( $data );

// 输出结果
foreach ( $results as $result ) {
    echo $result->name;
} 

上述代码会查询所有 WordPress 用户,并输出他们的用户名。

2. 创建用户

创建 WordPress 中的用户,需要使用 wp/v2/users 这个 REST API 地址。请求该地址时,需要传递一个 JSON 格式的参数,包含了用户的用户名、邮箱、密码等信息。下面是一个示例代码:

// 发送 POST 请求到 wp/v2/users
$response = wp_remote_post( 'http://example.com/wp-json/wp/v2/users', array(
    'headers' => array(
        'Content-Type' => 'application/json',
    ),
    'body'    => json_encode( array(
        'username' => 'newuser',
        'email'    => 'newuser@example.com',
        'password' => 'password',
    ) ),
) );

// 获取返回的数据
$data = wp_remote_retrieve_body( $response );

// 把 JSON 字符串解码成 PHP 数组
$result = json_decode( $data );

// 输出结果
echo $result->name; 

上述代码会创建一个名为 newuser 的用户,并输出他的用户名。

3. 更新用户

更新 WordPress 中的用户,需要使用 wp/v2/users/{id} 这个 REST API 地址。其中,id 表示需要更新的用户 ID。请求该地址时,需要传递一个 JSON 格式的参数,包含了需要更新的用户信息。下面是一个示例代码:

// 发送 POST 请求到 wp/v2/users/{id}
$response = wp_remote_post( 'http://example.com/wp-json/wp/v2/users/1', array(
    'headers' => array(
        'Content-Type' => 'application/json',
    ),
    'body'    => json_encode( array(
        'email' => 'newemail@example.com',
    ) ),
) );

// 获取返回的数据
$data = wp_remote_retrieve_body( $response );

// 把 JSON 字符串解码成 PHP 数组
$result = json_decode( $data );

// 输出结果
echo $result->name; 

上述代码会更新 ID 为 1 的用户的邮箱为 newemail@example.com

4. 删除用户

删除 WordPress 中的用户,需要使用 wp/v2/users/{id} 这个 REST API 地址。其中,id 表示需要删除的用户 ID。请求该地址时,需要使用 DELETE 方法发送请求。下面是一个示例代码:

// 发送 DELETE 请求到 wp/v2/users/{id}
$response = wp_remote_request( 'http://example.com/wp-json/wp/v2/users/1', array(
    'method' => 'DELETE',
) );

// 获取返回的数据
$data = wp_remote_retrieve_body( $response );

// 把 JSON 字符串解码成 PHP 数组
$result = json_decode( $data );

// 输出结果
echo $result->name; 

上述代码会删除 ID 为 1 的用户。

阅读文章或者观看视频过程中有任何问题,请下方留言或者联系我Q248758228

大家谈论
    我的见解
    目录