Changeset 49963 for trunk/src/wp-includes/post.php

Timestamp:

01/15/2021 08:06:50 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Docs: In various @return tags, list the expected type first, instead of false.

Follow-up to [46696], [47060], [49926], [49927], [49929].

See #51800.

File:

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

trunk/src/wp-includes/post.php

@@ -6224 +6224 @@
  *
  * @param int $post_id Optional. Attachment ID. Default is the ID of the global `$post`.
- * @return string|false False on failure. Attachment caption on success.
+ * @return string|false Attachment caption on success, false on failure. 
  */
 function wp_get_attachment_caption( $post_id = 0 ) {
@@ -6257 +6257 @@
  *
  * @param int $post_id Optional. Attachment ID. Default 0.
- * @return string|false False on failure. Thumbnail file path on success.
+ * @return string|false Thumbnail file path on success, false on failure.
  */
 function wp_get_attachment_thumb_file( $post_id = 0 ) {
@@ -6297 +6297 @@
  *
  * @param int $post_id Optional. Attachment ID. Default 0.
- * @return string|false False on failure. Thumbnail URL on success.
+ * @return string|false Thumbnail URL on success, false on failure.
  */
 function wp_get_attachment_thumb_url( $post_id = 0 ) {