函数文档

rest_add_application_passwords_to_index()

💡 云策文档标注

概述

rest_add_application_passwords_to_index() 函数用于向 REST API 索引添加应用密码信息。它检查应用密码是否可用,并在可用时向响应对象添加相关端点数据。

关键要点

  • 函数将应用密码信息添加到 REST API 索引的响应数据中。
  • 仅在 wp_is_application_passwords_available() 返回 true 时执行操作。
  • 添加的端点包括授权 URL,通过 admin_url('authorize-application.php') 获取。
  • 函数返回修改后的 WP_REST_Response 对象。

代码示例

function rest_add_application_passwords_to_index( $response ) {
	if ( ! wp_is_application_passwords_available() ) {
		return $response;
	}

	$response->data['authentication']['application-passwords'] = array(
		'endpoints' => array(
			'authorization' => admin_url( 'authorize-application.php' ),
		),
	);

	return $response;
}

注意事项

  • 此函数从 WordPress 5.6.0 版本开始引入。
  • 依赖 wp_is_application_passwords_available() 函数检查应用密码的全局可用性。
  • 使用 admin_url() 函数生成管理区域的授权 URL。

📄 原文内容

Adds Application Passwords info to the REST API index.

Parameters

$responseWP_REST_Responserequired
The index response object.

Return

WP_REST_Response

Source

function rest_add_application_passwords_to_index( $response ) {
	if ( ! wp_is_application_passwords_available() ) {
		return $response;
	}

	$response->data['authentication']['application-passwords'] = array(
		'endpoints' => array(
			'authorization' => admin_url( 'authorize-application.php' ),
		),
	);

	return $response;
}

Changelog

Version Description
5.6.0 Introduced.