vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-04-03 04:04:35 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Meta: Remove object subtype handling from register_meta().

Browse Source 
Registration is now based solely on object type, which allows the code around this to be simplified significantly.

In the process of making this adjustment:

* `register_meta()`, `unregister_meta_key()`, `get_registered_metadata()`, and `registered_meta_key_exists()` no longer return `WP_Error` objects.
* The recently introduced `wp_object_type_exists()` function and the restriction on object type has been removed.

Note: No guarantee of uniqueness is made across object subtypes. Registered meta keys should be uniquely prefixed to avoid conflict.

Fixes #35658.


git-svn-id: https://develop.svn.wordpress.org/trunk@38095 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Jeremy Felt
2016-07-18 21:15:37 +00:00
parent ff6d8819e4
commit 4f2008a104
3 changed files with 119 additions and 336 deletions
Download Patch File Download Diff File Expand all files Collapse all files

269
tests/phpunit/tests/meta/registerMeta.php
View File

@@ -3,32 +3,21 @@
* @group meta
*/
class Tests_Meta_Register_Meta extends WP_UnitTestCase {
protected static $editor_id;
protected static $post_id;
protected static $comment_id;
public static function wpSetUpBeforeClass( $factory ) {
self::$editor_id = $factory->user->create( array( 'role' => 'editor' ) );
self::$post_id = $factory->post->create();
self::$comment_id = $factory->comment->create( array( 'comment_post_ID' => self::$post_id ) );
}
public static function wpTearDownAfterClass() {
self::delete_user( self::$editor_id );
wp_delete_comment( self::$comment_id, true );
wp_delete_post( self::$post_id, true );
}
function setUp() {
parent::setUp();
wp_set_current_user( self::$editor_id );
}
public function _old_sanitize_meta_cb( $meta_value, $meta_key, $meta_type ) {
return $meta_key . ' old sanitized';
}
public function _new_sanitize_meta_cb( $meta_value, $meta_key, $object_type, $object_subtype ) {
public function _new_sanitize_meta_cb( $meta_value, $meta_key, $object_type ) {
return $meta_key . ' new sanitized';
}
@@ -68,32 +57,29 @@ class Tests_Meta_Register_Meta extends WP_UnitTestCase {
$this->assertEquals( array( 'auth' => 10, 'sanitize' => 10 ), $has_filters );
}
public function test_register_meta_with_valid_object_type_and_object_subtype_returns_true() {
$result = register_meta( 'post', 'flight_number', array( 'object_subtype' => 'post' ) );
unregister_meta_key( 'post', 'post', 'flight_number' );
public function test_register_meta_with_post_object_type_returns_true() {
$result = register_meta( 'post', 'flight_number', array() );
unregister_meta_key( 'post', 'flight_number' );
$this->assertTrue( $result );
}
public function test_register_meta_with_post_object_type_and_subtype_populates_wp_meta_keys() {
public function test_register_meta_with_post_object_type_populates_wp_meta_keys() {
global $wp_meta_keys;
register_meta( 'post', 'flight_number', array( 'object_subtype' => 'post' ) );
register_meta( 'post', 'flight_number', array() );
$actual = $wp_meta_keys;
unregister_meta_key( 'post', 'post', 'flight_number' );
unregister_meta_key( 'post', 'flight_number' );
$expected = array(
'post' => array(
'post' => array(
'flight_number' => array(
'object_subtype' => 'post',
'type' => 'string',
'description' => '',
'single' => false,
'sanitize_callback' => null,
'auth_callback' => '__return_true',
'show_in_rest' => false,
),
'flight_number' => array(
'type' => 'string',
'description' => '',
'single' => false,
'sanitize_callback' => null,
'auth_callback' => '__return_true',
'show_in_rest' => false,
),
),
);
@@ -101,75 +87,21 @@ class Tests_Meta_Register_Meta extends WP_UnitTestCase {
$this->assertEquals( $actual, $expected );
}
public function test_register_meta_with_post_object_type_and_unregistered_subtype_populates_wp_meta_keys() {
public function test_register_meta_with_term_object_type_populates_wp_meta_keys() {
global $wp_meta_keys;
register_meta( 'post', 'flight_number', array( 'object_subtype' => 'not_a_post_type' ) );
register_meta( 'term', 'category_icon', array() );
$actual = $wp_meta_keys;
unregister_meta_key( 'post', 'not_a_post_type', 'flight_number' );
$expected = array(
'post' => array(
'not_a_post_type' => array(
'flight_number' => array(
'object_subtype' => 'not_a_post_type',
'type' => 'string',
'description' => '',
'single' => false,
'sanitize_callback' => null,
'auth_callback' => '__return_true',
'show_in_rest' => false,
),
),
),
);
$this->assertEquals( $actual, $expected );
}
public function test_register_meta_with_term_object_type_and_category_subtype_populates_wp_meta_keys() {
global $wp_meta_keys;
register_meta( 'term', 'category_icon', array( 'object_subtype' => 'category' ) );
$actual = $wp_meta_keys;
unregister_meta_key( 'term', 'category', 'category_icon' );
unregister_meta_key( 'term', 'category_icon' );
$expected = array(
'term' => array(
'category' => array(
'category_icon' => array(
'object_subtype' => 'category',
'type' => 'string',
'description' => '',
'single' => false,
'sanitize_callback' => null,
'auth_callback' => '__return_true',
'show_in_rest' => false,
),
),
),
);
$this->assertEquals( $actual, $expected );
}
public function test_register_meta_with_comment_object_type_and_subtype_populates_wp_meta_keys() {
global $wp_meta_keys;
register_meta( 'comment', 'comment_rating', array( 'object_subtype' => 'comment' ) );
$actual = $wp_meta_keys;
unregister_meta_key( 'comment', 'comment', 'comment_rating' );
$expected = array(
'comment' => array(
'comment' => array(
'comment_rating' => array(
'object_subtype' => 'comment',
'type' => 'string',
'description' => '',
'single' => false,
'sanitize_callback' => null,
'auth_callback' => '__return_true',
'show_in_rest' => false,
),
'category_icon' => array(
'type' => 'string',
'description' => '',
'single' => false,
'sanitize_callback' => null,
'auth_callback' => '__return_true',
'show_in_rest' => false,
),
),
);
@@ -188,14 +120,13 @@ class Tests_Meta_Register_Meta extends WP_UnitTestCase {
$this->assertEquals( array(), $actual );
}
public function test_register_meta_with_deprecated_sanitize_callback_param_returns_wp_error() {
public function test_register_meta_with_deprecated_sanitize_callback_param_returns_false() {
$actual = register_meta( 'post', 'flight_number', array( $this, '_old_sanitize_meta_cb' ) );
remove_filter( 'sanitize_post_meta_flight_number', array( $this, '_old_sanitize_meta_cb') );
remove_filter( 'auth_post_meta_flight_number', '__return_true');
$this->assertWPError( $actual );
$this->assertEquals( 'register_meta_failed', $actual->get_error_code() );
$this->assertFalse( $actual );
}
public function test_register_meta_with_deprecated_sanitize_callback_parameter_passes_through_filter() {
@@ -210,22 +141,19 @@ class Tests_Meta_Register_Meta extends WP_UnitTestCase {
public function test_register_meta_with_current_sanitize_callback_populates_wp_meta_keys() {
global $wp_meta_keys;
register_meta( 'post', 'flight_number', array( 'object_subtype' => 'post', 'sanitize_callback' => array( $this, '_new_sanitize_meta_cb' ) ) );
register_meta( 'post', 'flight_number', array( 'sanitize_callback' => array( $this, '_new_sanitize_meta_cb' ) ) );
$actual = $wp_meta_keys;
unregister_meta_key( 'post', 'post', 'flight_number' );
unregister_meta_key( 'post', 'flight_number' );
$expected = array(
'post' => array(
'post' => array(
'flight_number' => array(
'object_subtype' => 'post',
'type' => 'string',
'description' => '',
'single' => false,
'sanitize_callback' => array( $this, '_new_sanitize_meta_cb' ),
'auth_callback' => '__return_true',
'show_in_rest' => false,
),
'flight_number' => array(
'type' => 'string',
'description' => '',
'single' => false,
'sanitize_callback' => array( $this, '_new_sanitize_meta_cb' ),
'auth_callback' => '__return_true',
'show_in_rest' => false,
),
),
);
@@ -233,178 +161,143 @@ class Tests_Meta_Register_Meta extends WP_UnitTestCase {
}
public function test_register_meta_with_current_sanitize_callback_returns_true() {
$result = register_meta( 'post', 'flight_number', array( 'object_subtype' => 'post', 'sanitize_callback' => array( $this, '_new_sanitize_meta_cb' ) ) );
unregister_meta_key( 'post', 'post', 'flight_number' );
$result = register_meta( 'post', 'flight_number', array( 'sanitize_callback' => array( $this, '_new_sanitize_meta_cb' ) ) );
unregister_meta_key( 'post', 'flight_number' );
$this->assertTrue( $result );
}
public function test_register_meta_with_new_sanitize_callback_parameter() {
register_meta( 'post', 'new_sanitized_key', array( 'object_subtype' => 'post', 'sanitize_callback' => array( $this, '_new_sanitize_meta_cb' ) ) );
$meta = sanitize_meta( 'new_sanitized_key', 'unsanitized', 'post', 'post' );
register_meta( 'post', 'new_sanitized_key', array( 'sanitize_callback' => array( $this, '_new_sanitize_meta_cb' ) ) );
$meta = sanitize_meta( 'new_sanitized_key', 'unsanitized', 'post' );
unregister_meta_key( 'post', 'post', 'new_sanitized_key' );
unregister_meta_key( 'post', 'new_sanitized_key' );
$this->assertEquals( 'new_sanitized_key new sanitized', $meta );
}
public function test_register_meta_unregistered_meta_key_removes_sanitize_filter() {
register_meta( 'post', 'new_sanitized_key', array( 'object_subtype' => 'post', 'sanitize_callback' => array( $this, '_new_sanitize_meta_cb' ) ) );
unregister_meta_key( 'post', 'post', 'new_sanitized_key' );
register_meta( 'post', 'new_sanitized_key', array( 'sanitize_callback' => array( $this, '_new_sanitize_meta_cb' ) ) );
unregister_meta_key( 'post', 'new_sanitized_key' );
$has_filter = has_filter( 'sanitize_post_post_meta_new_sanitized_key', array( $this, '_new_sanitize_meta_cb' ) );
$has_filter = has_filter( 'sanitize_post_meta_new_sanitized_key', array( $this, '_new_sanitize_meta_cb' ) );
$this->assertFalse( $has_filter );
}
public function test_register_meta_unregistered_meta_key_removes_auth_filter() {
register_meta( 'post', 'new_auth_key', array( 'object_subtype' => 'post', 'auth_callback' => array( $this, '_new_auth_meta_cb' ) ) );
unregister_meta_key( 'post', 'post', 'new_auth_key' );
register_meta( 'post', 'new_auth_key', array( 'auth_callback' => array( $this, '_new_auth_meta_cb' ) ) );
unregister_meta_key( 'post', 'new_auth_key' );
$has_filter = has_filter( 'auth_post_post_meta_new_auth_key', array( $this, '_new_auth_meta_cb' ) );
$has_filter = has_filter( 'auth_post_meta_new_auth_key', array( $this, '_new_auth_meta_cb' ) );
$this->assertFalse( $has_filter );
}
public function test_unregister_meta_key_clears_key_from_wp_meta_keys() {
global $wp_meta_keys;
register_meta( 'post', 'registered_key', array( 'object_subtype' => 'post' ) );
unregister_meta_key( 'post', 'post', 'registered_key' );
register_meta( 'post', 'registered_key', array() );
unregister_meta_key( 'post', 'registered_key' );
$this->assertEquals( array(), $wp_meta_keys );
}
public function test_unregister_meta_key_with_invalid_key_returns_wp_error() {
$this->assertWPError( unregister_meta_key( 'post', 'post', 'not_a_registered_key' ) );
public function test_unregister_meta_key_with_invalid_key_returns_false() {
$this->assertFalse( unregister_meta_key( 'post', 'not_a_registered_key' ) );
}
public function test_get_registered_meta_keys() {
register_meta( 'post', 'registered_key1', array( 'object_subtype' => 'post' ) );
register_meta( 'post', 'registered_key2', array( 'object_subtype' => 'post' ) );
register_meta( 'post', 'registered_key1', array() );
register_meta( 'post', 'registered_key2', array() );
$meta_keys = get_registered_meta_keys( 'post', 'post' );
$meta_keys = get_registered_meta_keys( 'post' );
unregister_meta_key( 'post', 'post', 'registered_key1' );
unregister_meta_key( 'post', 'post', 'registered_key2' );
unregister_meta_key( 'post', 'registered_key1' );
unregister_meta_key( 'post', 'registered_key2' );
$this->assertArrayHasKey( 'registered_key1', $meta_keys );
$this->assertArrayHasKey( 'registered_key2', $meta_keys );
}
public function test_get_registered_meta_keys_with_subtype_without_registered_keys_is_empty() {
register_meta( 'post', 'registered_key1', array( 'object_subtype' => 'post' ) );
register_meta( 'post', 'registered_key2', array( 'object_subtype' => 'post' ) );
$meta_keys = get_registered_meta_keys( 'post', 'page' );
unregister_meta_key( 'post', 'post', 'registered_key1' );
unregister_meta_key( 'post', 'post', 'registered_key2' );
$this->assertEmpty( $meta_keys );
}
public function test_get_registered_meta_keys_with_invalid_type_is_empty() {
register_meta( 'post', 'registered_key1', array( 'object_subtype' => 'post' ) );
register_meta( 'post', 'registered_key2', array( 'object_subtype' => 'post' ) );
register_meta( 'post', 'registered_key1', array() );
register_meta( 'post', 'registered_key2', array() );
$meta_keys = get_registered_meta_keys( 'invalid-type' );
unregister_meta_key( 'post', 'post', 'registered_key1' );
unregister_meta_key( 'post', 'post', 'registered_key2' );
unregister_meta_key( 'post', 'registered_key1' );
unregister_meta_key( 'post', 'registered_key2' );
$this->assertEmpty( $meta_keys );
}
public function test_get_registered_meta_keys_has_count() {
register_meta( 'post', 'registered_key1', array( 'object_subtype' => 'post' ) );
register_meta( 'post', 'registered_key2', array( 'object_subtype' => 'page' ) );
public function test_get_registered_meta_keys_description_arg() {
register_meta( 'post', 'registered_key1', array( 'description' => 'I\'m just a field, take a good look at me' ) );
$meta_keys = get_registered_meta_keys( 'post' );
unregister_meta_key( 'post', 'post', 'registered_key1' );
unregister_meta_key( 'post', 'page', 'registered_key2' );
$this->assertCount( 2, $meta_keys );
}
public function test_get_registered_meta_keys_description_arg() {
register_meta( 'post', 'registered_key1', array( 'object_subtype' => 'post', 'description' => 'I\'m just a field, take a good look at me' ) );
$meta_keys = get_registered_meta_keys( 'post', 'post' );
unregister_meta_key( 'post', 'post', 'registered_key1' );
unregister_meta_key( 'post', 'registered_key1' );
$this->assertEquals( 'I\'m just a field, take a good look at me', $meta_keys['registered_key1']['description'] );
}
public function test_get_registered_meta_keys_invalid_arg() {
register_meta( 'post', 'registered_key1', array( 'object_subtype' => 'post', 'invalid_arg' => 'invalid' ) );
register_meta( 'post', 'registered_key1', array( 'invalid_arg' => 'invalid' ) );
$meta_keys = get_registered_meta_keys( 'post', 'post' );
$meta_keys = get_registered_meta_keys( 'post' );
unregister_meta_key( 'post', 'post', 'registered_key1' );
unregister_meta_key( 'post', 'registered_key1' );
$this->assertArrayNotHasKey( 'invalid_arg', $meta_keys['registered_key1'] );
}
public function test_get_registered_metadata() {
register_meta( 'post', 'flight_number', array( 'object_subtype' => 'post' ) );
register_meta( 'post', 'flight_number', array() );
add_post_meta( self::$post_id, 'flight_number', 'Oceanic 815' );
$meta = get_registered_metadata( 'post', 'post', self::$post_id );
$meta = get_registered_metadata( 'post', self::$post_id );
unregister_meta_key( 'post', 'post', 'flight_number' );
unregister_meta_key( 'post', 'flight_number' );
$this->assertEquals( 'Oceanic 815', $meta['flight_number'][0] );
}
public function test_get_registered_metadata_by_key() {
register_meta( 'post', 'flight_number', array( 'object_subtype' => 'post' ) );
register_meta( 'post', 'flight_number', array() );
add_post_meta( self::$post_id, 'flight_number', 'Oceanic 815' );
$meta = get_registered_metadata( 'post', 'post', self::$post_id, 'flight_number' );
$meta = get_registered_metadata( 'post', self::$post_id, 'flight_number' );
unregister_meta_key( 'post', 'post', 'flight_number' );
unregister_meta_key( 'post', 'flight_number' );
$this->assertEquals( 'Oceanic 815', $meta[0] );
}
public function test_get_registered_metadata_by_key_single() {
register_meta( 'post', 'flight_number', array( 'object_subtype' => 'post', 'single' => true ) );
register_meta( 'post', 'flight_number', array( 'single' => true ) );
add_post_meta( self::$post_id, 'flight_number', 'Oceanic 815' );
$meta = get_registered_metadata( 'post', 'post', self::$post_id, 'flight_number' );
$meta = get_registered_metadata( 'post', self::$post_id, 'flight_number' );
unregister_meta_key( 'post', 'post', 'flight_number' );
unregister_meta_key( 'post', 'flight_number' );
$this->assertEquals( 'Oceanic 815', $meta );
}
public function test_get_registered_metadata_by_invalid_key() {
register_meta( 'post', 'flight_number', array( 'object_subtype' => 'post' ) );
register_meta( 'post', 'flight_number', array() );
add_post_meta( self::$post_id, 'flight_number', 'Oceanic 815' );
$meta = get_registered_metadata( 'post', 'post', self::$post_id, 'flight_pilot' );
$meta = get_registered_metadata( 'post', self::$post_id, 'flight_pilot' );
unregister_meta_key( 'post', 'post', 'flight_number' );
unregister_meta_key( 'post', 'flight_number' );
$this->assertWPError( $meta );
$this->assertFalse( $meta );
}
public function test_get_registered_metadata_invalid_object_type() {
register_meta( 'post', 'flight_number', array( 'object_subtype' => 'post' ) );
add_post_meta( self::$post_id, 'flight_number', 'Oceanic 815' );
public function test_get_registered_metadata_invalid_object_type_returns_empty_array() {
$meta = get_registered_metadata( 'invalid-type', self::$post_id );
$meta = get_registered_metadata( 'invalid-type', 'invalid-subtype', self::$post_id );
unregister_meta_key( 'post', 'post', 'flight_number' );
$this->assertWPError( $meta );
}
public function test_get_registered_metadata_invalid() {
$meta = get_registered_metadata( 'invalid-type', 'invalid-subtype', self::$post_id );
$this->assertWPError( $meta );
$this->assertEmpty( $meta );
}
}