WordPress REST API 根据用户名获取用户：问题与解决方案

2024-03-10 19:04:53

通过 WordPress REST API 根据用户名获取用户

在管理 WordPress 网站时，通过其 REST API 根据用户名检索用户非常有用。但是，此操作可能会遇到一些挑战，本文将深入探讨此问题，并提供逐步指南，帮助您轻松解决问题，成功获取用户数据。

问题陈述

当您尝试使用以下端点 https://my-website.com/wp-json/wp/v2/users?search=my-username 根据用户名从 WordPress 网站中获取用户时，却收到一个空数组作为响应。尽管您已验证用户名，但它确实存在于 WordPress 网站中。

解决方案

要解决此问题，请按照以下步骤操作：

检查用户权限： 确保您拥有访问用户数据的权限。默认情况下，只有具有管理员权限的用户才能通过 REST API 获取用户数据。
验证身份： 在请求中使用正确的身份验证标头。对于 WordPress REST API，您需要使用 Authorization: Bearer <your-api-key> 标头，其中 <your-api-key> 是您的 API 密钥。
检查 REST API 设置： 确保您的 WordPress 网站已启用 REST API。您可以在 设置 → 常规 → 写入 下找到此设置。
使用正确的查询参数： 要根据用户名检索用户，请使用 username 查询参数，而不是 search 查询参数。正确的端点应该是：https://my-website.com/wp-json/wp/v2/users?username=my-username。
处理响应： 如果一切设置正确，您将收到一个 JSON 响应，其中包含有关指定用户的详细信息。

示例代码

以下是一个使用 JavaScript 的示例代码，用于根据用户名检索用户：

// 获取你的 API 密钥
const apiKey = 'YOUR_API_KEY';

// 构建请求
const request = new Request('https://my-website.com/wp-json/wp/v2/users?username=my-username', {
  headers: {
    'Authorization': `Bearer ${apiKey}`
  }
});

// 发送请求
fetch(request)
  .then(response => response.json())
  .then(data => {
    console.log(data);
  })
  .catch(error => {
    console.error('Error:', error);
  });