Changeset 58962

Timestamp:

09/01/2024 06:28:22 PM (12 days ago)

Author:

SergeyBiryukov

Message:

Docs: Further clarify return results for a non-existing ID in metadata functions.

This adds a note that the functions return either an empty array or an empty string for a valid but non-existing ID, depending on the $single parameter.

Follow-up to [48658], [50641].

Props rodrigosprimo, jrf.
See #61608.

Location:

trunk/src/wp-includes

Files:

• comment.php (modified) (1 diff)
• meta.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

@@ -480 +480 @@
  *               The value of meta data field if `$single` is true.
  *               False for an invalid `$comment_id` (non-numeric, zero, or negative value).
- *               An empty string if a valid but non-existing comment ID is passed.
+ *               An empty array if a valid but non-existing comment ID is passed and `$single` is false.
+ *               An empty string if a valid but non-existing comment ID is passed and `$single` is true.
  */
 function get_comment_meta( $comment_id, $key = '', $single = false ) {

trunk/src/wp-includes/meta.php

@@ -569 +569 @@
  *               False for an invalid `$object_id` (non-numeric, zero, or negative value),
  *               or if `$meta_type` is not specified.
- *               An empty string if a valid but non-existing object ID is passed.
+ *               An empty array if a valid but non-existing object ID is passed and `$single` is false.
+ *               An empty string if a valid but non-existing object ID is passed and `$single` is true.
  */
 function get_metadata( $meta_type, $object_id, $meta_key = '', $single = false ) {

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

@@ -1070 +1070 @@
  *               The value of meta data field if `$single` is true.
  *               False for an invalid `$site_id` (non-numeric, zero, or negative value).
- *               An empty string if a valid but non-existing site ID is passed.
+ *               An empty array if a valid but non-existing site ID is passed and `$single` is false.
+ *               An empty string if a valid but non-existing site ID is passed and `$single` is true.
  */
 function get_site_meta( $site_id, $key = '', $single = false ) {

trunk/src/wp-includes/post.php

@@ -2608 +2608 @@
  *               The value of the meta field if `$single` is true.
  *               False for an invalid `$post_id` (non-numeric, zero, or negative value).
- *               An empty string if a valid but non-existing post ID is passed.
+ *               An empty array if a valid but non-existing post ID is passed and `$single` is false.
+ *               An empty string if a valid but non-existing post ID is passed and `$single` is true.
  */
 function get_post_meta( $post_id, $key = '', $single = false ) {

trunk/src/wp-includes/taxonomy.php

@@ -1431 +1431 @@
  *               The value of the meta field if `$single` is true.
  *               False for an invalid `$term_id` (non-numeric, zero, or negative value).
- *               An empty string if a valid but non-existing term ID is passed.
+ *               An empty array if a valid but non-existing term ID is passed and `$single` is false.
+ *               An empty string if a valid but non-existing term ID is passed and `$single` is true.
  */
 function get_term_meta( $term_id, $key = '', $single = false ) {

trunk/src/wp-includes/user.php

@@ -1186 +1186 @@
  *               The value of meta data field if `$single` is true.
  *               False for an invalid `$user_id` (non-numeric, zero, or negative value).
- *               An empty string if a valid but non-existing user ID is passed.
+ *               An empty array if a valid but non-existing user ID is passed and `$single` is false.
+ *               An empty string if a valid but non-existing user ID is passed and `$single` is true.
  */
 function get_user_meta( $user_id, $key = '', $single = false ) {