WordPress at a glance

media_sideload_image() WP 1.0

Downloads an image from the specified URL and attaches it to a post.

Возвращает

String/WP_Error. Populated HTML img tag on success, WP_Error object otherwise.

No Hooks.

Usage

media_sideload_image( $file, $post_id, $desc, $return );
$file(string) (required)
The URL of the image to download.
$post_id(int)
The post ID the media is to be associated with.
Default: 0
$desc(string)
Description of the image.
Default: null
$return(string)
Accepts 'html' (image tag html) or 'src' (URL), or 'id' (attachment ID).
Default: 'html'

Список изменений

С версии 2.6.0 Введена.
С версии 4.2.0 Introduced the $return parameter.
С версии 4.8.0 Introduced the 'id' option within the $return parameter.
С версии 5.3.0 The $post_id parameter was made optional.
С версии 5.4.0 The original URL of the attachment is stored in the _source_url post meta value.

Code of media_sideload_image() WP 5.5.1

wp-admin/includes/media.php
<?php
function media_sideload_image( $file, $post_id = 0, $desc = null, $return = 'html' ) {
	if ( ! empty( $file ) ) {

		// Set variables for storage, fix file filename for query strings.
		preg_match( '/[^\?]+\.(jpe?g|jpe|gif|png)\b/i', $file, $matches );

		if ( ! $matches ) {
			return new WP_Error( 'image_sideload_failed', __( 'Invalid image URL.' ) );
		}

		$file_array         = array();
		$file_array['name'] = wp_basename( $matches[0] );

		// Download file to temp location.
		$file_array['tmp_name'] = download_url( $file );

		// If error storing temporarily, return the error.
		if ( is_wp_error( $file_array['tmp_name'] ) ) {
			return $file_array['tmp_name'];
		}

		// Do the validation and storage stuff.
		$id = media_handle_sideload( $file_array, $post_id, $desc );

		// If error storing permanently, unlink.
		if ( is_wp_error( $id ) ) {
			@unlink( $file_array['tmp_name'] );
			return $id;
		}

		// Store the original attachment source in meta.
		add_post_meta( $id, '_source_url', $file );

		// If attachment ID was requested, return it.
		if ( 'id' === $return ) {
			return $id;
		}

		$src = wp_get_attachment_url( $id );
	}

	// Finally, check to make sure the file has been saved, then return the HTML.
	if ( ! empty( $src ) ) {
		if ( 'src' === $return ) {
			return $src;
		}

		$alt  = isset( $desc ) ? esc_attr( $desc ) : '';
		$html = "<img src='$src' alt='$alt' />";

		return $html;
	} else {
		return new WP_Error( 'image_sideload_failed' );
	}
}

Related Functions

From tag: upload download (file system)

No comments
    Log In . Register