WordPress как на ладони
Недорогой хостинг для сайтов на WordPress: wordpress.jino.ru

media_sideload_image() WP 2.6.0

Загружает картинку в медиатеку WP из указанного УРЛ и прикрепляет её к посту.

Другими словами, функция загружает изображение с внешнего URL в медиатеку WP, прикрепляет его к указанной записи и возвращает <img> или УРЛ загруженной картинки.

Для работы функции во Фронт-энде нужны файлы:

require_once ABSPATH . 'wp-admin/includes/media.php';
require_once ABSPATH . 'wp-admin/includes/file.php';
require_once ABSPATH . 'wp-admin/includes/image.php';

Если нужно загрузить любой тип файла (а не только картинку), используйте аналогичную функцию: media_handle_sideload().

Работает на основе: media_handle_sideload(), download_url()

Хуков нет.

Возвращает

Строка/WP_Error.

  • HTML img тега. В параметре $return можно указать чтобы вернулся не HTML код, а: src или id картинки.
  • WP_Error объект, с сообщением ошибке.

Использование

media_sideload_image( $file, $post_id, $desc, $return );
$file(строка) (обязательный)
УРЛ картинки которую нужно загрузить.
$post_id(число) (обязательный)
ID записи с которой будет связан загруженный в медиатеку файл-картинка. 0 — не прикреплять.
$desc(строка)
Заголовок картинки. Если не указать, заголовок будет взят из URL или из метаданных картинки.
По умолчанию: null
$return(строка)

Что возвращать. Может быть:

  • html - IMG тег картинки
  • src - просто URL
  • id - ID вложения. С WP 4.8

По умолчанию: 'html'

Примеры

#1 Загрузим файл для поста из внешнего УРЛ

// когда мы во фронте
require_once ABSPATH . 'wp-admin/includes/media.php';
require_once ABSPATH . 'wp-admin/includes/file.php';
require_once ABSPATH . 'wp-admin/includes/image.php';

$url = 'http://s.w.org/style/images/wp-header-logo.png';
$post_id = 3061;
$desc = "Логотип WordPress";

$img_tag = media_sideload_image( $url, $post_id, $desc );

if( is_wp_error($img_tag) ){
	echo $img_tag->get_error_message();
}
else {
	// добавлено 
}

Такой же пример, но в другом исполнении показан в описании функции media_handle_sideload() - пример 1.

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

С версии 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.

Код 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' );
	}
}

Cвязанные функции

Из метки: upload download (файловая система file загрузка)

Еще из раздела: Загрузка (download upload)

13 комментов
Полезные 4 Вопросы 1 Все