plugins_api_args

Filters the WordPress.org Plugin Install API arguments.

Description

apply_filters( 'plugins_api_args', (object) $args, (string) $action ); 

Important: An object MUST be returned to this filter.

Parameters (2)

0. $args (object)
Plugin API arguments.
1. $action (string)
The type of information being requested from the Plugin Install API.

Usage

To run the hook, copy the example below.
  1. $args = apply_filters( 'plugins_api_args', $args, $action ); 
  2.  
  3. if ( !empty( $args ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the plugins_api_args callback 
  2. function filter_plugins_api_args( $args, $action ) { 
  3. // make filter magic happen here... 
  4. return $args
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'plugins_api_args', 'filter_plugins_api_args', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'plugins_api_args', 'filter_plugins_api_args', 10, 2 ); 

Defined (1)

The filter is defined in the following location(s).

/wp-admin/includes/plugin-install.php  
  1. $args = apply_filters( 'plugins_api_args', $args, $action );