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



get_attached_file › WordPress Function

Since2.0.0
Deprecatedn/a
› get_attached_file ( $attachment_id, $unfiltered = false )
Parameters: (2)
  • (int) $attachment_id Attachment ID.
    Required: Yes
  • (bool) $unfiltered Optional. Whether to skip the {@see 'get_attached_file'} filter. Default false.
    Required: No
    Default: false
Returns:
  • (string|false) The file path to where the attached file should be, false otherwise.
Defined at:
Codex:

Retrieves attached file path based on attachment ID.

By default the path will go through the {@see 'get_attached_file'} filter, but passing true to the $unfiltered argument will return the file path unfiltered. The function works by retrieving the _wp_attached_file post meta value. This is a convenience function to prevent looking up the meta name and provide a mechanism for sending the attached filename through a filter.


Related Functions: update_attached_file, get_attached_media, get_the_title, get_attachment_link, get_attachment_icon

Source 

function get_attached_file( $attachment_id, $unfiltered = false ) {
	$file = get_post_meta( $attachment_id, '_wp_attached_file', true );

	// If the file is relative, prepend upload dir.
	if ( $file && ! str_starts_with( $file, '/' ) && ! preg_match( '|^.:\\\|', $file ) ) {
		$uploads = wp_get_upload_dir();
		if ( false === $uploads['error'] ) {
			$file = $uploads['basedir'] . "/$file";
		}
	}

	if ( $unfiltered ) {
		return $file;
	}

	/**
	 * Filters the attached file based on the given ID.
	 *
	 * @since 2.1.0
	 *
	 * @param string|false $file          The file path to where the attached file should be, false otherwise.
	 * @param int          $attachment_id Attachment ID.
	 */
	return apply_filters( 'get_attached_file', $file, $attachment_id );
}