Changeset 48502

Timestamp:

07/17/2020 02:57:04 AM (4 years ago)

Author:

TimothyBlynJacobs

Message:

Meta: Reorder the get_metadata_default() signature to match get_metadata().

The order of parameters in get_metadata_default() did not match the signature of get_metadata(). This could be confusing for developers who are familiar with the existing metadata API.

Fixes #43941.
Props SergeyBiryukov, spacedmonkey, johnjamesjacoby.

Location:

trunk

Files:

• src/wp-includes/meta.php (modified) (2 diffs)
• tests/phpunit/tests/meta/registerMeta.php (modified) (2 diffs)

trunk/src/wp-includes/meta.php

@@ -509 +509 @@
     }
 
-    return get_metadata_default( $meta_type, $meta_key, $single, $object_id );
+    return get_metadata_default( $meta_type, $object_id, $meta_key, $single );
 }
 
@@ -596 +596 @@
  * @param string $meta_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user',
  *                          or any other object type with an associated meta table.
- * @param string $meta_key  Metadata key.
+ * @param int    $object_id ID of the object metadata is for.
+ * @param string $meta_key  Metadata key. If not specified, retrieve all metadata for
+ *                          the specified object. Default empty.
  * @param bool   $single    Optional. If true, return only the first value of the specified meta_key.
  *                          This parameter has no effect if meta_key is not specified. Default false.
- * @param int    $object_id Optional. ID of the object metadata is for. Default 0.
  * @return mixed Single metadata value, or array of values.
  */
-function get_metadata_default( $meta_type, $meta_key, $single = false, $object_id = 0 ) {
+function get_metadata_default( $meta_type, $object_id, $meta_key, $single = false ) {
     if ( $single ) {
         $value = '';

trunk/tests/phpunit/tests/meta/registerMeta.php

@@ -521 +521 @@
         $object_property_name = $object_type . '_id';
         $object_id            = self::$$object_property_name;
-        $default_value        = get_metadata_default( $object_type, $meta_key, $single, $object_id );
+        $default_value        = get_metadata_default( $object_type, $object_id, $meta_key, $single );
         $this->assertSame( $default_value, $expected );
 
@@ -568 +568 @@
         $object_property_name = $object_type . '_id';
         $object_id            = self::$$object_property_name;
-        $default_value        = get_metadata_default( $object_type, $meta_key, $single, $object_id );
+        $default_value        = get_metadata_default( $object_type, $object_id, $meta_key, $single );
         $this->assertSame( $default_value, $expected );
     }