Changeset 48658

Timestamp:

07/28/2020 10:13:50 AM (4 years ago)

Author:

SergeyBiryukov

Message:

Docs: Document that various metadata functions return false for an invalid ID.

Props salcode.
See #40519.

Location:

trunk/src/wp-includes

Files:

• comment.php (modified) (1 diff)
• ms-site.php (modified) (1 diff)
• post.php (modified) (1 diff)
• taxonomy.php (modified) (1 diff)
• user.php (modified) (1 diff)

trunk/src/wp-includes/comment.php

@@ -497 +497 @@
  *                           Default false.
  * @return mixed An array if $single is false. The value of meta data field
- *               if $single is true.
+ *               if $single is true. False for an invalid $comment_id.
  */
 function get_comment_meta( $comment_id, $key = '', $single = false ) {

trunk/src/wp-includes/ms-site.php

@@ -1088 +1088 @@
  *                        Default false.
  * @return mixed An array if $single is false. The value of meta data field
- *               if $single is true.
+ *               if $single is true. False for an invalid $site_id.
  */
 function get_site_meta( $site_id, $key = '', $single = false ) {

trunk/src/wp-includes/post.php

@@ -2121 +2121 @@
  *                        Default false.
  * @return mixed An array if $single is false. The value of the meta field
- *               if $single is true.
+ *               if $single is true. False for an invalid $post_id.
  */
 function get_post_meta( $post_id, $key = '', $single = false ) {

trunk/src/wp-includes/taxonomy.php

@@ -1293 +1293 @@
  *                        Default false.
  * @return mixed An array if $single is false. The value of the meta field
- *               if $single is true.
+ *               if $single is true. False for an invalid $term_id.
  */
 function get_term_meta( $term_id, $key = '', $single = false ) {

trunk/src/wp-includes/user.php

@@ -832 +832 @@
  *                        Default false.
  * @return mixed An array if $single is false. The value of meta data field
- *               if $single is true.
+ *               if $single is true. False for an invalid $user_id.
  */
 function get_user_meta( $user_id, $key = '', $single = false ) {