WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

update_attached_file()

update_attached_file( int $attachment_id, string $file ): int|bool

In this article

Back to top

Updates attachment file path based on attachment ID.

Description

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

Parameters

$attachment_idintrequired
Attachment ID.
$filestringrequired
File path for the attachment.

Return

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.

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' );	} }

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘update_attached_file’, string $file, int $attachment_id )

Filters the path to the attached file to update.

UsesDescription
update_post_meta()wp-includes/post.php

Updates a post meta field based on the given post ID.

delete_post_meta()wp-includes/post.php

Deletes a post meta field for the given post ID.

_wp_relative_upload_path()wp-includes/post.php

Returns relative path to an uploaded file.

apply_filters()wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.

get_post()wp-includes/post.php

Retrieves post data given a post ID or post object.

Show 2 moreShow less
Used byDescription
_wp_image_meta_replace_original()wp-admin/includes/image.php

Updates the attached file and image meta data when the original image was edited.

wp_restore_image()wp-admin/includes/image-edit.php

Restores the metadata for a given attachment.

wp_save_image()wp-admin/includes/image-edit.php

Saves image to post, along with enqueued changes in $_REQUEST['history'].

wp_insert_post()wp-includes/post.php

Inserts or update a post.

Changelog

VersionDescription
2.1.0Introduced.

User Contributed Notes

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