Changeset 47610 for trunk/src/wp-includes/taxonomy.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/taxonomy.php (modified) (2 diffs)

trunk/src/wp-includes/taxonomy.php

@@ -1247 +1247 @@
  * @param int    $term_id Term ID.
  * @param string $key     Optional. The meta key to retrieve. If no key is provided, fetches all metadata for the term.
- * @param bool   $single  Whether to return a single value. If false, an array of all values matching the
- *                        `$term_id`/`$key` pair will be returned. Default: false.
+ * @param bool   $single  Optional. Whether to return a single value. If false, an array of all values matching the
+ *                        `$term_id`/`$key` pair will be returned. Default false.
  * @return mixed If `$single` is false, an array of metadata values. If `$single` is true, a single metadata value.
  */
@@ -1267 +1267 @@
  * @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|WP_Error|bool Meta ID if the key didn't previously exist. True on successful update.
  *                           WP_Error when term_id is ambiguous between taxonomies. False on failure.