钩子文档

plugins_api_result

💡 云策文档标注

概述

plugins_api_result 是一个 WordPress 过滤器钩子,用于修改 Plugin Installation API 的响应结果。它允许开发者在插件安装或信息检索过程中自定义返回的数据。

关键要点

  • 过滤器名称:plugins_api_result
  • 参数:$res(响应对象或 WP_Error)、$action(请求类型)、$args(API 参数)
  • 用途:过滤插件安装 API 的响应,可用于调整插件数据或错误处理
  • 相关函数:plugins_api()

代码示例

add_filter( 'plugins_api_result', 'custom_plugins_api_result', 10, 3 );
function custom_plugins_api_result( $res, $action, $args ) {
    // 自定义逻辑,例如修改响应数据
    if ( is_wp_error( $res ) ) {
        // 处理错误情况
    } else {
        // 修改成功响应
    }
    return $res;
}

📄 原文内容

Filters the Plugin Installation API response results.

Parameters

$resobject|WP_Error
Response object or WP_Error.
$actionstring
The type of information being requested from the Plugin Installation API.
$argsobject
Plugin API arguments.

Source

return apply_filters( 'plugins_api_result', $res, $action, $args );

Changelog

Version Description
2.7.0 Introduced.