update_attached_file() – Update attachment file path based on attachment ID.

You appear to be a bot. Output may be restricted

Description

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

Usage

$bool = update_attached_file( $attachment_id, $file );

Parameters

$attachment_id
( int ) required – Attachment ID.
$file
( string ) required – File path for the attachment.

Returns

bool True on success, false on failure.

Source

File name: wordpress/wp-includes/post.php
Lines:

1 to 22 of 22
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 on GitHub View on Trac