Meta: Introduce an initial set of tests for `register_meta()`.
Props sc0ttkclark, ericlewis. See #35658. git-svn-id: https://develop.svn.wordpress.org/trunk@37995 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Jeremy Felt
parent
4b6b18d730
commit
4938acf349
|
|
@ -0,0 +1,362 @@
|
|||
<?php
|
||||
/**
|
||||
* @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 ) {
|
||||
return $meta_key . ' new sanitized';
|
||||
}
|
||||
|
||||
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' );
|
||||
|
||||
$this->assertTrue( $result );
|
||||
}
|
||||
|
||||
public function test_register_meta_with_post_object_type_and_subtype_populates_wp_meta_keys() {
|
||||
global $wp_meta_keys;
|
||||
|
||||
register_meta( 'post', 'flight_number', array( 'object_subtype' => 'post' ) );
|
||||
$actual = $wp_meta_keys;
|
||||
unregister_meta_key( 'post', '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,
|
||||
),
|
||||
),
|
||||
),
|
||||
);
|
||||
|
||||
$this->assertEquals( $actual, $expected );
|
||||
}
|
||||
|
||||
public function test_register_meta_with_post_object_type_and_unregistered_subtype_populates_wp_meta_keys() {
|
||||
global $wp_meta_keys;
|
||||
|
||||
register_meta( 'post', 'flight_number', array( 'object_subtype' => 'not_a_post_type' ) );
|
||||
$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' );
|
||||
|
||||
$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,
|
||||
),
|
||||
),
|
||||
),
|
||||
);
|
||||
|
||||
$this->assertEquals( $actual, $expected );
|
||||
}
|
||||
|
||||
public function test_register_meta_with_deprecated_sanitize_callback_does_not_populate_wp_meta_keys() {
|
||||
global $wp_meta_keys;
|
||||
|
||||
register_meta( 'post', 'flight_number', array( $this, '_old_sanitize_meta_cb' ) );
|
||||
$actual = $wp_meta_keys;
|
||||
remove_filter( 'sanitize_post_meta_flight_number', array( $this, '_old_sanitize_meta_cb') );
|
||||
remove_filter( 'auth_post_meta_flight_number', '__return_true');
|
||||
|
||||
$this->assertEquals( array(), $actual );
|
||||
}
|
||||
|
||||
public function test_register_meta_with_deprecated_sanitize_callback_param_returns_wp_error() {
|
||||
$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() );
|
||||
}
|
||||
|
||||
public function test_register_meta_with_deprecated_sanitize_callback_parameter_passes_through_filter() {
|
||||
register_meta( 'post', 'old_sanitized_key', array( $this, '_old_sanitize_meta_cb' ) );
|
||||
$meta = sanitize_meta( 'old_sanitized_key', 'unsanitized', 'post', 'post' );
|
||||
|
||||
remove_filter( 'sanitize_post_meta_flight_number', array( $this, '_old_sanitize_meta_cb') );
|
||||
remove_filter( 'auth_post_meta_flight_number', '__return_true');
|
||||
|
||||
$this->assertEquals( 'old_sanitized_key old sanitized', $meta );
|
||||
}
|
||||
|
||||
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' ) ) );
|
||||
$actual = $wp_meta_keys;
|
||||
unregister_meta_key( 'post', '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,
|
||||
),
|
||||
),
|
||||
),
|
||||
);
|
||||
$this->assertEquals( $actual, $expected );
|
||||
}
|
||||
|
||||
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' );
|
||||
|
||||
remove_filter( 'sanitize_post_post_meta_flight_number', array( $this, '_new_sanitize_meta_cb') );
|
||||
remove_filter( 'auth_post_post_meta_flight_number', '__return_true');
|
||||
|
||||
$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' );
|
||||
|
||||
unregister_meta_key( 'post', 'post', 'new_sanitized_key' );
|
||||
|
||||
remove_filter( 'sanitize_post_post_meta_new_sanitized_key', array( $this, '_new_sanitize_meta_cb') );
|
||||
remove_filter( 'auth_post_post_meta_new_sanitized_key', '__return_true');
|
||||
|
||||
$this->assertEquals( 'new_sanitized_key new sanitized', $meta );
|
||||
}
|
||||
|
||||
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' );
|
||||
|
||||
$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_get_registered_meta_keys() {
|
||||
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', 'post' );
|
||||
|
||||
unregister_meta_key( 'post', 'post', 'registered_key1' );
|
||||
unregister_meta_key( 'post', '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' ) );
|
||||
|
||||
$meta_keys = get_registered_meta_keys( 'invalid-type' );
|
||||
|
||||
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_has_count() {
|
||||
register_meta( 'post', 'registered_key1', array( 'object_subtype' => 'post' ) );
|
||||
register_meta( 'post', 'registered_key2', array( 'object_subtype' => 'page' ) );
|
||||
|
||||
$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' );
|
||||
|
||||
$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' ) );
|
||||
|
||||
$meta_keys = get_registered_meta_keys( 'post', 'post' );
|
||||
|
||||
unregister_meta_key( 'post', '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' ) );
|
||||
add_post_meta( self::$post_id, 'flight_number', 'Oceanic 815' );
|
||||
|
||||
$meta = get_registered_metadata( 'post', 'post', self::$post_id );
|
||||
|
||||
unregister_meta_key( 'post', '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' ) );
|
||||
add_post_meta( self::$post_id, 'flight_number', 'Oceanic 815' );
|
||||
|
||||
$meta = get_registered_metadata( 'post', 'post', self::$post_id, 'flight_number' );
|
||||
|
||||
unregister_meta_key( 'post', '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 ) );
|
||||
add_post_meta( self::$post_id, 'flight_number', 'Oceanic 815' );
|
||||
|
||||
$meta = get_registered_metadata( 'post', 'post', self::$post_id, 'flight_number' );
|
||||
|
||||
unregister_meta_key( 'post', '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' ) );
|
||||
add_post_meta( self::$post_id, 'flight_number', 'Oceanic 815' );
|
||||
|
||||
$meta = get_registered_metadata( 'post', 'post', self::$post_id, 'flight_pilot' );
|
||||
|
||||
unregister_meta_key( 'post', 'post', 'flight_number' );
|
||||
|
||||
$this->assertWPError( $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' );
|
||||
|
||||
$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 );
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue