diff --git src/wp-admin/includes/class-wp-ms-sites-list-table.php src/wp-admin/includes/class-wp-ms-sites-list-table.php index 5147139835..9e73490bb7 100644 --- src/wp-admin/includes/class-wp-ms-sites-list-table.php +++ src/wp-admin/includes/class-wp-ms-sites-list-table.php @@ -236,7 +236,7 @@ class WP_MS_Sites_List_Table extends WP_List_Table { ? ' class="current" aria-current="page"' : ''; if ( (int) $counts[ $status ] > 0 ) { - $label = sprintf( translate_nooped_plural( $label_count, $counts[ $status ] ), number_format_i18n( $counts[ $status ] ) ); + $label = sprintf( translate_nooped_plural( $label_count, $counts[ $status ] ), number_format_i18n( $counts[ $status ] ) ); $full_url = 'all' === $status ? $url : add_query_arg( 'status', $status, $url ); $view_links[ $status ] = sprintf( diff --git src/wp-includes/meta.php src/wp-includes/meta.php index bc6b05d953..c6659b3d4c 100644 --- src/wp-includes/meta.php +++ src/wp-includes/meta.php @@ -206,7 +206,9 @@ function update_metadata( $meta_type, $object_id, $meta_key, $meta_value, $prev_ // Compare existing value to new value if no prev value given and the key exists only once. if ( empty( $prev_value ) ) { + remove_filter( "default_{$meta_type}_metadata", 'filter_default_metadata', 10, 5 ); $old_value = get_metadata( $meta_type, $object_id, $meta_key ); + add_filter( "default_{$meta_type}_metadata", 'filter_default_metadata', 10, 5 ); if ( count( $old_value ) == 1 ) { if ( $old_value[0] === $meta_value ) { return false; @@ -542,11 +544,46 @@ function get_metadata( $meta_type, $object_id, $meta_key = '', $single = false ) } } + return get_metadata_default( $meta_type, $meta_key, $single, $object_id ); +} + +/** + * Retrieve metadata data default for the specified object. + * + * @since 5.3.0 + * + * @param string $meta_type Type of object metadata is for (e.g., comment, post, term, or user). + * @param string $meta_key Optional. Metadata key. If not specified, retrieve all metadata for + * the specified object. + * @param bool $single Optional, default is false. + * If true, return only the first value of the specified meta_key. + * This parameter has no effect if meta_key is not specified. + * @param int $object_id Optional, default is 0. + * ID of the object metadata is for + * @return mixed Single metadata value, or array of values + */ +function get_metadata_default( $meta_type, $meta_key, $single = false, $object_id = 0 ) { if ( $single ) { - return ''; + $value = ''; } else { - return array(); + $value = array(); } + + /** + * Filter the default value a specified object. + * + * @since 5.3.0 + * + * @param array|string $value The value should return - a single metadata value, + * or an array of values. + * @param string $meta_type Type of object metadata is for (e.g., comment, post, term, or user). + * @param string $meta_key Meta key. + * @param bool $single Whether to return only the first value of the specified $meta_key. + * @param int $object_id Object ID. + */ + $value = apply_filters( "default_{$meta_type}_metadata", $value, $meta_type, $meta_key, $single, $object_id ); + + return $value; } /** @@ -1229,6 +1266,14 @@ function register_meta( $object_type, $meta_key, $args, $deprecated = null ) { } } + if ( false === $args['single'] && ! wp_is_numeric_array( $args['default'] ) ) { + unset( $args['default'] ); + } + + if ( array_key_exists( 'default', $args ) ) { + add_filter( "default_{$object_type}_metadata", 'filter_default_metadata', 10, 5 ); + } + // Global registry only contains meta keys registered with the array of arguments added in 4.6.0. if ( ! $has_old_auth_cb && ! $has_old_sanitize_cb ) { unset( $args['object_subtype'] ); @@ -1457,3 +1502,43 @@ function get_object_subtype( $object_type, $object_id ) { */ return apply_filters( "get_object_subtype_{$object_type}", $object_subtype, $object_id ); } + +/** + * Filter into default_{$object_type}_metadata and add in default value. + * + * @since 5.3.0 + * + * @param mixed $value Current value passed to filter. + * @param string $meta_type Type of object metadata is for (e.g., comment, post, term, or user). + + * @param string $meta_key Optional. Metadata key. If not specified, retrieve all metadata for + * the specified object. + * @param bool $single Optional, default is false. + * If true, return only the first value of the specified meta_key. + * This parameter has no effect if meta_key is not specified. + * @param int $object_id ID of the object metadata is for + * + * @return mixed Single metadata default, or array of defaults + */ +function filter_default_metadata( $value, $meta_type, $meta_key, $single, $object_id ) { + $metadata = get_registered_meta_keys( $meta_type ); + if ( ! isset( $metadata[ $meta_key ] ) ) { + $sub_type = get_object_subtype( $meta_type, $object_id ); + $metadata = get_registered_meta_keys( $meta_type, $sub_type ); + if ( ! isset( $metadata[ $meta_key ] ) ) { + return $value; + } + } + + if ( $single ) { + if ( $metadata[ $meta_key ]['single'] ) { + $value = $metadata[ $meta_key ]['default']; + } else { + $value = $metadata[ $meta_key ]['default'][0]; + } + } else { + $value = $metadata[ $meta_key ]['default']; + } + + return $value; +} diff --git tests/phpunit/tests/meta/registerMeta.php tests/phpunit/tests/meta/registerMeta.php index 334a2320d0..fcf6c1b449 100644 --- tests/phpunit/tests/meta/registerMeta.php +++ tests/phpunit/tests/meta/registerMeta.php @@ -95,6 +95,7 @@ class Tests_Meta_Register_Meta extends WP_UnitTestCase { 'description' => '', 'single' => false, 'sanitize_callback' => null, + 'default' => null, 'auth_callback' => '__return_true', 'show_in_rest' => false, ), @@ -119,6 +120,7 @@ class Tests_Meta_Register_Meta extends WP_UnitTestCase { 'description' => '', 'single' => false, 'sanitize_callback' => null, + 'default' => null, 'auth_callback' => '__return_true', 'show_in_rest' => false, ), @@ -172,6 +174,7 @@ class Tests_Meta_Register_Meta extends WP_UnitTestCase { 'type' => 'string', 'description' => '', 'single' => false, + 'default' => null, 'sanitize_callback' => array( $this, '_new_sanitize_meta_cb' ), 'auth_callback' => '__return_true', 'show_in_rest' => false, @@ -340,6 +343,7 @@ class Tests_Meta_Register_Meta extends WP_UnitTestCase { 'description' => '', 'single' => false, 'sanitize_callback' => null, + 'default' => null, 'auth_callback' => '__return_true', 'show_in_rest' => false, ), @@ -393,6 +397,7 @@ class Tests_Meta_Register_Meta extends WP_UnitTestCase { 'description' => '', 'single' => false, 'sanitize_callback' => null, + 'default' => null, 'auth_callback' => '__return_true', 'show_in_rest' => false, ), @@ -504,6 +509,49 @@ class Tests_Meta_Register_Meta extends WP_UnitTestCase { $this->assertSame( 'even', $subtype_for_4 ); } + /** + * @ticket 43941 + * @dataProvider data_get_default_data + */ + public function test_get_default_value( $args, $single, $expected ) { + + $object_type = 'post'; + $meta_key = 'registered_key1'; + register_meta( + $object_type, + $meta_key, + $args + ); + + $object_property_name = $object_type . '_id'; + $object_id = self::$$object_property_name; + + // Check for default value. + $value = get_metadata( $object_type, $object_id, $meta_key, $single ); + $this->assertSame( $value, $expected ); + + // Set value to check default is not being returned by mistake. + $meta_value = 'dibble'; + update_metadata( $object_type, $object_id, $meta_key, $meta_value ); + $value = get_metadata( $object_type, $object_id, $meta_key, true ); + $this->assertSame( $value, $meta_value ); + + // Delete meta, make sure the default is returned. + delete_metadata( $object_type, $object_id, $meta_key ); + $value = get_metadata( $object_type, $object_id, $meta_key, $single ); + $this->assertSame( $value, $expected ); + + // Set other meta key, to make sure other keys are not effects. + $meta_value = 'hibble'; + $meta_key = 'unregistered_key1'; + $value = get_metadata( $object_type, $object_id, $meta_key, true ); + $this->assertSame( $value, '' ); + update_metadata( $object_type, $object_id, $meta_key, $meta_value ); + $value = get_metadata( $object_type, $object_id, $meta_key, true ); + $this->assertSame( $value, $meta_value ); + + } + public function filter_get_object_subtype_for_customtype( $subtype, $object_id ) { if ( 1 === ( $object_id % 2 ) ) { return 'odd'; @@ -512,6 +560,147 @@ class Tests_Meta_Register_Meta extends WP_UnitTestCase { return 'even'; } + public function data_get_default_data() { + return array( + array( + array( + 'single' => true, + 'default' => 'wibble', + ), + true, + 'wibble', + ), + array( + array( + 'single' => true, + 'default' => 'wibble', + ), + false, + array( 'wibble' ), + ), + array( + array( + 'single' => true, + 'default' => array( 'wibble' ), + ), + true, + array( 'wibble' ), + ), + array( + array( + 'single' => true, + 'default' => array( 'wibble' ), + ), + false, + array( array( 'wibble' ) ), + ), + array( + array( + 'single' => false, + 'default' => 'wibble', + ), + true, + '', + ), + array( + array( + 'single' => false, + 'default' => 'wibble', + ), + false, + array(), + ), + array( + array( + 'single' => false, + 'default' => array( 'wibble' ), + ), + true, + 'wibble', + ), + array( + array( + 'single' => false, + 'default' => array( 'wibble' ), + ), + false, + array( 'wibble' ), + ), + array( + array( + 'single' => true, + 'object_subtype' => 'page', + 'default' => 'wibble', + ), + true, + 'wibble', + ), + array( + array( + 'single' => true, + 'object_subtype' => 'page', + 'default' => 'wibble', + ), + false, + array( 'wibble' ), + ), + array( + array( + 'single' => true, + 'object_subtype' => 'page', + 'default' => array( 'wibble' ), + ), + true, + array( 'wibble' ), + ), + array( + array( + 'single' => true, + 'object_subtype' => 'page', + 'default' => array( 'wibble' ), + ), + false, + array( array( 'wibble' ) ), + ), + array( + array( + 'single' => true, + 'object_subtype' => 'post', + 'default' => 'wibble', + ), + true, + '', + ), + array( + array( + 'single' => true, + 'object_subtype' => 'post', + 'default' => 'wibble', + ), + false, + array(), + ), + array( + array( + 'single' => true, + 'object_subtype' => 'post', + 'default' => array( 'wibble' ), + ), + true, + '', + ), + array( + array( + 'single' => true, + 'object_subtype' => 'post', + 'default' => array( 'wibble' ), + ), + false, + array(), + ), + ); + } + public function data_get_types_and_subtypes() { return array( array( 'post', 'page' ),