Question

media_sideload_image( string $file,  int $post_id,  string $desc = null,  string $return = 'html' )

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

---

description

---

参数

$file

(string) (Required) The URL of the image to download.

$post_id

(int) (Required) The post ID the media is to be associated with.

$desc

(string) (Optional) description of the image.

Default value: null

$return

(string) (Optional) Accepts 'html' (image tag html) or 'src' (URL), or 'id' (attachment ID).

Default value: 'html'

---

返回值

(string|WP_Error) Populated HTML img tag on success, WP_Error object otherwise.

---

源代码

File: wp-admin/includes/media.php

function media_sideload_image( $file, $post_id, $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'] = 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;
		// If attachment id was requested, return it early.
		} elseif ( $return === 'id' ) {
			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 ( $return === 'src' ) {
			return $src;
		}

		$alt = isset( $desc ) ? esc_attr( $desc ) : '';
		$html = "<img src='$src' alt='$alt' />";
		return $html;
	} else {
		return new WP_Error( 'image_sideload_failed' );
	}
}

---

更新日志

Version	description
4.8.0	Introduced the 'id' option within the $return parameter.
4.2.0	Introduced the $return parameter.
2.6.0	Introduced.

---

相关函数

Uses

• wp-admin/includes/media.php: media_handle_sideload()
• wp-admin/includes/file.php: download_url()
• wp-includes/l10n.php: __()
• wp-includes/formatting.php: esc_attr()
• wp-includes/post.php: wp_get_attachment_url()
• wp-includes/load.php: is_wp_error()
• wp-includes/class-wp-error.php: WP_Error::__construct()
Show 2 more uses Hide more uses

---

Used By

• wp-admin/includes/class-wp-press-this.php: WP_Press_This::side_load_images()

---

User Contributed Notes

1. Skip to note content You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note Contributed by Codex

   Default Usage

   
   $url     = "https://wordpress.org/about/images/logos/wordpress-logo-stacked-rgb.png";
   $post_id = 1;
   $desc    = "The WordPress Logo";
   
   $image = media_sideload_image( $url, $post_id, $desc );