W3cubDocs

/WordPress

get_attached_file( int $attachment_id, bool $unfiltered = false )

Retrieve attached file path based on attachment ID.

Description

By default the path will go through the ‘get_attached_file’ filter, but passing a true to the $unfiltered argument of get_attached_file() will return the file path unfiltered.

The function works by getting the single post meta name, named ‘_wp_attached_file’ and returning it. This is a convenience function to prevent looking up the meta name and provide a mechanism for sending the attached filename through a filter.

Parameters

$attachment_id

(int) (Required) Attachment ID.

$unfiltered

(bool) (Optional) Whether to apply filters.

Default value: false

Return

(string|false) The file path to where the attached file should be, false otherwise.

Source

File: wp-includes/post.php 

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 && 0 !== strpos( $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 );
}

Uses

Uses Description
wp-includes/functions.php: wp_get_upload_dir()

Retrieves uploads directory information.
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.
wp-includes/post.php: get_post_meta()

Retrieves a post meta field for the given post ID.
wp-includes/post.php: get_attached_file

Filters the attached file based on the given ID.

Used By

Used By Description
wp-includes/post.php: wp_get_original_image_path()

Retrieves the path to an uploaded image file.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::_validate_header_video()

Callback for validating the header_video value.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::import_theme_starter_content()

Import theme starter content into the customized state.
wp-admin/includes/class-wp-media-list-table.php: WP_Media_List_Table::column_title()

Handles the title column output.
wp-includes/post.php: wp_attachment_is()

Verifies an attachment is of a given type.
wp-admin/includes/class-file-upload-upgrader.php: File_Upload_Upgrader::__construct()

Construct the upgrader for a form.
wp-admin/includes/image-edit.php: wp_restore_image()

Restores the metadata for a given attachment.
wp-admin/includes/image-edit.php: wp_save_image()

Saves image to post, along with enqueued changes in $_REQUEST['history'].
wp-admin/includes/image.php: _copy_image_file()

Copy an existing image file.
wp-admin/includes/image.php: _load_image_to_edit_path()

Retrieve the path or url of an attachment’s attached file.
wp-admin/includes/image.php: wp_crop_image()

Crops an image to a given size.
wp-admin/includes/media.php: attachment_submitbox_metadata()

Displays non-editable attachment metadata in the publish meta box.
wp-admin/includes/media.php: get_media_item()

Retrieve HTML form for modifying the image attachment.
wp-admin/includes/class-custom-image-header.php: Custom_Image_Header::step_2()

Display second step of custom header image page.
wp-admin/includes/class-custom-image-header.php: Custom_Image_Header::step_3()

Display third step of custom header image page.
wp-includes/deprecated.php: wp_load_image()

Load an image from a string, if PHP supports it.
wp-includes/deprecated.php: get_attachment_icon_src()

Retrieve icon URL and Path.
wp-includes/post-template.php: wp_get_attachment_link()

Retrieve an attachment page link using an image or icon, if possible.
wp-includes/media.php: wp_maybe_generate_attachment_metadata()

Maybe attempts to generate attachment metadata, if missing.
wp-includes/media.php: wp_prepare_attachment_for_js()

Prepares an attachment post object for JS, where it is expected to be JSON-encoded and fit into an Attachment model.
wp-includes/media.php: get_attachment_taxonomies()

Retrieves taxonomies attached to given the attachment.
wp-includes/post.php: wp_mime_type_icon()

Retrieve the icon for a MIME type or attachment.
wp-includes/post.php: wp_delete_attachment()

Trash or delete an attachment.
wp-includes/post.php: wp_get_attachment_thumb_file()

Retrieve thumbnail for an attachment.

Changelog

Version Description
2.0.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_attached_file