wp_insert_attachment( string|array $args, string|false $file = false, int $parent_post_id = 0, bool $wp_error = false, bool $fire_after_hooks = true ): int|WP_Error

Description

Parameters

$argsstring|array

Arguments for inserting an attachment.

$filestring|falseoptional

Filename. Default false.Default: false

$parent_post_idintoptional

Parent post ID or 0 for no parent. Default 0.Default: 0

$wp_errorbooloptional

Whether to return a WP_Error on failure. Default false.Default: false

$fire_after_hooksbooloptional

Whether to fire the after insert hooks. Default true.Default: true

Return

int|WP_Error

The attachment ID on success. The value 0 or WP_Error on failure.

Uses · 2

• wp_parse_args()Merges user defined arguments into defaults array.
• wp_insert_post()Inserts or update a post.

Used by · 14

• Custom_Background::handle_upload()Handles an Image upload for the background image.
• Custom_Image_Header::insert_attachment()Inserts an attachment and its metadata.
• Custom_Image_Header::step_2_manage_upload()Uploads the file to be cropped in the second step.
• File_Upload_Upgrader::__construct()Construct the upgrader for a form.
• WP_REST_Attachments_Controller::edit_media_item()Applies edits to a media item and creates a new attachment record.
• WP_REST_Attachments_Controller::insert_attachment()Inserts the attachment post in the database. Does not update the attachment meta.
• WP_Site_Icon::insert_attachment()Inserts an attachment.
• media_handle_sideload()Handles a side-loaded file in the same way as an uploaded file is handled by media_handle_upload().
• media_handle_upload()Saves a file submitted from a POST request and create an attachment post for it.
• wp_ajax_crop_image()Handles cropping an image via AJAX.
• wp_generate_attachment_metadata()Generates attachment meta data and create image sub-sizes for images.
• wp_import_handle_upload()Handles importer uploading and adds attachment.

Source

View on Trac ↗View on GitHub ↗

6513function wp_insert_attachment( $args, $file = false, $parent_post_id = 0, $wp_error = false, $fire_after_hooks = true ) {6514	$defaults = array(6515		'file'        => $file,6516		'post_parent' => 0,6517	);6518 6519	$data = wp_parse_args( $args, $defaults );6520 6521	if ( ! empty( $parent_post_id ) ) {6522		$data['post_parent'] = $parent_post_id;6523	}6524 6525	$data['post_type'] = 'attachment';6526 6527	return wp_insert_post( $data, $wp_error, $fire_after_hooks );6528}

History

Introduced in 2.0.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/post.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.