mirror of
https://github.com/gosticks/wordpress-develop.git
synced 2025-10-16 12:05:38 +00:00
3ffefccdf2
A `null` value is returned in the response for any option that has a non-scalar value. To protect clients from accidentally including the `null` values from a response object in a request, we do not allow options with non-scalar values to be updated to `null`. Without this added protection a client could mistakenly delete all options that have non-scalar values from the database. Props joehoyle, rachelbaker. Fixes #38527. git-svn-id: https://develop.svn.wordpress.org/trunk@38982 602fd350-edb4-49c9-b593-d223f7449a82
322 lines
10 KiB
PHP
322 lines
10 KiB
PHP
<?php
|
|
/**
|
|
* Unit tests covering WP_Test_REST_Settings_Controller functionality.
|
|
*
|
|
* @package WordPress
|
|
* @subpackage REST API
|
|
*/
|
|
|
|
/**
|
|
* @group restapi
|
|
*/
|
|
class WP_Test_REST_Settings_Controller extends WP_Test_REST_Controller_Testcase {
|
|
protected static $administrator;
|
|
|
|
public static function wpSetUpBeforeClass( $factory ) {
|
|
self::$administrator = $factory->user->create( array(
|
|
'role' => 'administrator',
|
|
) );
|
|
}
|
|
|
|
public static function wpTearDownAfterClass() {
|
|
self::delete_user( self::$administrator );
|
|
}
|
|
|
|
public function setUp() {
|
|
parent::setUp();
|
|
$this->endpoint = new WP_REST_Settings_Controller();
|
|
}
|
|
|
|
public function test_register_routes() {
|
|
$routes = $this->server->get_routes();
|
|
$this->assertArrayHasKey( '/wp/v2/settings', $routes );
|
|
}
|
|
|
|
public function test_get_items() {
|
|
}
|
|
|
|
public function test_context_param() {
|
|
}
|
|
|
|
public function test_get_item_is_not_public() {
|
|
$request = new WP_REST_Request( 'GET', '/wp/v2/settings' );
|
|
$response = $this->server->dispatch( $request );
|
|
$this->assertEquals( 403, $response->get_status() );
|
|
}
|
|
|
|
public function test_get_item() {
|
|
wp_set_current_user( self::$administrator );
|
|
$request = new WP_REST_Request( 'GET', '/wp/v2/settings' );
|
|
$response = $this->server->dispatch( $request );
|
|
$data = $response->get_data();
|
|
|
|
$this->assertEquals( 200, $response->get_status() );
|
|
$this->assertEquals( array(
|
|
'title',
|
|
'description',
|
|
'url',
|
|
'email',
|
|
'timezone',
|
|
'date_format',
|
|
'time_format',
|
|
'start_of_week',
|
|
'language',
|
|
'use_smilies',
|
|
'default_category',
|
|
'default_post_format',
|
|
'posts_per_page',
|
|
'default_ping_status',
|
|
'default_comment_status',
|
|
), array_keys( $data ) );
|
|
}
|
|
|
|
public function test_get_item_value_is_cast_to_type() {
|
|
wp_set_current_user( self::$administrator );
|
|
update_option( 'posts_per_page', 'invalid_number' ); // this is cast to (int) 1
|
|
$request = new WP_REST_Request( 'GET', '/wp/v2/settings' );
|
|
$response = $this->server->dispatch( $request );
|
|
$data = $response->get_data();
|
|
|
|
$this->assertEquals( 200, $response->get_status() );
|
|
$this->assertEquals( 1, $data['posts_per_page'] );
|
|
}
|
|
|
|
public function test_get_item_with_custom_setting() {
|
|
wp_set_current_user( self::$administrator );
|
|
|
|
register_setting( 'somegroup', 'mycustomsetting', array(
|
|
'show_in_rest' => array(
|
|
'name' => 'mycustomsettinginrest',
|
|
'schema' => array(
|
|
'enum' => array( 'validvalue1', 'validvalue2' ),
|
|
'default' => 'validvalue1',
|
|
),
|
|
),
|
|
'type' => 'string',
|
|
) );
|
|
|
|
$request = new WP_REST_Request( 'GET', '/wp/v2/settings' );
|
|
$response = $this->server->dispatch( $request );
|
|
$data = $response->get_data();
|
|
|
|
$this->assertEquals( 200, $response->get_status() );
|
|
$this->assertArrayHasKey( 'mycustomsettinginrest', $data );
|
|
$this->assertEquals( 'validvalue1', $data['mycustomsettinginrest'] );
|
|
|
|
update_option( 'mycustomsetting', 'validvalue2' );
|
|
|
|
$request = new WP_REST_Request( 'GET', '/wp/v2/settings' );
|
|
$response = $this->server->dispatch( $request );
|
|
$data = $response->get_data();
|
|
$this->assertEquals( 'validvalue2', $data['mycustomsettinginrest'] );
|
|
|
|
unregister_setting( 'somegroup', 'mycustomsetting' );
|
|
}
|
|
|
|
public function get_setting_custom_callback( $result, $name, $args ) {
|
|
switch ( $name ) {
|
|
case 'mycustomsetting1':
|
|
return 'filtered1';
|
|
}
|
|
return $result;
|
|
}
|
|
|
|
public function test_get_item_with_filter() {
|
|
wp_set_current_user( self::$administrator );
|
|
|
|
add_filter( 'rest_pre_get_setting', array( $this, 'get_setting_custom_callback' ), 10, 3 );
|
|
|
|
register_setting( 'somegroup', 'mycustomsetting1', array(
|
|
'show_in_rest' => array(
|
|
'name' => 'mycustomsettinginrest1',
|
|
),
|
|
'type' => 'string',
|
|
) );
|
|
|
|
register_setting( 'somegroup', 'mycustomsetting2', array(
|
|
'show_in_rest' => array(
|
|
'name' => 'mycustomsettinginrest2',
|
|
),
|
|
'type' => 'string',
|
|
) );
|
|
|
|
update_option( 'mycustomsetting1', 'unfiltered1' );
|
|
update_option( 'mycustomsetting2', 'unfiltered2' );
|
|
|
|
$request = new WP_REST_Request( 'GET', '/wp/v2/settings' );
|
|
$response = $this->server->dispatch( $request );
|
|
$data = $response->get_data();
|
|
|
|
$this->assertEquals( 200, $response->get_status() );
|
|
|
|
$this->assertArrayHasKey( 'mycustomsettinginrest1', $data );
|
|
$this->assertEquals( 'unfiltered1', $data['mycustomsettinginrest1'] );
|
|
|
|
$this->assertArrayHasKey( 'mycustomsettinginrest2', $data );
|
|
$this->assertEquals( 'unfiltered2', $data['mycustomsettinginrest2'] );
|
|
|
|
unregister_setting( 'somegroup', 'mycustomsetting' );
|
|
remove_all_filters( 'rest_pre_get_setting' );
|
|
}
|
|
|
|
public function test_get_item_with_invalid_value_array_in_options() {
|
|
wp_set_current_user( self::$administrator );
|
|
|
|
register_setting( 'somegroup', 'mycustomsetting', array(
|
|
'show_in_rest' => array(
|
|
'name' => 'mycustomsettinginrest',
|
|
'schema' => array(
|
|
'enum' => array( 'validvalue1', 'validvalue2' ),
|
|
'default' => 'validvalue1',
|
|
),
|
|
),
|
|
'type' => 'string',
|
|
) );
|
|
|
|
update_option( 'mycustomsetting', array( 'A sneaky array!' ) );
|
|
|
|
$request = new WP_REST_Request( 'GET', '/wp/v2/settings' );
|
|
$response = $this->server->dispatch( $request );
|
|
$data = $response->get_data();
|
|
$this->assertEquals( null, $data['mycustomsettinginrest'] );
|
|
}
|
|
|
|
public function test_get_item_with_invalid_object_array_in_options() {
|
|
wp_set_current_user( self::$administrator );
|
|
|
|
register_setting( 'somegroup', 'mycustomsetting', array(
|
|
'show_in_rest' => array(
|
|
'name' => 'mycustomsettinginrest',
|
|
'schema' => array(
|
|
'enum' => array( 'validvalue1', 'validvalue2' ),
|
|
'default' => 'validvalue1',
|
|
),
|
|
),
|
|
'type' => 'string',
|
|
) );
|
|
|
|
update_option( 'mycustomsetting', (object) array( 'A sneaky array!' ) );
|
|
|
|
$request = new WP_REST_Request( 'GET', '/wp/v2/settings' );
|
|
$response = $this->server->dispatch( $request );
|
|
$data = $response->get_data();
|
|
$this->assertEquals( null, $data['mycustomsettinginrest'] );
|
|
}
|
|
|
|
|
|
public function test_create_item() {
|
|
}
|
|
|
|
public function test_update_item() {
|
|
wp_set_current_user( self::$administrator );
|
|
$request = new WP_REST_Request( 'PUT', '/wp/v2/settings' );
|
|
$request->set_param( 'title', 'The new title!' );
|
|
$response = $this->server->dispatch( $request );
|
|
$data = $response->get_data();
|
|
|
|
$this->assertEquals( 200, $response->get_status() );
|
|
$this->assertEquals( 'The new title!', $data['title'] );
|
|
$this->assertEquals( get_option( 'blogname' ), $data['title'] );
|
|
}
|
|
|
|
public function update_setting_custom_callback( $result, $name, $value, $args ) {
|
|
if ( 'title' === $name && 'The new title!' === $value ) {
|
|
// Do not allow changing the title in this case
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
public function test_update_item_with_filter() {
|
|
wp_set_current_user( self::$administrator );
|
|
|
|
$request = new WP_REST_Request( 'PUT', '/wp/v2/settings' );
|
|
$request->set_param( 'title', 'The old title!' );
|
|
$request->set_param( 'description', 'The old description!' );
|
|
$response = $this->server->dispatch( $request );
|
|
$data = $response->get_data();
|
|
$this->assertEquals( 200, $response->get_status() );
|
|
$this->assertEquals( 'The old title!', $data['title'] );
|
|
$this->assertEquals( 'The old description!', $data['description'] );
|
|
$this->assertEquals( get_option( 'blogname' ), $data['title'] );
|
|
$this->assertEquals( get_option( 'blogdescription' ), $data['description'] );
|
|
|
|
add_filter( 'rest_pre_update_setting', array( $this, 'update_setting_custom_callback' ), 10, 4 );
|
|
|
|
$request = new WP_REST_Request( 'PUT', '/wp/v2/settings' );
|
|
$request->set_param( 'title', 'The new title!' );
|
|
$request->set_param( 'description', 'The new description!' );
|
|
$response = $this->server->dispatch( $request );
|
|
$data = $response->get_data();
|
|
|
|
$this->assertEquals( 200, $response->get_status() );
|
|
$this->assertEquals( 'The old title!', $data['title'] );
|
|
$this->assertEquals( 'The new description!', $data['description'] );
|
|
$this->assertEquals( get_option( 'blogname' ), $data['title'] );
|
|
$this->assertEquals( get_option( 'blogdescription' ), $data['description'] );
|
|
|
|
remove_all_filters( 'rest_pre_update_setting' );
|
|
}
|
|
|
|
public function test_update_item_with_invalid_type() {
|
|
wp_set_current_user( self::$administrator );
|
|
$request = new WP_REST_Request( 'PUT', '/wp/v2/settings' );
|
|
$request->set_param( 'title', array( 'rendered' => 'This should fail.' ) );
|
|
$response = $this->server->dispatch( $request );
|
|
$this->assertErrorResponse( 'rest_invalid_param', $response, 400 );
|
|
}
|
|
|
|
/**
|
|
* Setting an item to "null" will essentially restore it to it's default value.
|
|
*/
|
|
public function test_update_item_with_null() {
|
|
update_option( 'posts_per_page', 9 );
|
|
|
|
wp_set_current_user( self::$administrator );
|
|
$request = new WP_REST_Request( 'PUT', '/wp/v2/settings' );
|
|
$request->set_param( 'posts_per_page', null );
|
|
$response = $this->server->dispatch( $request );
|
|
$data = $response->get_data();
|
|
|
|
$this->assertEquals( 200, $response->get_status() );
|
|
$this->assertEquals( 10, $data['posts_per_page'] );
|
|
}
|
|
|
|
public function test_update_item_with_invalid_enum() {
|
|
update_option( 'posts_per_page', 9 );
|
|
|
|
wp_set_current_user( self::$administrator );
|
|
$request = new WP_REST_Request( 'PUT', '/wp/v2/settings' );
|
|
$request->set_param( 'default_ping_status', 'open&closed' );
|
|
$response = $this->server->dispatch( $request );
|
|
$this->assertErrorResponse( 'rest_invalid_param', $response, 400 );
|
|
}
|
|
|
|
public function test_update_item_with_invalid_stored_value_in_options() {
|
|
wp_set_current_user( self::$administrator );
|
|
|
|
register_setting( 'somegroup', 'mycustomsetting', array(
|
|
'show_in_rest' => true,
|
|
'type' => 'string',
|
|
) );
|
|
update_option( 'mycustomsetting', array( 'A sneaky array!' ) );
|
|
|
|
wp_set_current_user( self::$administrator );
|
|
$request = new WP_REST_Request( 'PUT', '/wp/v2/settings' );
|
|
$request->set_param( 'mycustomsetting', null );
|
|
$response = $this->server->dispatch( $request );
|
|
|
|
$this->assertErrorResponse( 'rest_invalid_stored_value', $response, 500 );
|
|
}
|
|
|
|
public function test_delete_item() {
|
|
}
|
|
|
|
public function test_prepare_item() {
|
|
}
|
|
|
|
public function test_get_item_schema() {
|
|
}
|
|
}
|