Question

update_attached_file( int $attachment_id,  string $file )

Update 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.

---

参数

$attachment_id

(int) (Required) Attachment ID.

$file

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

---

返回值

(bool) True on success, false on failure.

---

源代码

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

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

---

更新日志

Version	description
2.1.0	Introduced.

---

相关函数

Uses

• wp-includes/plugin.php: apply_filters()
• wp-includes/post.php: update_post_meta()
• wp-includes/post.php: delete_post_meta()
• wp-includes/post.php: get_post()
• wp-includes/post.php: _wp_relative_upload_path()
• wp-includes/post.php: update_attached_file
Show 1 more use Hide more uses

---

Used By

• wp-admin/includes/image-edit.php: wp_restore_image()
• wp-admin/includes/image-edit.php: wp_save_image()
• wp-includes/post.php: wp_insert_post()

---

User Contributed Notes