wp_media_upload_handler(): null|string

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Return value

null|string

Performance profile

How much work a call to wp_media_upload_handler() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via get_post().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

19–102

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 211.

Plugin surface

2 hooks

Third-party callbacks on '{$type}_send_to_editor_url', 'image_send_to_editor_url' run inside this call, and their cost is not bounded by anything here.

Called by

4

4 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly
• querycontent queryget_post()one call below wp_media_upload_handler()

Further down the call graph this can also reach option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 32 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_media_upload_handler() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 2

2 hooks fire while wp_media_upload_handler() runs, in this order:

1. 1
   apply_filters( {$type}_send_to_editor_url )filterline 934 (+61 into the body)

   Filters the URL sent to the editor for a specific media type.

2. 2
   apply_filters( image_send_to_editor_url )filterline 959 (+86 into the body)

   Filters the image URL sent to the editor.

Uses · 16

• check_admin_referer()Ensures intent by verifying that a user was referred from another admin page with the correct security nonce.
• media_handle_upload()Saves a file submitted from a POST request and create an attachment post for it.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• esc_html()Escaping for HTML blocks.
• wp_unslash()Removes slashes from a string or recursively removes slashes from strings within an array.
• wp_basename()i18n-friendly version of basename().
• esc_url()Checks and cleans a URL.
• wp_ext2type()Retrieves the file type based on the extension name.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• sanitize_url()Sanitizes a URL for database or redirect usage.
• esc_attr()Escaping for HTML attributes.
• media_send_to_editor()Adds image HTML to editor.

Used by · 4

• media_upload_audio()Handles uploading an audio file.
• media_upload_file()Handles uploading a generic file.
• media_upload_image()Handles uploading an image.
• media_upload_video()Handles uploading a video file.

Source code

View on Trac ↗View on GitHub ↗

873function wp_media_upload_handler() {874	$errors = array();875	$id     = 0;876 877	if ( isset( $_POST['html-upload'] ) && ! empty( $_FILES ) ) {878		check_admin_referer( 'media-form' );879		// Upload File button was clicked.880		$id = media_handle_upload( 'async-upload', $_REQUEST['post_id'] );881		unset( $_FILES );882 883		if ( is_wp_error( $id ) ) {884			$errors['upload_error'] = $id;885			$id                     = false;886		}887	}888 889	if ( ! empty( $_POST['insertonlybutton'] ) ) {890		$src = $_POST['src'];891 892		if ( ! empty( $src ) && ! strpos( $src, '://' ) ) {893			$src = "http://$src";894		}895 896		if ( isset( $_POST['media_type'] ) && 'image' !== $_POST['media_type'] ) {897			$title = esc_html( wp_unslash( $_POST['title'] ) );898			if ( empty( $title ) ) {899				$title = esc_html( wp_basename( $src ) );900			}901 902			if ( $title && $src ) {903				$html = "<a href='" . esc_url( $src ) . "'>$title</a>";904			}905 906			$type = 'file';907			$ext  = preg_replace( '/^.+?\.([^.]+)$/', '$1', $src );908 909			if ( $ext ) {910				$ext_type = wp_ext2type( $ext );911				if ( 'audio' === $ext_type || 'video' === $ext_type ) {912					$type = $ext_type;913				}914			}915 916			/**917			 * Filters the URL sent to the editor for a specific media type.918			 *919			 * The dynamic portion of the hook name, `$type`, refers to the type920			 * of media being sent.921			 *922			 * Possible hook names include:923			 *924			 *  - `audio_send_to_editor_url`925			 *  - `file_send_to_editor_url`926			 *  - `video_send_to_editor_url`927			 *928			 * @since 3.3.0929			 *930			 * @param string $html  HTML markup sent to the editor.931			 * @param string $src   Media source URL.932			 * @param string $title Media title.933			 */934			$html = apply_filters( "{$type}_send_to_editor_url", $html, sanitize_url( $src ), $title );935		} else {936			$align = '';937			$alt   = esc_attr( wp_unslash( $_POST['alt'] ) );938 939			if ( isset( $_POST['align'] ) ) {940				$align = esc_attr( wp_unslash( $_POST['align'] ) );941				$class = " class='align$align'";942			}943 944			if ( ! empty( $src ) ) {945				$html = "<img src='" . esc_url( $src ) . "' alt='$alt'$class />";946			}947 948			/**949			 * Filters the image URL sent to the editor.950			 *951			 * @since 2.8.0952			 *

Changelog

Introduced in 2.5.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 6.7.7 tag, from src/wp-admin/includes/media.php, 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.