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

wp_insert_attachment() WP 2.0

Добавляет медиафайл (вложение) в медиатеку WordPress. Файл физически не добавляется — функция создает запись в таблице wp_posts в базе данных и возвращает ID созданной записи.

Ищем WP-разработчика! Фулл-тайм, удаленка, хорошая зарплата, соц. пакет. Подробности.
Компания Boosta.

Эта функция - одна из функций API низкого уровня, которая используется в WordPress для вставки вложений.

Функцию нужно использовать в связке с функциями: wp_generate_attachment_metadata() и wp_update_attachment_metadata().

Чтобы физически загрузить файл и создать запись этого файла в БД разом, обычно используется функция media_handle_upload().

Работает на основе: wp_insert_post()

Хуков нет.

Возвращает

int|WP_Error. ID записи в случае успешного добавления и 0 при неудаче. WP_Error объект при неудаче, если указан параметр $wp_error (с версии 4.7).

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

wp_insert_attachment( $attachment, $filename, $parent_post_id, $wp_error, $fire_after_hooks );
$attachment(массив) (обязательный)

Массив данных о добавляемом вложении, который будет записан в БД в таблицу wp_posts. Обязательно должен содержать минимум эти данные: post_title, post_content (в значении указывается пустая строка), post_status, guid и post_mime_type:

$attachment = array(
	'guid'           => $wp_upload_dir['url'] . '/' . basename( $filename ), 
	'post_mime_type' => $filetype['type'],
	'post_title'     => preg_replace( '/\.[^.]+$/', '', basename( $filename ) ),
	'post_content'   => '',
	'post_status'    => 'inherit'
);
$filename(строка)
Расположение файла на сервере. Используйте абсолютный путь, а не УРЛ. Путь должен указывать на директорию загрузок WordPress - uploads. Смотрите wp_upload_dir().
По умолчанию: false
$parent_post_id(число)
ID поста (записи) к которому должен относиться добавляемый медиафайл. Здесь указываем ID поста-родителя.
По умолчанию: 0
$wp_error(логический) (WP 4.7)
Ставим true, если в случае ошибки нужно вернуть объект WP_Error.
По умолчанию: false
$fire_after_hooks(логический) (WP 5.6)
Нужно ли запускать функцию wp_after_insert_post(), которая запускает хуки в конце работы функции.
По умолчанию: true

Примеры

#1 Добавим записи о файле в базу данных WP

Предполагается, что физически файл уже загружен в директорию uploads и теперь нам нужно добавить запись об этом файле в базу данных WordPress. Также, прикрепим запись к посту 37:

// файл должен находиться в директории загрузок WP.
$filename = '/path/to/uploads/2013/03/filname.jpg';

// ID поста, к которому прикрепим вложение.
$parent_post_id = 37;

// Проверим тип поста, который мы будем использовать в поле 'post_mime_type'.
$filetype = wp_check_filetype( basename( $filename ), null );

// Получим путь до директории загрузок.
$wp_upload_dir = wp_upload_dir();

// Подготовим массив с необходимыми данными для вложения.
$attachment = array(
	'guid'           => $wp_upload_dir['url'] . '/' . basename( $filename ), 
	'post_mime_type' => $filetype['type'],
	'post_title'     => preg_replace( '/\.[^.]+$/', '', basename( $filename ) ),
	'post_content'   => '',
	'post_status'    => 'inherit'
);

// Вставляем запись в базу данных.
$attach_id = wp_insert_attachment( $attachment, $filename, $parent_post_id );

// Подключим нужный файл, если он еще не подключен
// wp_generate_attachment_metadata() зависит от этого файла.
require_once( ABSPATH . 'wp-admin/includes/image.php' );

// Создадим метаданные для вложения и обновим запись в базе данных.
$attach_data = wp_generate_attachment_metadata( $attach_id, $filename );
wp_update_attachment_metadata( $attach_id, $attach_data );

Заметки

Использование _wp_relative_upload_path(), чтобы создать guid может быть невозможно на некоторых серверах.

Заметки

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

С версии 2.0.0 Введена.
С версии 4.7.0 Added the $wp_error parameter to allow a WP_Error to be returned on failure.
С версии 5.6.0 Added the $fire_after_hooks parameter.

Код wp_insert_attachment() WP 5.8.2

function wp_insert_attachment( $args, $file = false, $parent = 0, $wp_error = false, $fire_after_hooks = true ) {
	$defaults = array(
		'file'        => $file,
		'post_parent' => 0,
	);

	$data = wp_parse_args( $args, $defaults );

	if ( ! empty( $parent ) ) {
		$data['post_parent'] = $parent;
	}

	$data['post_type'] = 'attachment';

	return wp_insert_post( $data, $wp_error, $fire_after_hooks );
}

wp_insert (вставка в БД)

Вложения (media файлы)

17 комментов
Полезные 2 Вопросы 1 Все
    Войти