wppaste
WordPress

apply_filters( 'pre_upload_error', bool $error )

Since
2.1.0
Filters whether to preempt the XML-RPC media upload.

Description

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

Compatibility

WordPress
since 2.1.0
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0).

Parameters

$errorbool
Whether to pre-empt the media upload. Default false.

Where this hook fires · 1

  • wp-includes/class-wp-xmlrpc-server.php:6491wp_xmlrpc_server::mw_newMediaObject()

Source code

View on Trac View on GitHub 

		 * returning that value as a 500 error instead.		 *		 * @since 2.1.0		 *		 * @param bool $error Whether to pre-empt the media upload. Default false.		 */		$upload_err = apply_filters( 'pre_upload_error', false );		if ( $upload_err ) {			return new IXR_Error( 500, $upload_err );		} 		$upload = wp_upload_bits( $name, null, $bits );		if ( ! empty( $upload['error'] ) ) {

Changelog

Introduced in 2.1.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 7.0.4 tag, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.