Changeset 43980 for trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

Timestamp:

12/12/2018 02:11:22 AM (7 years ago)

Author:

jeremyfelt

Message:

REST API: Include permalink_template/generated_slug for Posts

In order for clients to present permalink previews, the REST API must share the computed results of get_sample_permalink(). These two values are now exposed as permalink_template and generated_slug for public, viewable post types, but only for context=edit.

Merges [43720] to trunk.

Props danielbachhuber, rahulsprajapati.
Fixes #45017.

Location:

trunk

Files:

• . (modified) (1 prop)
• src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php (modified) (2 diffs)

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

@@ -1588 +1588 @@
         }
 
+        $post_type_obj = get_post_type_object( $post->post_type );
+        if ( is_post_type_viewable( $post_type_obj ) && $post_type_obj->public ) {
+
+            if ( ! function_exists( 'get_sample_permalink' ) ) {
+                require_once ABSPATH . '/wp-admin/includes/post.php';
+            }
+
+            $sample_permalink = get_sample_permalink( $post->ID, $post->post_title, '' );
+
+            if ( in_array( 'permalink_template', $fields, true ) ) {
+                $data['permalink_template'] = $sample_permalink[0];
+            }
+            if ( in_array( 'generated_slug', $fields, true ) ) {
+                $data['generated_slug'] = $sample_permalink[1];
+            }
+        }
+
         $context = ! empty( $request['context'] ) ? $request['context'] : 'view';
         $data    = $this->add_additional_fields_to_object( $data, $request );
@@ -1919 +1936 @@
 
         $post_type_obj = get_post_type_object( $this->post_type );
+        if ( is_post_type_viewable( $post_type_obj ) && $post_type_obj->public ) {
+            $schema['properties']['permalink_template'] = array(
+                'description' => __( 'Permalink template for the object.' ),
+                'type'        => 'string',
+                'context'     => array( 'edit' ),
+                'readonly'    => true,
+            );
+
+            $schema['properties']['generated_slug'] = array(
+                'description' => __( 'Slug automatically generated from the object title.' ),
+                'type'        => 'string',
+                'context'     => array( 'edit' ),
+                'readonly'    => true,
+            );
+        }
 
         if ( $post_type_obj->hierarchical ) {