From d762d720cc746a0c3e07833115288479948df4e7 Mon Sep 17 00:00:00 2001 From: David Baumwald Date: Thu, 11 Nov 2021 18:30:27 +0000 Subject: [PATCH] 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. git-svn-id: https://develop.svn.wordpress.org/trunk@52140 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/meta.php | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/src/wp-includes/meta.php b/src/wp-includes/meta.php index 310b10f933..ed53cf579b 100644 --- a/src/wp-includes/meta.php +++ b/src/wp-includes/meta.php @@ -110,7 +110,7 @@ function add_metadata( $meta_type, $object_id, $meta_key, $meta_value, $unique = * * @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 ); @@ -149,7 +149,7 @@ function add_metadata( $meta_type, $object_id, $meta_key, $meta_value, $unique = * @param int $mid The meta ID after successful update. * @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 ); @@ -283,7 +283,7 @@ function update_metadata( $meta_type, $object_id, $meta_key, $meta_value, $prev_ * @param int $meta_id ID of the metadata entry to update. * @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 ); @@ -329,7 +329,7 @@ function update_metadata( $meta_type, $object_id, $meta_key, $meta_value, $prev_ * @param int $meta_id ID of updated metadata entry. * @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 ); @@ -471,7 +471,7 @@ function delete_metadata( $meta_type, $object_id, $meta_key, $meta_value = '', $ * @param string[] $meta_ids An array of metadata entry IDs to delete. * @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 ); @@ -521,7 +521,7 @@ function delete_metadata( $meta_type, $object_id, $meta_key, $meta_value = '', $ * @param string[] $meta_ids An array of metadata entry IDs to delete. * @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 );