Changeset 46252 for trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-post-statuses-controller.php

Timestamp:

09/23/2019 05:39:36 PM (5 years ago)

Author:

kadamwhite

Message:

REST API: Introduce date_floating property on status endpoint response objects.

Expose a date_floating property on all status objects to permit clients (including the block editor) to make correct decisions about date handling for posts of varying status.

Props mnelson4, earnjam, kadamwhite, jnylen0, nerrad, pento.
See #39953.

File:

• trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-post-statuses-controller.php (modified) (8 diffs)

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-post-statuses-controller.php

@@ -233 +233 @@
         if ( in_array( 'slug', $fields, true ) ) {
             $data['slug'] = $status->name;
+        }
+
+        if ( in_array( 'date_floating', $fields, true ) ) {
+            $data['date_floating'] = $status->date_floating;
         }
 
@@ -278 +282 @@
             'type'       => 'object',
             'properties' => array(
-                'name'         => array(
+                'name'          => array(
                     'description' => __( 'The title for the status.' ),
                     'type'        => 'string',
@@ -284 +288 @@
                     'readonly'    => true,
                 ),
-                'private'      => array(
+                'private'       => array(
                     'description' => __( 'Whether posts with this status should be private.' ),
                     'type'        => 'boolean',
@@ -290 +294 @@
                     'readonly'    => true,
                 ),
-                'protected'    => array(
+                'protected'     => array(
                     'description' => __( 'Whether posts with this status should be protected.' ),
                     'type'        => 'boolean',
@@ -296 +300 @@
                     'readonly'    => true,
                 ),
-                'public'       => array(
+                'public'        => array(
                     'description' => __( 'Whether posts of this status should be shown in the front end of the site.' ),
                     'type'        => 'boolean',
@@ -302 +306 @@
                     'readonly'    => true,
                 ),
-                'queryable'    => array(
+                'queryable'     => array(
                     'description' => __( 'Whether posts with this status should be publicly-queryable.' ),
                     'type'        => 'boolean',
@@ -308 +312 @@
                     'readonly'    => true,
                 ),
-                'show_in_list' => array(
+                'show_in_list'  => array(
                     'description' => __( 'Whether to include posts in the edit listing for their post type.' ),
                     'type'        => 'boolean',
@@ -314 +318 @@
                     'readonly'    => true,
                 ),
-                'slug'         => array(
+                'slug'          => array(
                     'description' => __( 'An alphanumeric identifier for the status.' ),
                     'type'        => 'string',
                     'context'     => array( 'embed', 'view', 'edit' ),
+                    'readonly'    => true,
+                ),
+                'date_floating' => array(
+                    'description' => __( 'Whether posts of this status may have floating published dates.' ),
+                    'type'        => 'boolean',
+                    'context'     => array( 'view', 'edit' ),
                     'readonly'    => true,
                 ),