钩子文档

plugins_api_args

💡 云策文档标注

概述

plugins_api_args 过滤器用于修改 WordPress.org 插件安装 API 的参数。此过滤器必须返回一个对象,以确保 API 请求的正确处理。

关键要点

  • 过滤器名称:plugins_api_args
  • 用途:过滤插件安装 API 的参数,允许开发者自定义请求数据
  • 参数:$args(对象,插件 API 参数)和 $action(字符串,请求类型)
  • 要求:必须返回一个对象,否则可能导致 API 错误
  • 相关函数:plugins_api(),用于从 WordPress.org 插件 API 检索插件安装页面
  • 引入版本:WordPress 2.7.0

代码示例

$args = apply_filters( 'plugins_api_args', $args, $action );

📄 原文内容

Filters the WordPress.org Plugin Installation API arguments.

Description

Important: An object MUST be returned to this filter.

Parameters

$argsobject
Plugin API arguments.
$actionstring
The type of information being requested from the Plugin Installation API.

Source

$args = apply_filters( 'plugins_api_args', $args, $action );

Changelog

Version Description
2.7.0 Introduced.