Changeset 52140

Timestamp:

11/11/2021 06:30:27 PM (5 years ago)

Author:

davidbaumwald

Message:

Options, Meta APIs: Correct docs for $_meta_value parameter in xxx_{$meta_type}_meta hooks.

In add_{$meta_type}_meta, added_{$meta_type}_meta, update_{$meta_type}_meta, updated_{$meta_type}_meta, delete_{$meta_type}_meta, and deleted_{$meta_type}_meta hooks, the $_meta_value parameter was documented as "Serialized if non-scalar". However, $_meta_value is a copy of the raw meta value before maybe_serialize is run and is not serialized. This change updates each of the above hooks' docblocks to remove "Serialized if non-scalar" from the $_meta_value parameter description.

Props pputzer, hasanuzzamanshamim.
Fixes #53102.

File:

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

trunk/src/wp-includes/meta.php

@@ -111 +111 @@
          * @param int    $object_id   ID of the object metadata is for.
          * @param string $meta_key    Metadata key.
-         * @param mixed  $_meta_value Metadata value. Serialized if non-scalar.
+         * @param mixed  $_meta_value Metadata value.
          */
         do_action( "add_{$meta_type}_meta", $object_id, $meta_key, $_meta_value );
@@ -150 +150 @@
          * @param int    $object_id   ID of the object metadata is for.
          * @param string $meta_key    Metadata key.
-         * @param mixed  $_meta_value Metadata value. Serialized if non-scalar.
+         * @param mixed  $_meta_value Metadata value.
          */
         do_action( "added_{$meta_type}_meta", $mid, $object_id, $meta_key, $_meta_value );
@@ -284 +284 @@
                  * @param int    $object_id   ID of the object metadata is for.
                  * @param string $meta_key    Metadata key.
-                 * @param mixed  $_meta_value Metadata value. Serialized if non-scalar.
+                 * @param mixed  $_meta_value Metadata value.
                  */
                 do_action( "update_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $_meta_value );
@@ -330 +330 @@
                  * @param int    $object_id   ID of the object metadata is for.
                  * @param string $meta_key    Metadata key.
-                 * @param mixed  $_meta_value Metadata value. Serialized if non-scalar.
+                 * @param mixed  $_meta_value Metadata value.
                  */
                 do_action( "updated_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $_meta_value );
@@ -472 +472 @@
          * @param int      $object_id   ID of the object metadata is for.
          * @param string   $meta_key    Metadata key.
-         * @param mixed    $_meta_value Metadata value. Serialized if non-scalar.
+         * @param mixed    $_meta_value Metadata value.
          */
         do_action( "delete_{$meta_type}_meta", $meta_ids, $object_id, $meta_key, $_meta_value );
@@ -522 +522 @@
          * @param int      $object_id   ID of the object metadata is for.
          * @param string   $meta_key    Metadata key.
-         * @param mixed    $_meta_value Metadata value. Serialized if non-scalar.
+         * @param mixed    $_meta_value Metadata value.
          */
         do_action( "deleted_{$meta_type}_meta", $meta_ids, $object_id, $meta_key, $_meta_value );