Changeset 47610 for trunk/src/wp-includes/user.php

Timestamp:

04/22/2020 09:38:12 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Document the default value of $single and $prev_value parameters in various metadata functions.

Props denisco.
See #49572.

File:

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

trunk/src/wp-includes/user.php

@@ -822 +822 @@
  * @param int    $user_id User ID.
  * @param string $key     Optional. The meta key to retrieve. By default, returns data for all keys.
- * @param bool   $single  Whether to return a single value.
+ * @param bool   $single  Optional. Whether to return a single value. Default false.
  * @return mixed Will be an array if $single is false. Will be value of meta data field if $single is true.
  */
@@ -843 +843 @@
  * @param string $meta_key   Metadata key.
  * @param mixed  $meta_value Metadata value.
- * @param mixed  $prev_value Optional. Previous value to check before removing.
+ * @param mixed  $prev_value Optional. Previous value to check before updating. Default empty.
  * @return int|bool Meta ID if the key didn't exist, true on successful update, false on failure.
  */