pre_upload_error

Filters whether to preempt the XML-RPC media upload.

Description

apply_filters( 'pre_upload_error', (bool) $false ); 

Passing a truthy value will effectively short-circuit the media upload, returning that value as a 500 error instead.

Parameters (1)

0. $false (bool) => false
Whether to pre-empt the media upload. Default false.

Usage

To run the hook, copy the example below.
  1. $false = apply_filters( 'pre_upload_error', $false ); 
  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 pre_upload_error callback 
  2. function filter_pre_upload_error( $false ) { 
  3. // make filter magic happen here... 
  4. return $false
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'pre_upload_error', 'filter_pre_upload_error', 10, 1 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'pre_upload_error', 'filter_pre_upload_error', 10, 1 ); 

Defined (1)

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

/wp-includes/class-wp-xmlrpc-server.php  
  1. if ( $upload_err = apply_filters( 'pre_upload_error', false ) ) {