Changeset 53877 for trunk/src/wp-includes/rest-api/search/class-wp-rest-term-search-handler.php

Timestamp:

08/11/2022 02:01:35 PM (3 years ago)

Author:

johnbillion

Message:

Docs: Correct and improve the documented types for various functions and hooks.

See #55646

File:

• trunk/src/wp-includes/rest-api/search/class-wp-rest-term-search-handler.php (modified) (2 diffs)

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

@@ -42 +42 @@
      *
      * @param WP_REST_Request $request Full REST request.
-     * @return array Associative array containing an `WP_REST_Search_Handler::RESULT_IDS` containing
-     *               an array of found IDs and `WP_REST_Search_Handler::RESULT_TOTAL` containing the
-     *               total count for the matching search results.
+     * @return array {
+     *     Associative array containing found IDs and total count for the matching search results.
+     *
+     *     @type int[]               $ids   Found IDs.
+     *     @type string|int|WP_Error $total Numeric string containing the number of terms in that
+     *                                      taxonomy, 0 if there are no results, or WP_Error if
+     *                                      the requested taxonomy does not exist.
+     * }
      */
     public function search_items( WP_REST_Request $request ) {
@@ -133 +138 @@
      *
      * @param int $id Item ID.
-     * @return array Links for the given item.
+     * @return array[] Array of link arrays for the given item.
      */
     public function prepare_item_links( $id ) {