Changeset 49088

Timestamp:

10/02/2020 05:45:49 PM (4 years ago)

Author:

TimothyBlynJacobs

Message:

REST API: Allow for string ids in the search controller.

Previously, the search controller infrastructure required that the id property was an integer. This prevents data models that use a string id from utilizing the search infrastructure.

This commit lifts the restraint that search handlers return integer ids. This will allow for the Post Formats search handler coming in 5.6 to use slugs instead of creating fake ids.

Props stoyangeorgiev.
Fixes #51131.

Location:

trunk/src/wp-includes/rest-api

Files:

• endpoints/class-wp-rest-search-controller.php (modified) (3 diffs)
• search/class-wp-rest-search-handler.php (modified) (2 diffs)

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

@@ -141 +141 @@
         }
 
-        $ids = array_map( 'absint', $result[ WP_REST_Search_Handler::RESULT_IDS ] );
+        $ids = $result[ WP_REST_Search_Handler::RESULT_IDS ];
 
         $results = array();
@@ -187 +187 @@
      * @since 5.0.0
      *
-     * @param int             $id      ID of the item to prepare.
+     * @param int|string      $id      ID of the item to prepare.
      * @param WP_REST_Request $request Request object.
      * @return WP_REST_Response Response object.
@@ -246 +246 @@
                 self::PROP_ID      => array(
                     'description' => __( 'Unique identifier for the object.' ),
-                    'type'        => 'integer',
+                    'type'        => array( 'integer', 'string' ),
                     'context'     => array( 'view', 'embed' ),
                     'readonly'    => true,

trunk/src/wp-includes/rest-api/search/class-wp-rest-search-handler.php

@@ -80 +80 @@
      * @since 5.0.0
      *
-     * @param int   $id     Item ID.
-     * @param array $fields Fields to include for the item.
+     * @param int|string $id     Item ID.
+     * @param array      $fields Fields to include for the item.
      * @return array Associative array containing all fields for the item.
      */
@@ -91 +91 @@
      * @since 5.0.0
      *
-     * @param int $id Item ID.
+     * @param int|string $id Item ID.
      * @return array Links for the given item.
      */