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

See #48303


git-svn-id: https://develop.svn.wordpress.org/trunk@46660 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
John Blackbourn
2019-11-05 21:21:46 +00:00
parent 63d4dcd10a
commit db4f746b4a
31 changed files with 177 additions and 119 deletions

View File

@@ -780,7 +780,7 @@ class WP_REST_Server {
*
* @since 4.4.0
*
* @return array List of registered namespaces.
* @return string[] List of registered namespaces.
*/
public function get_namespaces() {
return array_keys( $this->namespaces );
@@ -1017,7 +1017,7 @@ class WP_REST_Server {
*
* @type string $context Context.
* }
* @return array Index entity
* @return WP_REST_Response The API root index data.
*/
public function get_index( $request ) {
// General site data.
@@ -1100,7 +1100,7 @@ class WP_REST_Server {
*
* @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' ) {
$available = array();
@@ -1131,8 +1131,8 @@ class WP_REST_Server {
*
* @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 );
}