Changeset 13088

Timestamp:

08/22/2021 11:42:56 PM (3 years ago)

Author:

espellcaste

Message:

Update the @return PHPDoc field for the bp_xprofile_get_meta function.

Props imath

Fixes #7606

File:

• trunk/src/bp-xprofile/bp-xprofile-functions.php (modified) (1 diff)

trunk/src/bp-xprofile/bp-xprofile-functions.php

@@ -984 +984 @@
  *                            specified meta_key. This parameter has no effect if meta_key is not
  *                            specified. Default: true.
- * @return mixed Meta value if found. False on failure.
+ * @return mixed An array of values if `$single` is false.
+ *               The value of the meta field if `$single` is true.
+ *               False for an invalid `$object_type` (one of `group`, `field`, `data`).
+ *               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.
  */
 function bp_xprofile_get_meta( $object_id, $object_type, $meta_key = '', $single = true ) {