Codex

Function Reference/get attached file

Contents

Description

Retrieve attached file path based on attachment ID.

You can optionally send it through the 'get_attached_file' filter, but by default it will just 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 file name through a filter.

Usage

<?php get_attached_file( $attachment_id, $unfiltered ); ?>

Parameters

$attachment_id
(integer) (required) Attachment ID.
Default: None
$unfiltered
(boolean) (optional) Whether to apply filters or not.
Default: false

Return Values

(string) 
The file path to the attached file.

Examples

Notes

  • Uses: apply_filters() to call get_attached_file() on file path and $attachment_id.
  • Uses: get_post_meta() on $attachment_id, the '_wp_attached_file' meta name.

Change Log

Since: 2.0.0

Source File

get_attached_file() is located in wp-includes/post.php.

Related

Retrieved from "http://codex.wordpress.org/Function_Reference/get_attached_file"

Codex Resources