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

Timestamp:

02/11/2020 04:26:56 PM (6 years ago)

Author:

kadamwhite

Message:

REST API: Introduce rest_{$this->post_type}_item_schema filter to enable manipulation of schema values.

register_rest_field can be used to add properties to a schema, but no mechanism existed to alter existing properties like "content".
Running the schema through this filter lets plugins append additional sub-properties to existing schema definitions.

Props luisherranz, TimothyBlynJacobs, swissspidy, westonruter, kadamwhite.
Fixes #47779.

File:

• trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php (modified) (1 diff)

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

@@ -2407 +2407 @@
         }
 
+        // Take a snapshot of which fields are in the schema pre-filtering.
+        $schema_fields = array_keys( $schema['properties'] );
+
+        /**
+         * Filter the post's schema.
+         *
+         * The dynamic portion of the filter, `$this->post_type`, refers to the
+         * post type slug for the controller.
+         *
+         * @since 5.4.0
+         *
+         * @param array $schema Item schema data.
+         */
+        $schema = apply_filters( "rest_{$this->post_type}_item_schema", $schema );
+
+        // Emit a _doing_it_wrong warning if user tries to add new properties using this filter.
+        $new_fields = array_diff( array_keys( $schema['properties'] ), $schema_fields );
+        if ( count( $new_fields ) > 0 ) {
+            _doing_it_wrong( __METHOD__, __( 'Please use register_rest_field to add new schema properties.' ), '5.4.0' );
+        }
+
         $this->schema = $schema;