Changeset 25076

Timestamp:

08/21/2013 09:10:23 PM (11 years ago)

Author:

wonderboymusic

Message:

Improve inline docs for function params that can be serialized when non-scalar. Fixes #18488.

Location:

trunk/src/wp-includes

Files:

• meta.php (modified) (4 diffs)
• option.php (modified) (3 diffs)
• post.php (modified) (3 diffs)

trunk/src/wp-includes/meta.php

@@ -23 +23 @@
  * @param int $object_id ID of the object metadata is for
  * @param string $meta_key Metadata key
- * @param string $meta_value Metadata value
+ * @param mixed $meta_value Metadata value. Must be serializable if non-scalar.
  * @param bool $unique Optional, default is false. Whether the specified metadata key should be
  *      unique for the object. If true, and the object already has a value for the specified
@@ -94 +94 @@
  * @param int $object_id ID of the object metadata is for
  * @param string $meta_key Metadata key
- * @param string $meta_value Metadata value
- * @param string $prev_value Optional. If specified, only update existing metadata entries with
+ * @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
  *      the specified value. Otherwise, update all entries.
  * @return bool True on successful update, false on failure.
@@ -175 +175 @@
  * @param int $object_id ID of the object metadata is for
  * @param string $meta_key Metadata key
- * @param string $meta_value Optional. Metadata value. If specified, only delete metadata entries
+ * @param mixed $meta_value Optional. Metadata value. Must be serializable if non-scalar. If specified, only delete metadata entries
  *      with this value. Otherwise, delete all entries with the specified meta_key.
  * @param bool $delete_all Optional, default is false. If true, delete matching metadata entries
@@ -721 +721 @@
                 unset( $this->queries[$k] );
             }
-        }       
-        
+        }
+
         // Split out the meta_key only queries (we can only do this for OR)
         if ( 'OR' == $this->relation ) {

trunk/src/wp-includes/option.php

@@ -209 +209 @@
  *
  * @param string $option Option name. Expected to not be SQL-escaped.
- * @param mixed $newvalue Option value. Expected to not be SQL-escaped.
+ * @param mixed $newvalue Option value. Must be serializable if non-scalar. Expected to not be SQL-escaped.
  * @return bool False if value was not updated and true if value was updated.
  */
@@ -285 +285 @@
  *
  * @param string $option Name of option to add. Expected to not be SQL-escaped.
- * @param mixed $value Optional. Option value, can be anything. Expected to not be SQL-escaped.
+ * @param mixed $value Optional. Option value. Must be serializable if non-scalar. Expected to not be SQL-escaped.
  * @param mixed $deprecated Optional. Description. Not used anymore.
  * @param bool $autoload Optional. Default is enabled. Whether to load the option when WordPress starts up.
@@ -489 +489 @@
  *
  * @param string $transient Transient name. Expected to not be SQL-escaped.
- * @param mixed $value Transient value. Expected to not be SQL-escaped.
+ * @param mixed $value Transient value. Must be serializable if non-scalar. Expected to not be SQL-escaped.
  * @param int $expiration Time until expiration in seconds, default 0
  * @return bool False if value was not set and true if value was set.

trunk/src/wp-includes/post.php

@@ -1672 +1672 @@
  * @param int $post_id Post ID.
  * @param string $meta_key Metadata name.
- * @param mixed $meta_value Metadata value.
+ * @param mixed $meta_value Metadata value. Must be serializable if non-scalar.
  * @param bool $unique Optional, default is false. Whether the same key should not be added.
  * @return int|bool Meta ID on success, false on failure.
@@ -1696 +1696 @@
  * @param int $post_id post ID
  * @param string $meta_key Metadata name.
- * @param mixed $meta_value Optional. Metadata value.
+ * @param mixed $meta_value Optional. Metadata value. Must be serializable if non-scalar.
  * @return bool True on success, false on failure.
  */
@@ -1736 +1736 @@
  * @param int $post_id Post ID.
  * @param string $meta_key Metadata key.
- * @param mixed $meta_value Metadata value.
+ * @param mixed $meta_value Metadata value. Must be serializable if non-scalar.
  * @param mixed $prev_value Optional. Previous value to check before removing.
  * @return bool True on success, false on failure.