update_attached_file( int $attachment_id, string $file )

Update attachment file path based on attachment ID.

Description 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 Parameters


(int) (Required) Attachment ID.


(string) (Required) File path for the attachment.

Top ↑

Return Return

(bool) True on success, false on failure.

Top ↑

Source Source

File: wp-includes/post.php

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

Top ↑

Changelog Changelog

Version Description
2.1.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

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