From d525642dd113b65924839eab015140b197cb9b16 Mon Sep 17 00:00:00 2001
From: Timothy Jacobs <timothyblynjacobs@git.wordpress.org>
Date: Fri, 17 Jul 2020 02:57:04 +0000
Subject: [PATCH] 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.


git-svn-id: https://develop.svn.wordpress.org/trunk@48502 602fd350-edb4-49c9-b593-d223f7449a82
---
 src/wp-includes/meta.php                  | 9 +++++----
 tests/phpunit/tests/meta/registerMeta.php | 4 ++--
 2 files changed, 7 insertions(+), 6 deletions(-)

diff --git a/src/wp-includes/meta.php b/src/wp-includes/meta.php
index 805725074b..88edf152cd 100644
--- a/src/wp-includes/meta.php
+++ b/src/wp-includes/meta.php
@@ -508,7 +508,7 @@ function get_metadata( $meta_type, $object_id, $meta_key = '', $single = false )
 		return $value;
 	}
 
-	return get_metadata_default( $meta_type, $meta_key, $single, $object_id );
+	return get_metadata_default( $meta_type, $object_id, $meta_key, $single );
 }
 
 /**
@@ -595,13 +595,14 @@ function get_metadata_raw( $meta_type, $object_id, $meta_key = '', $single = fal
  *
  * @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 = '';
 	} else {
diff --git a/tests/phpunit/tests/meta/registerMeta.php b/tests/phpunit/tests/meta/registerMeta.php
index b85da042e1..025a2a1e71 100644
--- a/tests/phpunit/tests/meta/registerMeta.php
+++ b/tests/phpunit/tests/meta/registerMeta.php
@@ -520,7 +520,7 @@ class Tests_Meta_Register_Meta extends WP_UnitTestCase {
 
 		$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 );
 
 		// Check for default value.
@@ -567,7 +567,7 @@ class Tests_Meta_Register_Meta extends WP_UnitTestCase {
 
 		$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 );
 	}