Changeset 52236 for trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-pattern-directory-controller.php

Timestamp:

11/23/2021 09:35:57 PM (3 years ago)

Author:

johnbillion

Message:

Docs: Various docblock corrections and improvements.

See #53399

File:

• trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-pattern-directory-controller.php (modified) (6 diffs)

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

@@ -52 +52 @@
 
     /**
-     * Checks whether a given request has permission to view the local pattern directory.
+     * Checks whether a given request has permission to view the local block pattern directory.
      *
      * @since 5.8.0
@@ -197 +197 @@
 
     /**
-     * Prepare a raw pattern before it's output in an API response.
+     * Prepare a raw block pattern before it gets output in a REST API response.
      *
      * @since 5.8.0
@@ -224 +224 @@
 
         /**
-         * Filters the REST API response for a pattern.
+         * Filters the REST API response for a block pattern.
          *
          * @since 5.8.0
          *
          * @param WP_REST_Response $response    The response object.
-         * @param object           $raw_pattern The unprepared pattern.
+         * @param object           $raw_pattern The unprepared block pattern.
          * @param WP_REST_Request  $request     The request object.
          */
@@ -236 +236 @@
 
     /**
-     * Retrieves the pattern's schema, conforming to JSON Schema.
+     * Retrieves the block pattern's schema, conforming to JSON Schema.
      *
      * @since 5.8.0
@@ -308 +308 @@
 
     /**
-     * Retrieves the search params for the patterns collection.
+     * Retrieves the search parameters for the block pattern's collection.
      *
      * @since 5.8.0
@@ -337 +337 @@
 
         /**
-         * Filter collection parameters for the pattern directory controller.
+         * Filter collection parameters for the block pattern directory controller.
          *
          * @since 5.8.0