钩子文档

install_plugins_table_api_args_{$tab}

💡 云策文档标注

概述

install_plugins_table_api_args_{$tab} 是一个动态过滤器钩子,用于修改 WordPress 插件安装屏幕各标签页的 API 请求参数。它允许开发者自定义插件列表的查询条件。

关键要点

  • 这是一个动态钩子,$tab 变量代表插件安装标签页,如 favorites、featured、popular 等。
  • 钩子接收一个参数 $args,类型为数组或 false,用于传递插件安装 API 的参数。
  • 在 WP_Plugin_Install_List_Table::prepare_items() 方法中调用,影响插件列表的显示。

代码示例

$args = apply_filters( "install_plugins_table_api_args_{$tab}", $args );

注意事项

  • 钩子自 WordPress 3.7.0 版本引入,使用时需确保兼容性。
  • 参数 $args 可被修改以调整 API 请求,例如添加搜索条件或排序方式。

📄 原文内容

Filters API request arguments for each Add Plugins screen tab.

Description

The dynamic portion of the hook name, $tab, refers to the plugin install tabs.

Possible hook names include:

  • install_plugins_table_api_args_favorites
  • install_plugins_table_api_args_featured
  • install_plugins_table_api_args_popular
  • install_plugins_table_api_args_recommended
  • install_plugins_table_api_args_upload
  • install_plugins_table_api_args_search
  • install_plugins_table_api_args_beta

Parameters

$argsarray|false
Plugin install API arguments.

Source

$args = apply_filters( "install_plugins_table_api_args_{$tab}", $args );

Changelog

Version Description
3.7.0 Introduced.