Experiment with registered settings #13

joehoyle · 2016-08-30T16:04:00Z

In https://core.trac.wordpress.org/ticket/37885 I have added a patch to
make the registered settings be imbued with more data for inclusion in
the REST API. This is a work in progress to see how the controller might
look for that.

In https://core.trac.wordpress.org/ticket/37885 I have added a patch to make the registered settings be imbued with more data for inclusion in the REST API. This is a work in progress to see how the controller might look for that.

this is until core implements is, hopefully!

joehoyle · 2016-09-14T18:46:01Z

Another round of changes:

Renamed to WP_REST_Settings_Controller along with the route moving to /settings per Maybe find a better name for /site/? #14.
We now make use of register_setting( ..., ..., array( 'show_in_rest' => array( ...rest options ) ) ) to pass options for the setting in the rest api.
We merge in values from the register_setting like description and type into the show_in_rest args.
Registering a setting in the API now looks like this:

register_setting( 'general', 'blogname', array(
    'show_in_rest'   => array(
        'name'            => 'title',
    ),
    'type'           => 'string',
    'description'    => __( 'Site title.' ),
) );

name is the property name of the setting in the rest api.

The response so far looks like this:

{
    "date_format": "F j, Y",
    "default_category": 1,
    "default_post_format": "0",
    "description": "Just another Fake Site site",
    "email": "[email protected]",
    "language": "en_US",
    "posts_per_page": 10,
    "start_of_week": 1,
    "time_format": "g:i a",
    "timezone": "",
    "title": "",
    "url": "http://wordpress.dev",
    "use_smilies": true
}

Updating a setting looks like this:

http POST http://wordpress.dev/wp-json/wp/v2/settings title="This is the new title"

Right now I'm registering core settings in this plugin, but ideally this would be moved to core. This all depends on buy-in from https://core.trac.wordpress.org/ticket/37885 of course.

joehoyle · 2016-09-14T18:47:43Z

Deleting Options

There's no way to "DELETE" an option from a REST API perspective, as an setting is part of the item schema and fixed, you can however "null" out a setting value which will essentially reset it back to the default. To do that, the client just has to set a setting to null.

joehoyle · 2016-09-14T19:09:43Z

Aside: the WordPress.com mobile app makes use of Site Title, Description and Site URL.

rmccue

Seems good to me, apart from some stylistic points here.

rmccue · 2016-09-14T19:06:52Z

lib/class-wp-rest-settings-controller.php

+class WP_REST_Settings_Controller extends WP_REST_Controller {
+	public function __construct() {
+		$this->namespace = 'wp/v2';
+		$this->rest_base = 'settings';


These should be moved to protected $namespace = '...' instead.

rmccue · 2016-09-14T19:07:02Z

lib/class-wp-rest-settings-controller.php

+				'methods'          => WP_REST_Server::READABLE,
+				'callback'         => array( $this, 'get_item' ),
+				'args'             => array(),
+				'permission_callback' => array( $this, 'get_item_permissions_check' ),


Alignment is off

rmccue · 2016-09-14T19:07:09Z

lib/class-wp-rest-settings-controller.php

+				'methods'          => WP_REST_Server::EDITABLE,
+				'callback'         => array( $this, 'update_item' ),
+				'args'             => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
+				'permission_callback' => array( $this, 'get_item_permissions_check' ),


rmccue · 2016-09-14T19:07:16Z

lib/class-wp-rest-settings-controller.php

+		) );
+	}
+
+	public function get_item_permissions_check( $request ) {


Needs phpDoc

rmccue · 2016-09-14T19:07:33Z

lib/class-wp-rest-settings-controller.php

+		$response = array();
+
+		foreach ( $options as $name => $args ) {
+			// default to a null value as "null" in the response means "not set"


Comments need to start with a capital and end with a period.

rmccue · 2016-09-14T19:11:08Z

plugin.php

 	$site_route->register_routes();
+}
+
+function rest_register_settings() {


Needs phpDoc

rmccue · 2016-09-14T19:11:16Z

plugin.php

+}
+
+function rest_register_settings() {
+	require_once ABSPATH . 'wp-admin/includes/plugin.php';


rmccue · 2016-09-14T19:12:02Z

plugin.php

+		),
+		'type'           => 'string',
+		'description'    => __( 'Site title.' ),
+	) );


The space here isn't necessary.

rmccue · 2016-09-14T19:12:15Z

plugin.php

+
+	register_setting( 'general', 'blogname', array(
+		'show_in_rest'   => array(
+			'name'            => 'title',


Alignment is off here (and below)

rmccue · 2016-09-14T19:13:45Z

plugin.php

+			'name'       => 'language',
+		),
+		'type'           => 'string',
+		'description'    => __( 'IETF "like" WordPress locale code.' ),


IETF-like should be hyphenated. I'd probably change this to WordPress locale code., no need to mention the spec, since it has to be from the defined list of WP-valid locales anyway.

rmccue · 2016-09-19T17:50:45Z

lib/class-wp-rest-settings-controller.php

+			}
+
+			$rest_args = array_merge( $rest_args, array(
+				'option_name' => $name,


This shouldn't be overridable, since the data is contained in the registration for the option itself.

joehoyle · 2016-09-19T19:02:45Z

Thanks for the review @rmccue, I'll wait on the outcome of register_setting on trac today before fixing this up as that might come with some extra work.

joehoyle · 2016-09-22T19:07:40Z

@rmccue ok patched up those and also added unit tests here.

rmccue · 2016-09-22T19:09:51Z

lib/class-wp-rest-settings-controller.php

+		$params = $request->get_params();
+
+		foreach ( $options as $name => $args ) {
+			if ( array_key_exists( $name, $params ) ) {


This should be flipped.

Fixed in dcacb38

rmccue · 2016-09-22T19:09:58Z

lib/class-wp-rest-settings-controller.php

+	 * @return WP_Error|array
+	 */
+	public function update_item( $request ) {
+		$options  = $this->get_registered_options();


Spacing is off.

Fixed in 5008108

joehoyle · 2016-09-22T21:02:26Z

Think we are looking good here @rmccue

danielbachhuber · 2016-09-22T21:03:51Z

lib/class-wp-rest-settings-controller.php

+	 * @param  string $type  Type that the data should be converted to.
+	 * @return mixed
+	 */
+	protected function cast_value_to_type( $value, $type ) {


Would this be a useful utility function somewhere else?

danielbachhuber · 2016-09-22T21:05:23Z

plugin.php

+
+	register_setting( 'general', 'WPLANG', array(
+		'show_in_rest' => array(
+			'name' => 'language',


Is a locale always a language?

danielbachhuber · 2016-09-22T21:06:05Z

This reads pretty well 👍 Left a couple small comments.

rmccue · 2016-09-22T23:05:07Z

Would this be a useful utility function somewhere else?

Let's split this into a new ticket.

Merged in from https://github.com/WP-API/wp-api-site-endpoints. The bulk of this comes from WP-API/wp-api-site-endpoints#13

joehoyle added 4 commits August 30, 2016 18:02

Experiment with registered settings

512d28c

In https://core.trac.wordpress.org/ticket/37885 I have added a patch to make the registered settings be imbued with more data for inclusion in the REST API. This is a work in progress to see how the controller might look for that.

Use registered settings via the show_in_rest options

b7640d7

Rename site controller to settings controller

c012917

Register default settings

002ff7f

this is until core implements is, hopefully!

rmccue reviewed Sep 14, 2016

View reviewed changes

kadamwhite mentioned this pull request Sep 15, 2016

Options Endpoint WP-API/WP-API#2673

Closed

rmccue suggested changes Sep 19, 2016

View reviewed changes

joehoyle added 10 commits September 22, 2016 10:29

Move to class properties, remove constrcutor()

0e6a79b

Comment formatting

e87b072

Split out casting loginc into it's own function

4da393e

Docblock for rest_register_settings()

5183965

Alignment fixes

af6f211

Fix order of class properties

a370913

Update variable name

36ec88e

Update tests

2ff0242

Fix merging the schema objects together.

913f71b

Only run the settings tests on 4.7+

11598ec

rmccue suggested changes Sep 22, 2016

View reviewed changes

joehoyle added 2 commits September 22, 2016 15:23

Fix spacing

5008108

continue early.

dcacb38

danielbachhuber reviewed Sep 22, 2016

View reviewed changes

rmccue approved these changes Sep 22, 2016

View reviewed changes

rmccue merged commit 18c14e4 into master Sep 22, 2016

rmccue deleted the register-setting-experiment branch September 22, 2016 23:04

rmccue mentioned this pull request Sep 22, 2016

Split type coercion into utility function #15

Open

joehoyle added a commit to WP-API/WP-API that referenced this pull request Sep 28, 2016

Initial Settings Endpoint

8dd4451

Merged in from https://github.com/WP-API/wp-api-site-endpoints. The bulk of this comes from WP-API/wp-api-site-endpoints#13

joehoyle mentioned this pull request Sep 28, 2016

Initial Settings Endpoint WP-API/WP-API#2739

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Experiment with registered settings #13

Experiment with registered settings #13

joehoyle commented Aug 30, 2016

joehoyle commented Sep 14, 2016 •

edited

Loading

joehoyle commented Sep 14, 2016

joehoyle commented Sep 14, 2016

rmccue left a comment

rmccue Sep 14, 2016

rmccue Sep 14, 2016

rmccue Sep 14, 2016

rmccue Sep 14, 2016

rmccue Sep 14, 2016

rmccue Sep 14, 2016

rmccue Sep 14, 2016

rmccue Sep 14, 2016

rmccue Sep 14, 2016

rmccue Sep 14, 2016

rmccue Sep 19, 2016

joehoyle commented Sep 19, 2016

joehoyle commented Sep 22, 2016

rmccue Sep 22, 2016

joehoyle Sep 22, 2016

rmccue Sep 22, 2016

joehoyle Sep 22, 2016

joehoyle commented Sep 22, 2016

danielbachhuber Sep 22, 2016

danielbachhuber Sep 22, 2016

danielbachhuber commented Sep 22, 2016

rmccue commented Sep 22, 2016

Experiment with registered settings #13

Experiment with registered settings #13

Conversation

joehoyle commented Aug 30, 2016

joehoyle commented Sep 14, 2016 • edited Loading

joehoyle commented Sep 14, 2016

Deleting Options

joehoyle commented Sep 14, 2016

rmccue left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joehoyle commented Sep 19, 2016

joehoyle commented Sep 22, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joehoyle commented Sep 22, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

danielbachhuber commented Sep 22, 2016

rmccue commented Sep 22, 2016

joehoyle commented Sep 14, 2016 •

edited

Loading