upgrader_pre_download

Filters whether to return the package.

Description

apply_filters( 'upgrader_pre_download', (bool) $false, (string) $package, (WP_Upgrader) $instance ); 

Parameters (3)

0. $false (bool) => false
Whether to bail without returning the package. Default false.
1. $package (string)
The package file name.
2. $instance (WP_Upgrader)
The WP_Upgrader instance.

Usage

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

Defined (1)

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

/wp-admin/includes/class-wp-upgrader.php  
  1. $reply = apply_filters( 'upgrader_pre_download', false, $package, $this );