wp_insert_attachment( string|array $args, string $file = false, int $parent, bool $wp_error = false )

Insert an attachment.

Contents

Description Description

If you set the ‘ID’ in the $args parameter, it will mean that you are updating and attempt to update the attachment. You can also set the attachment name or title by setting the key ‘post_name’ or ‘post_title’.

You can set the dates for the attachment manually by setting the ‘post_date’ and ‘post_date_gmt’ keys’ values.

By default, the comments will use the default settings for whether the comments are allowed. You can close them manually or keep them open by setting the value for the ‘comment_status’ key.

See also See also

Top ↑

Parameters Parameters

$args

(string|array) (Required) Arguments for inserting an attachment.

$file

(string) (Optional) Filename.

Default value: false

$parent

(int) (Optional) Parent post ID.

$wp_error

(bool) (Optional) Whether to return a WP_Error on failure.

Default value: false

Top ↑

Return Return

(int|WP_Error) The attachment ID on success. The value 0 or WP_Error on failure.

Top ↑

Source Source

File: wp-includes/post.php 

function wp_insert_attachment( $args, $file = false, $parent = 0, $wp_error = false ) {
	$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 );
}

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version Description
4.7.0 Added the $wp_error parameter to allow a WP_Error to be returned on failure.
2.0.0 Introduced.

Top ↑

Top ↑

Used By Used By

Used By
Used By Description
wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php: WP_REST_Attachments_Controller::insert_attachment()

Inserts the attachment post in the database. Does not update the attachment meta.
wp-admin/includes/class-wp-site-icon.php: WP_Site_Icon::insert_attachment()

Inserts an attachment.
wp-admin/includes/ajax-actions.php: wp_ajax_crop_image()

Ajax handler for cropping an image.
wp-admin/includes/class-file-upload-upgrader.php: File_Upload_Upgrader::__construct()

Construct the upgrader for a form.
wp-admin/includes/image.php: wp_generate_attachment_metadata()

Generate attachment meta data and create image sub-sizes for images.
wp-admin/includes/media.php: media_handle_upload()

Save a file submitted from a POST request and create an attachment post for it.
wp-admin/includes/media.php: media_handle_sideload()

Handles a side-loaded file in the same way as an uploaded file is handled by media_handle_upload().
wp-admin/includes/import.php: wp_import_handle_upload()

Handle importer uploading and add attachment.
wp-admin/includes/class-custom-image-header.php: Custom_Image_Header::insert_attachment()

Insert an attachment and its metadata.
wp-admin/includes/class-custom-image-header.php: Custom_Image_Header::step_2_manage_upload()

Upload the file to be cropped in the second step.
wp-admin/includes/class-custom-background.php: Custom_Background::handle_upload()

Handle an Image upload for the background image.
wp-includes/post.php: wp_update_post()

Update a post with new post data.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::mw_newMediaObject()

Uploads a file, following your settings.
Show 8 more used by Hide more used by

Top ↑

User Contributed Notes User Contributed Notes

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

    Example
    Inserts an attachment to a parent with a post ID of 37:

    <?php 
// $filename should be the path to a file in the upload directory.
$filename = '/path/to/uploads/2013/03/filename.jpg';

// The ID of the post this attachment is for.
$parent_post_id = 37;

// Check the type of file. We'll use this as the 'post_mime_type'.
$filetype = wp_check_filetype( basename( $filename ), null );

// Get the path to the upload directory.
$wp_upload_dir = wp_upload_dir();

// Prepare an array of post data for the attachment.
$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'
);

// Insert the attachment.
$attach_id = wp_insert_attachment( $attachment, $filename, $parent_post_id );

// Make sure that this file is included, as wp_generate_attachment_metadata() depends on it.
require_once( ABSPATH . 'wp-admin/includes/image.php' );

// Generate the metadata for the attachment, and update the database record.
$attach_data = wp_generate_attachment_metadata( $attach_id, $filename );
wp_update_attachment_metadata( $attach_id, $attach_data );

set_post_thumbnail( $parent_post_id, $attach_id );
?>

    Expand full source codeCollapse full source code

You must log in before being able to contribute a note or feedback.