Changeset 46660 for trunk/src/wp-includes/rest-api/class-wp-rest-server.php

Timestamp:

11/05/2019 09:21:46 PM (5 years ago)

Author:

johnbillion

Message:

Docs: Improve documentation of known return types, plus other docs fixes.

See #48303

File:

• trunk/src/wp-includes/rest-api/class-wp-rest-server.php (modified) (4 diffs)

trunk/src/wp-includes/rest-api/class-wp-rest-server.php

@@ -781 +781 @@
      * @since 4.4.0
      *
-     * @return array List of registered namespaces.
+     * @return string[] List of registered namespaces.
      */
     public function get_namespaces() {
@@ -1018 +1018 @@
      *     @type string $context Context.
      * }
-     * @return array Index entity
+     * @return WP_REST_Response The API root index data.
      */
     public function get_index( $request ) {
@@ -1101 +1101 @@
      * @param array  $routes  Routes to get data for.
      * @param string $context Optional. Context for data. Accepts 'view' or 'help'. Default 'view'.
-     * @return array Route data to expose in indexes.
+     * @return array[] Route data to expose in indexes, keyed by route.
      */
     public function get_data_for_routes( $routes, $context = 'view' ) {
@@ -1132 +1132 @@
          * @since 4.4.0
          *
-         * @param array $available Map of route to route data.
-         * @param array $routes    Internal route data as an associative array.
+         * @param array[] $available Route data to expose in indexes, keyed by route.
+         * @param array   $routes    Internal route data as an associative array.
          */
         return apply_filters( 'rest_route_data', $available, $routes );