wpseek.com
A WordPress-centric search engine for devs and theme authors



update_attached_file › WordPress Function

Since2.1.0
Deprecatedn/a
› update_attached_file ( $attachment_id, $file )
Parameters: (2)
  • (int) $attachment_id Attachment ID.
    Required: Yes
  • (string) $file File path for the attachment.
    Required: Yes
Returns:
  • (int|bool) Meta ID if the `_wp_attached_file` key didn't exist for the attachment. True on successful update, false on failure or if the `$file` value passed to the function is the same as the one that is already in the database.
Defined at:
Codex:

Updates attachment file path based on attachment ID.

Used to update the file path of the attachment, which uses post meta name _wp_attached_file to store the path of the attachment.


Related Functions: get_attached_file, wp_delete_attachment_files, update_archived, update_post_cache, update_meta_cache

Source 

function update_attached_file( $attachment_id, $file ) {
	if ( ! get_post( $attachment_id ) ) {
		return false;
	}

	/**
	 * Filters the path to the attached file to update.
	 *
	 * @since 2.1.0
	 *
	 * @param string $file          Path to the attached file to update.
	 * @param int    $attachment_id Attachment ID.
	 */
	$file = apply_filters( 'update_attached_file', $file, $attachment_id );

	$file = _wp_relative_upload_path( $file );
	if ( $file ) {
		return update_post_meta( $attachment_id, '_wp_attached_file', $file );
	} else {
		return delete_post_meta( $attachment_id, '_wp_attached_file' );
	}
}