Codex

Function Reference/wp insert attachment

Contents

Description

This function inserts an attachment into the media library. The function should be used in conjunction with wp_update_attachment_metadata() and wp_generate_attachment_metadata(). Returns the ID of the entry created in the wp_posts table.

Usage

 <?php wp_insert_attachment$attachment$filename$parent_post_id ); ?> 

Example

To insert an attachment to a parent with a post ID of 37:

<?php
  $attach_id = wp_insert_attachment( $attachment, $filename, 37 );
  $attach_data = wp_generate_attachment_metadata( $attach_id, $filename );
  wp_update_attachment_metadata( $attach_id,  $attach_data );
?>

Parameters

$attachment
(array) (required) Array of data about the attachment that will be written into the wp_posts table of the database. Must contain at a minimum the keys post_title, post_content (the value for this key should be the empty string), post_status and post_mime_type.
Default: None
$filename
(string) (optional) Location of the file on the server. Use absolute path and not the URI of the file. The file MUST be on the uploads directory. See wp_upload_dir()
Default: false
$parent_post_id
(int) (optional) Attachments are associated with parent posts. This is the ID of the parent's post ID.
Default: 0

Related

wp_get_attachment_url(), wp_delete_attachment(), wp_insert_post()

This article is marked as in need of editing. You can help Codex by editing it.