wordpress-develop/tests/phpunit/tests/rest-api/rest-term-meta-fields.php
Sergey Biryukov e50c65caf4 Coding Standards: Always use parentheses when instantiating an object.
Note: This will be enforced by WPCS 3.0.0.

Props jrf.
See #56791.

git-svn-id: https://develop.svn.wordpress.org/trunk@54891 602fd350-edb4-49c9-b593-d223f7449a82
2022-11-29 15:49:49 +00:00

1358 lines
38 KiB
PHP

<?php
/**
* Unit tests covering WP_REST_Terms meta functionality.
*
* @package WordPress
* @subpackage REST API
*/
/**
* @group restapi
*/
class WP_Test_REST_Term_Meta_Fields extends WP_Test_REST_TestCase {
protected static $wp_meta_keys_saved;
protected static $category_id;
protected static $customtax_term_id;
public static function wpSetUpBeforeClass( WP_UnitTest_Factory $factory ) {
register_taxonomy(
'customtax',
'post',
array(
'show_in_rest' => true,
)
);
self::$wp_meta_keys_saved = isset( $GLOBALS['wp_meta_keys'] ) ? $GLOBALS['wp_meta_keys'] : array();
self::$category_id = $factory->category->create();
self::$customtax_term_id = $factory->term->create( array( 'taxonomy' => 'customtax' ) );
}
public static function wpTearDownAfterClass() {
$GLOBALS['wp_meta_keys'] = self::$wp_meta_keys_saved;
wp_delete_term( self::$category_id, 'category' );
wp_delete_term( self::$customtax_term_id, 'customtax' );
unregister_taxonomy( 'customtax' );
}
public function set_up() {
parent::set_up();
register_meta(
'term',
'test_single',
array(
'show_in_rest' => true,
'single' => true,
'type' => 'string',
)
);
register_meta(
'term',
'test_multi',
array(
'show_in_rest' => true,
'single' => false,
'type' => 'string',
)
);
register_meta(
'term',
'test_bad_auth',
array(
'show_in_rest' => true,
'single' => true,
'auth_callback' => '__return_false',
'type' => 'string',
)
);
register_meta(
'term',
'test_bad_auth_multi',
array(
'show_in_rest' => true,
'single' => false,
'auth_callback' => '__return_false',
'type' => 'string',
)
);
register_meta( 'term', 'test_no_rest', array() );
register_meta(
'term',
'test_rest_disabled',
array(
'show_in_rest' => false,
'type' => 'string',
)
);
register_meta(
'term',
'test_custom_schema',
array(
'single' => true,
'type' => 'integer',
'show_in_rest' => array(
'schema' => array(
'type' => 'number',
),
),
)
);
register_meta(
'term',
'test_custom_schema_multi',
array(
'single' => false,
'type' => 'integer',
'show_in_rest' => array(
'schema' => array(
'type' => 'number',
),
),
)
);
register_meta(
'term',
'test_invalid_type',
array(
'single' => true,
'type' => 'lalala',
'show_in_rest' => true,
)
);
register_meta(
'term',
'test_no_type',
array(
'single' => true,
'type' => null,
'show_in_rest' => true,
)
);
register_meta(
'term',
'test_custom_name',
array(
'single' => true,
'type' => 'string',
'show_in_rest' => array(
'name' => 'new_name',
),
)
);
register_meta(
'term',
'test_custom_name_multi',
array(
'single' => false,
'type' => 'string',
'show_in_rest' => array(
'name' => 'new_name_multi',
),
)
);
register_taxonomy(
'customtax',
'post',
array(
'show_in_rest' => true,
)
);
register_term_meta(
'customtax',
'test_customtax_single',
array(
'show_in_rest' => true,
'single' => true,
)
);
register_term_meta(
'customtax',
'test_customtax_multi',
array(
'show_in_rest' => true,
'single' => false,
)
);
// Register 'test_single' on subtype to override for bad auth.
register_term_meta(
'customtax',
'test_single',
array(
'show_in_rest' => true,
'single' => true,
'auth_callback' => '__return_false',
)
);
/** @var WP_REST_Server $wp_rest_server */
global $wp_rest_server;
$wp_rest_server = new Spy_REST_Server();
do_action( 'rest_api_init', $wp_rest_server );
}
protected function grant_write_permission() {
// Ensure we have write permission.
$user = self::factory()->user->create(
array(
'role' => 'editor',
)
);
wp_set_current_user( $user );
}
public function test_get_value() {
add_term_meta( self::$category_id, 'test_single', 'testvalue' );
$request = new WP_REST_Request( 'GET', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
$response = rest_get_server()->dispatch( $request );
$this->assertSame( 200, $response->get_status() );
$data = $response->get_data();
$this->assertArrayHasKey( 'meta', $data );
$meta = (array) $data['meta'];
$this->assertArrayHasKey( 'test_single', $meta );
$this->assertSame( 'testvalue', $meta['test_single'] );
}
/**
* @depends test_get_value
*/
public function test_get_multi_value() {
add_term_meta( self::$category_id, 'test_multi', 'value1' );
$request = new WP_REST_Request( 'GET', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
$response = rest_get_server()->dispatch( $request );
$this->assertSame( 200, $response->get_status() );
$data = $response->get_data();
$meta = (array) $data['meta'];
$this->assertArrayHasKey( 'test_multi', $meta );
$this->assertIsArray( $meta['test_multi'] );
$this->assertContains( 'value1', $meta['test_multi'] );
// Check after an update.
add_term_meta( self::$category_id, 'test_multi', 'value2' );
$response = rest_get_server()->dispatch( $request );
$this->assertSame( 200, $response->get_status() );
$data = $response->get_data();
$meta = (array) $data['meta'];
$this->assertContains( 'value1', $meta['test_multi'] );
$this->assertContains( 'value2', $meta['test_multi'] );
}
/**
* @depends test_get_value
*/
public function test_get_unregistered() {
add_term_meta( self::$category_id, 'test_unregistered', 'value1' );
$request = new WP_REST_Request( 'GET', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
$response = rest_get_server()->dispatch( $request );
$this->assertSame( 200, $response->get_status() );
$data = $response->get_data();
$meta = (array) $data['meta'];
$this->assertArrayNotHasKey( 'test_unregistered', $meta );
}
/**
* @depends test_get_value
*/
public function test_get_registered_no_api_access() {
add_term_meta( self::$category_id, 'test_no_rest', 'for_the_wicked' );
$request = new WP_REST_Request( 'GET', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
$response = rest_get_server()->dispatch( $request );
$this->assertSame( 200, $response->get_status() );
$data = $response->get_data();
$meta = (array) $data['meta'];
$this->assertArrayNotHasKey( 'test_no_rest', $meta );
}
/**
* @depends test_get_value
*/
public function test_get_registered_api_disabled() {
add_term_meta( self::$category_id, 'test_rest_disabled', 'sleepless_nights' );
$request = new WP_REST_Request( 'GET', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
$response = rest_get_server()->dispatch( $request );
$this->assertSame( 200, $response->get_status() );
$data = $response->get_data();
$meta = (array) $data['meta'];
$this->assertArrayNotHasKey( 'test_rest_disabled', $meta );
}
public function test_get_value_types() {
register_meta(
'term',
'test_string',
array(
'show_in_rest' => true,
'single' => true,
'type' => 'string',
)
);
register_meta(
'term',
'test_number',
array(
'show_in_rest' => true,
'single' => true,
'type' => 'number',
)
);
register_meta(
'term',
'test_bool',
array(
'show_in_rest' => true,
'single' => true,
'type' => 'boolean',
)
);
/** @var WP_REST_Server $wp_rest_server */
global $wp_rest_server;
$wp_rest_server = new Spy_REST_Server();
do_action( 'rest_api_init', $wp_rest_server );
add_term_meta( self::$category_id, 'test_string', 42 );
add_term_meta( self::$category_id, 'test_number', '42' );
add_term_meta( self::$category_id, 'test_bool', 1 );
$request = new WP_REST_Request( 'GET', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
$response = rest_get_server()->dispatch( $request );
$this->assertSame( 200, $response->get_status() );
$data = $response->get_data();
$meta = (array) $data['meta'];
$this->assertArrayHasKey( 'test_string', $meta );
$this->assertIsString( $meta['test_string'] );
$this->assertSame( '42', $meta['test_string'] );
$this->assertArrayHasKey( 'test_number', $meta );
$this->assertIsFloat( $meta['test_number'] );
$this->assertSame( 42.0, $meta['test_number'] );
$this->assertArrayHasKey( 'test_bool', $meta );
$this->assertIsBool( $meta['test_bool'] );
$this->assertTrue( $meta['test_bool'] );
}
public function test_get_value_custom_name() {
add_term_meta( self::$category_id, 'test_custom_name', 'janet' );
$request = new WP_REST_Request( 'GET', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
$response = rest_get_server()->dispatch( $request );
$this->assertSame( 200, $response->get_status() );
$data = $response->get_data();
$this->assertArrayHasKey( 'meta', $data );
$meta = (array) $data['meta'];
$this->assertArrayHasKey( 'new_name', $meta );
$this->assertSame( 'janet', $meta['new_name'] );
}
/**
* @depends test_get_value
*/
public function test_set_value() {
// Ensure no data exists currently.
$values = get_term_meta( self::$category_id, 'test_single', false );
$this->assertEmpty( $values );
$this->grant_write_permission();
$data = array(
'meta' => array(
'test_single' => 'test_value',
),
);
$request = new WP_REST_Request( 'POST', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
$request->set_body_params( $data );
$response = rest_get_server()->dispatch( $request );
$this->assertSame( 200, $response->get_status() );
$meta = get_term_meta( self::$category_id, 'test_single', false );
$this->assertNotEmpty( $meta );
$this->assertCount( 1, $meta );
$this->assertSame( 'test_value', $meta[0] );
$data = $response->get_data();
$meta = (array) $data['meta'];
$this->assertArrayHasKey( 'test_single', $meta );
$this->assertSame( 'test_value', $meta['test_single'] );
}
/**
* @depends test_get_value
*/
public function test_set_duplicate_single_value() {
// Start with an existing metakey and value.
$values = update_term_meta( self::$category_id, 'test_single', 'test_value' );
$this->assertSame( 'test_value', get_term_meta( self::$category_id, 'test_single', true ) );
$this->grant_write_permission();
$data = array(
'meta' => array(
'test_single' => 'test_value',
),
);
$request = new WP_REST_Request( 'POST', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
$request->set_body_params( $data );
$response = rest_get_server()->dispatch( $request );
$this->assertSame( 200, $response->get_status() );
$meta = get_term_meta( self::$category_id, 'test_single', true );
$this->assertNotEmpty( $meta );
$this->assertSame( 'test_value', $meta );
$data = $response->get_data();
$meta = (array) $data['meta'];
$this->assertArrayHasKey( 'test_single', $meta );
$this->assertSame( 'test_value', $meta['test_single'] );
}
/**
* @depends test_set_value
*/
public function test_set_value_unauthenticated() {
$data = array(
'meta' => array(
'test_single' => 'test_value',
),
);
wp_set_current_user( 0 );
$request = new WP_REST_Request( 'POST', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
$request->set_body_params( $data );
$response = rest_get_server()->dispatch( $request );
$this->assertErrorResponse( 'rest_cannot_update', $response, 401 );
// Check that the value wasn't actually updated.
$this->assertEmpty( get_term_meta( self::$category_id, 'test_single', false ) );
}
/**
* @depends test_set_value
*/
public function test_set_value_blocked() {
$data = array(
'meta' => array(
'test_bad_auth' => 'test_value',
),
);
$this->grant_write_permission();
$request = new WP_REST_Request( 'POST', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
$request->set_body_params( $data );
$response = rest_get_server()->dispatch( $request );
$this->assertErrorResponse( 'rest_cannot_update', $response, 403 );
$this->assertEmpty( get_term_meta( self::$category_id, 'test_bad_auth', false ) );
}
/**
* @depends test_set_value
*/
public function test_set_value_db_error() {
$data = array(
'meta' => array(
'test_single' => 'test_value',
),
);
$this->grant_write_permission();
$request = new WP_REST_Request( 'POST', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
$request->set_body_params( $data );
/**
* Disable showing error as the below is going to intentionally
* trigger a DB error.
*/
global $wpdb;
$wpdb->suppress_errors = true;
add_filter( 'query', array( $this, 'error_insert_query' ) );
$response = rest_get_server()->dispatch( $request );
remove_filter( 'query', array( $this, 'error_insert_query' ) );
$wpdb->show_errors = true;
$this->assertErrorResponse( 'rest_meta_database_error', $response, 500 );
}
public function test_set_value_invalid_type() {
$values = get_term_meta( self::$category_id, 'test_invalid_type', false );
$this->assertEmpty( $values );
$this->grant_write_permission();
$data = array(
'meta' => array(
'test_invalid_type' => 'test_value',
),
);
$request = new WP_REST_Request( 'POST', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
$request->set_body_params( $data );
$response = rest_get_server()->dispatch( $request );
$this->assertEmpty( get_term_meta( self::$category_id, 'test_invalid_type', false ) );
}
public function test_set_value_multiple() {
// Ensure no data exists currently.
$values = get_term_meta( self::$category_id, 'test_multi', false );
$this->assertEmpty( $values );
$this->grant_write_permission();
$data = array(
'meta' => array(
'test_multi' => array( 'val1' ),
),
);
$request = new WP_REST_Request( 'POST', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
$request->set_body_params( $data );
$response = rest_get_server()->dispatch( $request );
$this->assertSame( 200, $response->get_status() );
$meta = get_term_meta( self::$category_id, 'test_multi', false );
$this->assertNotEmpty( $meta );
$this->assertCount( 1, $meta );
$this->assertSame( 'val1', $meta[0] );
// Add another value.
$data = array(
'meta' => array(
'test_multi' => array( 'val1', 'val2' ),
),
);
$request->set_body_params( $data );
$response = rest_get_server()->dispatch( $request );
$this->assertSame( 200, $response->get_status() );
$meta = get_term_meta( self::$category_id, 'test_multi', false );
$this->assertNotEmpty( $meta );
$this->assertCount( 2, $meta );
$this->assertContains( 'val1', $meta );
$this->assertContains( 'val2', $meta );
}
/**
* Test removing only one item with duplicate items.
*/
public function test_set_value_remove_one() {
add_term_meta( self::$category_id, 'test_multi', 'c' );
add_term_meta( self::$category_id, 'test_multi', 'n' );
add_term_meta( self::$category_id, 'test_multi', 'n' );
$this->grant_write_permission();
$data = array(
'meta' => array(
'test_multi' => array( 'c', 'n' ),
),
);
$request = new WP_REST_Request( 'POST', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
$request->set_body_params( $data );
$response = rest_get_server()->dispatch( $request );
$this->assertSame( 200, $response->get_status() );
$meta = get_term_meta( self::$category_id, 'test_multi', false );
$this->assertNotEmpty( $meta );
$this->assertCount( 2, $meta );
$this->assertContains( 'c', $meta );
$this->assertContains( 'n', $meta );
}
/**
* @depends test_set_value_multiple
*/
public function test_set_value_multiple_unauthenticated() {
// Ensure no data exists currently.
$values = get_term_meta( self::$category_id, 'test_multi', false );
$this->assertEmpty( $values );
wp_set_current_user( 0 );
$data = array(
'meta' => array(
'test_multi' => array( 'val1' ),
),
);
$request = new WP_REST_Request( 'POST', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
$request->set_body_params( $data );
$response = rest_get_server()->dispatch( $request );
$this->assertErrorResponse( 'rest_cannot_update', $response, 401 );
$meta = get_term_meta( self::$category_id, 'test_multi', false );
$this->assertEmpty( $meta );
}
public function test_set_value_invalid_value() {
register_meta(
'term',
'my_meta_key',
array(
'show_in_rest' => true,
'single' => true,
'type' => 'string',
)
);
$this->grant_write_permission();
$data = array(
'meta' => array(
'my_meta_key' => array( 'c', 'n' ),
),
);
$request = new WP_REST_Request( 'POST', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
$request->set_body_params( $data );
$response = rest_get_server()->dispatch( $request );
$this->assertErrorResponse( 'rest_invalid_type', $response, 400 );
}
public function test_set_value_invalid_value_multiple() {
register_meta(
'term',
'my_meta_key',
array(
'show_in_rest' => true,
'single' => false,
'type' => 'string',
)
);
$this->grant_write_permission();
$data = array(
'meta' => array(
'my_meta_key' => array( array( 'a' ) ),
),
);
$request = new WP_REST_Request( 'POST', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
$request->set_body_params( $data );
$response = rest_get_server()->dispatch( $request );
$this->assertErrorResponse( 'rest_invalid_type', $response, 400 );
}
public function test_set_value_sanitized() {
register_meta(
'term',
'my_meta_key',
array(
'show_in_rest' => true,
'single' => true,
'type' => 'integer',
)
);
$this->grant_write_permission();
$data = array(
'meta' => array(
'my_meta_key' => '1', // Set to a string.
),
);
$request = new WP_REST_Request( 'POST', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
$request->set_body_params( $data );
$response = rest_get_server()->dispatch( $request );
$data = $response->get_data();
$this->assertSame( 1, $data['meta']['my_meta_key'] );
}
public function test_set_value_csv() {
register_meta(
'term',
'my_meta_key',
array(
'show_in_rest' => true,
'single' => false,
'type' => 'integer',
)
);
$this->grant_write_permission();
$data = array(
'meta' => array(
'my_meta_key' => '1,2,3', // Set to a string.
),
);
$request = new WP_REST_Request( 'POST', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
$request->set_body_params( $data );
$response = rest_get_server()->dispatch( $request );
$data = $response->get_data();
$this->assertSame( array( 1, 2, 3 ), $data['meta']['my_meta_key'] );
}
/**
* @depends test_set_value_multiple
*/
public function test_set_value_multiple_blocked() {
$data = array(
'meta' => array(
'test_bad_auth_multi' => array( 'test_value' ),
),
);
$this->grant_write_permission();
$request = new WP_REST_Request( 'POST', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
$request->set_body_params( $data );
$response = rest_get_server()->dispatch( $request );
$this->assertErrorResponse( 'rest_cannot_update', $response, 403 );
$this->assertEmpty( get_term_meta( self::$category_id, 'test_bad_auth_multi', false ) );
}
public function test_add_multi_value_db_error() {
// Ensure no data exists currently.
$values = get_term_meta( self::$category_id, 'test_multi', false );
$this->assertEmpty( $values );
$this->grant_write_permission();
$data = array(
'meta' => array(
'test_multi' => array( 'val1' ),
),
);
$request = new WP_REST_Request( 'POST', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
$request->set_body_params( $data );
/**
* Disable showing error as the below is going to intentionally
* trigger a DB error.
*/
global $wpdb;
$wpdb->suppress_errors = true;
add_filter( 'query', array( $this, 'error_insert_query' ) );
$response = rest_get_server()->dispatch( $request );
remove_filter( 'query', array( $this, 'error_insert_query' ) );
$wpdb->show_errors = true;
$this->assertErrorResponse( 'rest_meta_database_error', $response, 500 );
}
/**
* @depends test_get_value
*/
public function test_set_value_single_custom_schema() {
// Ensure no data exists currently.
$values = get_term_meta( self::$category_id, 'test_custom_schema', false );
$this->assertEmpty( $values );
$this->grant_write_permission();
$data = array(
'meta' => array(
'test_custom_schema' => 3,
),
);
$request = new WP_REST_Request( 'POST', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
$request->set_body_params( $data );
$response = rest_get_server()->dispatch( $request );
$this->assertSame( 200, $response->get_status() );
$meta = get_term_meta( self::$category_id, 'test_custom_schema', false );
$this->assertNotEmpty( $meta );
$this->assertCount( 1, $meta );
$this->assertEquals( 3, $meta[0] );
$data = $response->get_data();
$meta = (array) $data['meta'];
$this->assertArrayHasKey( 'test_custom_schema', $meta );
$this->assertEquals( 3, $meta['test_custom_schema'] );
}
public function test_set_value_multiple_custom_schema() {
// Ensure no data exists currently.
$values = get_term_meta( self::$category_id, 'test_custom_schema_multi', false );
$this->assertEmpty( $values );
$this->grant_write_permission();
$data = array(
'meta' => array(
'test_custom_schema_multi' => array( 2 ),
),
);
$request = new WP_REST_Request( 'POST', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
$request->set_body_params( $data );
$response = rest_get_server()->dispatch( $request );
$this->assertSame( 200, $response->get_status() );
$meta = get_term_meta( self::$category_id, 'test_custom_schema_multi', false );
$this->assertNotEmpty( $meta );
$this->assertCount( 1, $meta );
$this->assertEquals( 2, $meta[0] );
// Add another value.
$data = array(
'meta' => array(
'test_custom_schema_multi' => array( 2, 8 ),
),
);
$request->set_body_params( $data );
$response = rest_get_server()->dispatch( $request );
$this->assertSame( 200, $response->get_status() );
$meta = get_term_meta( self::$category_id, 'test_custom_schema_multi', false );
$this->assertNotEmpty( $meta );
$this->assertCount( 2, $meta );
$this->assertContains( '2', $meta );
$this->assertContains( '8', $meta );
}
/**
* @depends test_get_value_custom_name
*/
public function test_set_value_custom_name() {
// Ensure no data exists currently.
$values = get_term_meta( self::$category_id, 'test_custom_name', false );
$this->assertEmpty( $values );
$this->grant_write_permission();
$data = array(
'meta' => array(
'new_name' => 'janet',
),
);
$request = new WP_REST_Request( 'POST', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
$request->set_body_params( $data );
$response = rest_get_server()->dispatch( $request );
$this->assertSame( 200, $response->get_status() );
$meta = get_term_meta( self::$category_id, 'test_custom_name', false );
$this->assertNotEmpty( $meta );
$this->assertCount( 1, $meta );
$this->assertSame( 'janet', $meta[0] );
$data = $response->get_data();
$meta = (array) $data['meta'];
$this->assertArrayHasKey( 'new_name', $meta );
$this->assertSame( 'janet', $meta['new_name'] );
}
public function test_set_value_custom_name_multiple() {
// Ensure no data exists currently.
$values = get_term_meta( self::$category_id, 'test_custom_name_multi', false );
$this->assertEmpty( $values );
$this->grant_write_permission();
$data = array(
'meta' => array(
'new_name_multi' => array( 'janet' ),
),
);
$request = new WP_REST_Request( 'POST', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
$request->set_body_params( $data );
$response = rest_get_server()->dispatch( $request );
$this->assertSame( 200, $response->get_status() );
$meta = get_term_meta( self::$category_id, 'test_custom_name_multi', false );
$this->assertNotEmpty( $meta );
$this->assertCount( 1, $meta );
$this->assertSame( 'janet', $meta[0] );
// Add another value.
$data = array(
'meta' => array(
'new_name_multi' => array( 'janet', 'graeme' ),
),
);
$request->set_body_params( $data );
$response = rest_get_server()->dispatch( $request );
$this->assertSame( 200, $response->get_status() );
$meta = get_term_meta( self::$category_id, 'test_custom_name_multi', false );
$this->assertNotEmpty( $meta );
$this->assertCount( 2, $meta );
$this->assertContains( 'janet', $meta );
$this->assertContains( 'graeme', $meta );
}
/**
* @ticket 38989
*/
public function test_set_value_invalid_meta_string_request_type() {
update_term_meta( self::$category_id, 'test_single', 'So I tied an onion to my belt, which was the style at the time.' );
$term_original = get_term( self::$category_id );
$this->grant_write_permission();
$data = array(
'name' => 'Ignore this name',
'meta' => 'Not an array.',
);
$request = new WP_REST_Request( 'POST', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
$request->set_body_params( $data );
$response = rest_get_server()->dispatch( $request );
$this->assertErrorResponse( 'rest_invalid_param', $response, 400 );
// The meta value should not have changed.
$current_value = get_term_meta( self::$category_id, 'test_single', true );
$this->assertSame( 'So I tied an onion to my belt, which was the style at the time.', $current_value );
// Ensure the term name update was not processed.
$term_updated = get_term( self::$category_id );
$this->assertSame( $term_original->name, $term_updated->name );
}
/**
* @ticket 38989
*/
public function test_set_value_invalid_meta_float_request_type() {
update_term_meta( self::$category_id, 'test_single', 'Now, to take the ferry cost a nickel, and in those days, nickels had pictures of bumblebees on them.' );
$term_original = get_term( self::$category_id );
$this->grant_write_permission();
$data = array(
'name' => 'Ignore this name',
'meta' => 1.234,
);
$request = new WP_REST_Request( 'POST', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
$request->set_body_params( $data );
$response = rest_get_server()->dispatch( $request );
$this->assertErrorResponse( 'rest_invalid_param', $response, 400 );
// The meta value should not have changed.
$current_value = get_term_meta( self::$category_id, 'test_single', true );
$this->assertSame( 'Now, to take the ferry cost a nickel, and in those days, nickels had pictures of bumblebees on them.', $current_value );
// Ensure the term name update was not processed.
$term_updated = get_term( self::$category_id );
$this->assertSame( $term_original->name, $term_updated->name );
}
public function test_remove_multi_value_db_error() {
add_term_meta( self::$category_id, 'test_multi', 'val1' );
$values = get_term_meta( self::$category_id, 'test_multi', false );
$this->assertSame( array( 'val1' ), $values );
$this->grant_write_permission();
$data = array(
'meta' => array(
'test_multi' => array(),
),
);
$request = new WP_REST_Request( 'POST', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
$request->set_body_params( $data );
/**
* Disable showing error as the below is going to intentionally
* trigger a DB error.
*/
global $wpdb;
$wpdb->suppress_errors = true;
add_filter( 'query', array( $this, 'error_delete_query' ) );
$response = rest_get_server()->dispatch( $request );
remove_filter( 'query', array( $this, 'error_delete_query' ) );
$wpdb->show_errors = true;
$this->assertErrorResponse( 'rest_meta_database_error', $response, 500 );
}
public function test_delete_value() {
add_term_meta( self::$category_id, 'test_single', 'val1' );
$current = get_term_meta( self::$category_id, 'test_single', true );
$this->assertSame( 'val1', $current );
$this->grant_write_permission();
$data = array(
'meta' => array(
'test_single' => null,
),
);
$request = new WP_REST_Request( 'POST', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
$request->set_body_params( $data );
$response = rest_get_server()->dispatch( $request );
$this->assertSame( 200, $response->get_status() );
$meta = get_term_meta( self::$category_id, 'test_single', false );
$this->assertEmpty( $meta );
}
/**
* @depends test_delete_value
*/
public function test_delete_value_blocked() {
add_term_meta( self::$category_id, 'test_bad_auth', 'val1' );
$current = get_term_meta( self::$category_id, 'test_bad_auth', true );
$this->assertSame( 'val1', $current );
$this->grant_write_permission();
$data = array(
'meta' => array(
'test_bad_auth' => null,
),
);
$request = new WP_REST_Request( 'POST', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
$request->set_body_params( $data );
$response = rest_get_server()->dispatch( $request );
$this->assertErrorResponse( 'rest_cannot_delete', $response, 403 );
$meta = get_term_meta( self::$category_id, 'test_bad_auth', true );
$this->assertSame( 'val1', $meta );
}
/**
* @depends test_delete_value
*/
public function test_delete_value_db_error() {
add_term_meta( self::$category_id, 'test_single', 'val1' );
$current = get_term_meta( self::$category_id, 'test_single', true );
$this->assertSame( 'val1', $current );
$this->grant_write_permission();
$data = array(
'meta' => array(
'test_single' => null,
),
);
$request = new WP_REST_Request( 'POST', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
$request->set_body_params( $data );
/**
* Disable showing error as the below is going to intentionally
* trigger a DB error.
*/
global $wpdb;
$wpdb->suppress_errors = true;
add_filter( 'query', array( $this, 'error_delete_query' ) );
$response = rest_get_server()->dispatch( $request );
remove_filter( 'query', array( $this, 'error_delete_query' ) );
$wpdb->show_errors = true;
$this->assertErrorResponse( 'rest_meta_database_error', $response, 500 );
}
public function test_delete_value_custom_name() {
add_term_meta( self::$category_id, 'test_custom_name', 'janet' );
$current = get_term_meta( self::$category_id, 'test_custom_name', true );
$this->assertSame( 'janet', $current );
$this->grant_write_permission();
$data = array(
'meta' => array(
'new_name' => null,
),
);
$request = new WP_REST_Request( 'POST', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
$request->set_body_params( $data );
$response = rest_get_server()->dispatch( $request );
$this->assertSame( 200, $response->get_status() );
$meta = get_term_meta( self::$category_id, 'test_custom_name', false );
$this->assertEmpty( $meta );
}
public function test_get_schema() {
$request = new WP_REST_Request( 'OPTIONS', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
$response = rest_get_server()->dispatch( $request );
$data = $response->get_data();
$schema = $data['schema'];
$this->assertArrayHasKey( 'meta', $schema['properties'] );
$meta_schema = $schema['properties']['meta']['properties'];
$this->assertArrayHasKey( 'test_single', $meta_schema );
$this->assertSame( 'string', $meta_schema['test_single']['type'] );
$this->assertArrayHasKey( 'test_multi', $meta_schema );
$this->assertSame( 'array', $meta_schema['test_multi']['type'] );
$this->assertArrayHasKey( 'items', $meta_schema['test_multi'] );
$this->assertSame( 'string', $meta_schema['test_multi']['items']['type'] );
$this->assertArrayHasKey( 'test_custom_schema', $meta_schema );
$this->assertSame( 'number', $meta_schema['test_custom_schema']['type'] );
$this->assertArrayNotHasKey( 'test_no_rest', $meta_schema );
$this->assertArrayNotHasKey( 'test_rest_disabled', $meta_schema );
$this->assertArrayNotHasKey( 'test_invalid_type', $meta_schema );
$this->assertArrayNotHasKey( 'test_no_type', $meta_schema );
}
/**
* @ticket 38323
* @dataProvider data_get_subtype_meta_value
*/
public function test_get_subtype_meta_value( $taxonomy, $meta_key, $single, $in_taxonomy ) {
$term_id = self::$category_id;
$endpoint = 'categories';
if ( 'customtax' === $taxonomy ) {
$term_id = self::$customtax_term_id;
$endpoint = 'customtax';
}
$meta_value = 'testvalue';
add_term_meta( $term_id, $meta_key, $meta_value );
$request = new WP_REST_Request( 'GET', sprintf( '/wp/v2/%s/%d', $endpoint, $term_id ) );
$response = rest_get_server()->dispatch( $request );
$this->assertSame( 200, $response->get_status() );
$data = $response->get_data();
$this->assertArrayHasKey( 'meta', $data );
$this->assertIsArray( $data['meta'] );
if ( $in_taxonomy ) {
$expected_value = $meta_value;
if ( ! $single ) {
$expected_value = array( $expected_value );
}
$this->assertArrayHasKey( $meta_key, $data['meta'] );
$this->assertSame( $expected_value, $data['meta'][ $meta_key ] );
} else {
$this->assertArrayNotHasKey( $meta_key, $data['meta'] );
}
}
public function data_get_subtype_meta_value() {
return array(
array( 'customtax', 'test_customtax_single', true, true ),
array( 'customtax', 'test_customtax_multi', false, true ),
array( 'customtax', 'test_single', true, true ),
array( 'customtax', 'test_multi', false, true ),
array( 'category', 'test_customtax_single', true, false ),
array( 'category', 'test_customtax_multi', false, false ),
array( 'category', 'test_single', true, true ),
array( 'category', 'test_multi', false, true ),
);
}
/**
* @ticket 38323
* @dataProvider data_set_subtype_meta_value
*/
public function test_set_subtype_meta_value( $taxonomy, $meta_key, $single, $in_taxonomy, $can_write ) {
$term_id = self::$category_id;
$endpoint = 'categories';
if ( 'customtax' === $taxonomy ) {
$term_id = self::$customtax_term_id;
$endpoint = 'customtax';
}
$meta_value = 'value_to_set';
$this->grant_write_permission();
$request = new WP_REST_Request( 'POST', sprintf( '/wp/v2/%s/%d', $endpoint, $term_id ) );
$request->set_body_params(
array(
'meta' => array(
$meta_key => $meta_value,
),
)
);
$response = rest_get_server()->dispatch( $request );
if ( ! $can_write ) {
$this->assertSame( 403, $response->get_status() );
$this->assertEmpty( get_term_meta( $term_id, $meta_key, $single ) );
return;
}
$this->assertSame( 200, $response->get_status() );
$data = $response->get_data();
$this->assertArrayHasKey( 'meta', $data );
$this->assertIsArray( $data['meta'] );
if ( $in_taxonomy ) {
$expected_value = $meta_value;
if ( ! $single ) {
$expected_value = array( $expected_value );
}
$this->assertSame( $expected_value, get_term_meta( $term_id, $meta_key, $single ) );
$this->assertArrayHasKey( $meta_key, $data['meta'] );
$this->assertSame( $expected_value, $data['meta'][ $meta_key ] );
} else {
$this->assertEmpty( get_term_meta( $term_id, $meta_key, $single ) );
$this->assertArrayNotHasKey( $meta_key, $data['meta'] );
}
}
public function data_set_subtype_meta_value() {
$data = $this->data_get_subtype_meta_value();
foreach ( $data as $index => $dataset ) {
$can_write = true;
// This combination is not writable because of an auth callback of '__return_false'.
if ( 'customtax' === $dataset[0] && 'test_single' === $dataset[1] ) {
$can_write = false;
}
$data[ $index ][] = $can_write;
}
return $data;
}
/**
* @ticket 43941
*/
public function test_get_default_value() {
$meta_key = 'registered_key1';
register_term_meta(
'category',
$meta_key,
array(
'single' => true,
'type' => 'string',
'default' => 'Goodbye',
'show_in_rest' => true,
)
);
// Check for default value.
$request = new WP_REST_Request( 'GET', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
$response = rest_get_server()->dispatch( $request );
$this->assertSame( 200, $response->get_status() );
$data = $response->get_data();
$this->assertArrayHasKey( 'meta', $data );
$meta = (array) $data['meta'];
$this->assertArrayHasKey( $meta_key, $meta );
$this->assertSame( 'Goodbye', $meta[ $meta_key ] );
}
/**
* @ticket 53099
*/
public function test_get_term_metadata_returning_false_does_not_cause_php_warnings() {
add_filter( 'get_term_metadata', '__return_false', 11 );
// No PHP warning during GET request.
add_term_meta( self::$category_id, 'test_single', 'testvalue' );
$request = new WP_REST_Request( 'GET', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
$response = rest_get_server()->dispatch( $request );
// No PHP warning during POST request.
$this->grant_write_permission();
$data = array(
'meta' => array(
'test_multi' => array( 'val1' ),
),
);
$request = new WP_REST_Request( 'POST', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
$request->set_body_params( $data );
$response = rest_get_server()->dispatch( $request );
// No PHP warning during validation.
register_meta(
'term',
'my_meta_key',
array(
'show_in_rest' => true,
'single' => true,
'type' => 'integer',
)
);
$this->grant_write_permission();
$data = array(
'meta' => array(
'my_meta_key' => '1', // Set to a string.
),
);
$request = new WP_REST_Request( 'POST', sprintf( '/wp/v2/categories/%d', self::$category_id ) );
$request->set_body_params( $data );
$response = rest_get_server()->dispatch( $request );
remove_filter( 'get_term_metadata', '__return_false', 11 );
$data = $response->get_data();
$this->assertSame( 0, $data['meta']['my_meta_key'] );
}
/**
* Internal function used to disable an insert query which
* will trigger a wpdb error for testing purposes.
*/
public function error_insert_query( $query ) {
if ( strpos( $query, 'INSERT' ) === 0 ) {
$query = '],';
}
return $query;
}
/**
* Internal function used to disable an insert query which
* will trigger a wpdb error for testing purposes.
*/
public function error_delete_query( $query ) {
if ( strpos( $query, 'DELETE' ) === 0 ) {
$query = '],';
}
return $query;
}
}