Changeset 48214 for trunk/src/wp-includes/meta.php

Timestamp:

06/29/2020 09:20:11 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve documentation for the $prev_value parameter and return result of various metadata update functions.

Props stevenlinx.
Fixes #50502. See #49572.

File:

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

trunk/src/wp-includes/meta.php

@@ -149 +149 @@
  * @param string $meta_key   Metadata key.
  * @param mixed  $meta_value Metadata value. Must be serializable if non-scalar.
- * @param mixed  $prev_value Optional. If specified, only update existing metadata entries
- *                           with this value. Otherwise, update all entries. Default empty.
- * @return int|bool The new meta field ID if a field with the given key didn't exist and was
- *                  therefore added, true on successful update, false on failure.
+ * @param mixed  $prev_value Optional. Previous value to check before updating.
+ *                           If specified, only update existing metadata entries with
+ *                           this value. Otherwise, update all entries. Default empty.
+ * @return int|bool The new meta field ID if a field with the given key didn't exist
+ *                  and was therefore added, true on successful update,
+ *                  false on failure or if the value passed to the function
+ *                  is the same as the one that is already in the database.
+
  */
 function update_metadata( $meta_type, $object_id, $meta_key, $meta_value, $prev_value = '' ) {
@@ -196 +200 @@
      * @param string    $meta_key   Metadata key.
      * @param mixed     $meta_value Metadata value. Must be serializable if non-scalar.
-     * @param mixed     $prev_value Optional. If specified, only update existing metadata entries
-     *                              with this value. Otherwise, update all entries.
+     * @param mixed     $prev_value Optional. Previous value to check before updating.
+     *                              If specified, only update existing metadata entries with
+     *                              this value. Otherwise, update all entries.
      */
     $check = apply_filters( "update_{$meta_type}_metadata", null, $object_id, $meta_key, $meta_value, $prev_value );