Clarify inline documentation for the return in `get_attached_file()`.

Fixes #25409.

Built from https://develop.svn.wordpress.org/trunk@25609


git-svn-id: http://core.svn.wordpress.org/trunk@25526 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2013-09-24 21:29:08 +00:00
parent 9d5c2eb55f
commit 38b7b3a1c5
1 changed files with 1 additions and 2 deletions

View File

@ -177,11 +177,10 @@ add_action( 'init', 'create_initial_post_types', 0 ); // highest priority
* attached filename through a filter.
*
* @since 2.0.0
* @uses apply_filters() Calls 'get_attached_file' on file path and attachment ID.
*
* @param int $attachment_id Attachment ID.
* @param bool $unfiltered Whether to apply filters.
* @return string|bool The file path to the attached file, or false if the attachment does not exist.
* @return string|bool The file path to where the attached file should be, false otherwise.
*/
function get_attached_file( $attachment_id, $unfiltered = false ) {
$file = get_post_meta( $attachment_id, '_wp_attached_file', true );