Changeset 55202

Timestamp:

02/03/2023 12:45:24 AM (20 months ago)

Author:

SergeyBiryukov

Message:

Docs: Improve the DocBlock for get_attached_file().

Includes:

• Using 3-digit format for the @since tag.
• Minor wording updates and formatting corrections.

Follow-up to [3203], [4612], [6379], [8203], [24983], [29090], [55199].

See #51780, #56792.

File:

• trunk/src/wp-includes/post.php (modified) (2 diffs)

trunk/src/wp-includes/post.php

@@ -706 +706 @@
  * Retrieves attached file path based on attachment ID.
  *
- * Will return intermediate size path if $size param is provided.
- *
- * 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.
+ * Will return intermediate size path if the `$size` parameter is provided.
+ *
+ * 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.
  *
  * @since 2.0.0
- * @since 6.2 The `$size` parameter was added
+ * @since 6.2.0 The `$size` parameter was added.
  *
  * @param int          $attachment_id Attachment ID.
- * @param bool         $unfiltered    Optional. Whether to apply filters. Default false.
+ * @param bool         $unfiltered    Optional. Whether to skip the {@see 'get_attached_file'} filter.
+ *                                    Default false.
  * @param string|int[] $size          Optional. Image size. Accepts any registered image size name, or an array
- *                                    of width and height values in pixels (in that order). Default ''.
- *
+ *                                    of width and height values in pixels (in that order). Default empty string.
  * @return string|false The file path to where the attached file should be, false otherwise.
  */
 function get_attached_file( $attachment_id, $unfiltered = false, $size = '' ) {
 
-    // Check for intermediate sizes first, otherwise fallback to original attachment size
+    // Check for intermediate sizes first, otherwise fall back to the original attachment size.
     if ( ! empty( $size ) ) {
         $intermediate_image = image_get_intermediate_size( $attachment_id, $size );
@@ -735 +733 @@
             return false;
         }
+
         $file = $intermediate_image['path'];
     } else {