Changeset 55694 for trunk/src/wp-includes/block-template-utils.php

Timestamp:

04/27/2023 11:13:36 PM (2 years ago)

Author:

johnbillion

Message:

Docs: All sorts of improvements and corrections to function and hook docs.

See #57840

File:

• trunk/src/wp-includes/block-template-utils.php (modified) (8 diffs)

trunk/src/wp-includes/block-template-utils.php

@@ -300 +300 @@
  *     @type array  $slug__in     List of slugs to include.
  *     @type array  $slug__not_in List of slugs to skip.
- *     @type string $area         A 'wp_template_part_area' taxonomy value to filter by (for wp_template_part template type only).
+ *     @type string $area         A 'wp_template_part_area' taxonomy value to filter by (for 'wp_template_part' template type only).
  *     @type string $post_type    Post type to get the templates for.
  * }
@@ -756 +756 @@
  *
  * @param WP_Post $post Template post.
- * @return WP_Block_Template|WP_Error Template.
+ * @return WP_Block_Template|WP_Error Template or error object.
  */
 function _build_block_template_result_from_post( $post ) {
@@ -1056 +1056 @@
  * @since 5.8.0
  *
- * @param string $id            Template unique identifier (example: theme_slug//template_slug).
- * @param string $template_type Optional. Template type: `'wp_template'` or '`wp_template_part'`.
- *                              Default `'wp_template'`.
+ * @param string $id            Template unique identifier (example: 'theme_slug//template_slug').
+ * @param string $template_type Optional. Template type: 'wp_template' or 'wp_template_part'.
+ *                              Default 'wp_template'.
  * @return WP_Block_Template|null Template.
  */
@@ -1071 +1071 @@
      * @param WP_Block_Template|null $block_template Return block template object to short-circuit the default query,
      *                                               or null to allow WP to run its normal queries.
-     * @param string                 $id             Template unique identifier (example: theme_slug//template_slug).
-     * @param string                 $template_type  Template type: `'wp_template'` or '`wp_template_part'`.
+     * @param string                 $id             Template unique identifier (example: 'theme_slug//template_slug').
+     * @param string                 $template_type  Template type: 'wp_template' or 'wp_template_part'.
      */
     $block_template = apply_filters( 'pre_get_block_template', null, $id, $template_type );
@@ -1117 +1117 @@
      *
      * @param WP_Block_Template|null $block_template The found block template, or null if there isn't one.
-     * @param string                 $id             Template unique identifier (example: theme_slug//template_slug).
-     * @param array                  $template_type  Template type: `'wp_template'` or '`wp_template_part'`.
+     * @param string                 $id             Template unique identifier (example: 'theme_slug//template_slug').
+     * @param array                  $template_type  Template type: 'wp_template' or 'wp_template_part'.
      */
     return apply_filters( 'get_block_template', $block_template, $id, $template_type );
@@ -1130 +1130 @@
  * @since 5.9.0
  *
- * @param string $id            Template unique identifier (example: theme_slug//template_slug).
- * @param string $template_type Optional. Template type: `'wp_template'` or '`wp_template_part'`.
- *                              Default `'wp_template'`.
+ * @param string $id            Template unique identifier (example: 'theme_slug//template_slug').
+ * @param string $template_type Optional. Template type: 'wp_template' or 'wp_template_part'.
+ *                              Default 'wp_template'.
  * @return WP_Block_Template|null The found block template, or null if there isn't one.
  */
@@ -1145 +1145 @@
      * @param WP_Block_Template|null $block_template Return block template object to short-circuit the default query,
      *                                               or null to allow WP to run its normal queries.
-     * @param string                 $id             Template unique identifier (example: theme_slug//template_slug).
-     * @param string                 $template_type  Template type: `'wp_template'` or '`wp_template_part'`.
+     * @param string                 $id             Template unique identifier (example: 'theme_slug//template_slug').
+     * @param string                 $template_type  Template type: 'wp_template' or 'wp_template_part'.
      */
     $block_template = apply_filters( 'pre_get_block_file_template', null, $id, $template_type );
@@ -1179 +1179 @@
      *
      * @param WP_Block_Template|null $block_template The found block template, or null if there is none.
-     * @param string                 $id             Template unique identifier (example: theme_slug//template_slug).
-     * @param string                 $template_type  Template type: `'wp_template'` or '`wp_template_part'`.
+     * @param string                 $id             Template unique identifier (example: 'theme_slug//template_slug').
+     * @param string                 $template_type  Template type: 'wp_template' or 'wp_template_part'.
      */
     return apply_filters( 'get_block_file_template', $block_template, $id, $template_type );