Changeset 52317

Timestamp:

12/03/2021 10:08:31 PM (3 years ago)

Author:

audrasjb

Message:

Docs: Miscellaneous Docblock corrections for block-template-utils.php file.

Follow-up to [52275], [52062].

See #53399.

File:

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

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

@@ -93 +93 @@
      * @since 5.9.0
      *
-     * @param array $default_areas An array of supported area objects.
+     * @param array $default_area_definitions An array of supported area objects.
      */
     return apply_filters( 'default_wp_template_part_areas', $default_area_definitions );
@@ -189 +189 @@
  * Returns the input if supported, otherwise returns the 'uncategorized' value.
  *
- * @access private
- * @since 5.9.0
+ * @since 5.9.0
+ * @access private
  *
  * @param string $type Template part area name.
@@ -220 +220 @@
  * Finds all nested template part file paths in a theme's directory.
  *
- * @access private
- * @since 5.9.0
+ * @since 5.9.0
+ * @access private
  *
  * @param string $base_directory The theme's file path.
@@ -241 +241 @@
  * Retrieves the template file from the theme for a given slug.
  *
- * @access private
- * @since 5.9.0
- *
- * @param string $template_type wp_template or wp_template_part.
- * @param string $slug template slug.
+ * @since 5.9.0
+ * @access private
+ *
+ * @param string $template_type 'wp_template' or 'wp_template_part'.
+ * @param string $slug          Template slug.
  *
  * @return array|null Template.
@@ -285 +285 @@
 
 /**
- * Retrieves the template files from  the theme.
- *
- * @access private
- * @since 5.9.0
- *
- * @param string $template_type wp_template or wp_template_part.
+ * Retrieves the template files from the theme.
+ *
+ * @since 5.9.0
+ * @access private
+ *
+ * @param string $template_type 'wp_template' or 'wp_template_part'.
  *
  * @return array Template.
@@ -339 +339 @@
  * Attempts to add custom template information to the template item.
  *
- * @access private
- * @since 5.9.0
+ * @since 5.9.0
+ * @access private
  *
  * @param array $template_item Template to add information to (requires 'slug' field).
- * @return array Template
+ * @return array Template item.
  */
 function _add_block_template_info( $template_item ) {
@@ -362 +362 @@
  * Attempts to add the template part's area information to the input template.
  *
- * @access private
- * @since 5.9.0
+ * @since 5.9.0
+ * @access private
  *
  * @param array $template_info Template to add information to (requires 'type' and 'slug' fields).
  *
- * @return array Template.
+ * @return array Template info.
  */
 function _add_block_template_part_area_info( $template_info ) {
@@ -388 +388 @@
  * the passed blocks and their inner blocks.
  *
- * @access private
- * @since 5.9.0
+ * @since 5.9.0
+ * @access private
  *
  * @param array $blocks array of blocks.
@@ -421 +421 @@
  * stylesheet as a theme attribute into each wp_template_part
  *
- * @access private
- * @since 5.9.0
+ * @since 5.9.0
+ * @access private
  *
  * @param string $template_content serialized wp_template content.
  *
- * @return string Updated wp_template content.
+ * @return string Updated 'wp_template' content.
  */
 function _inject_theme_attribute_in_block_template_content( $template_content ) {
@@ -458 +458 @@
  * Parses a block template and removes the theme attribute from each template part.
  *
- * @access private
- * @since 5.9.0
+ * @since 5.9.0
+ * @access private
  *
  * @param string $template_content Serialized block template content.
@@ -491 +491 @@
  * Build a unified template object based on a theme file.
  *
- * @access private
- * @since 5.9.0
+ * @since 5.9.0
+ * @access private
  *
  * @param array $template_file Theme file.
- * @param array $template_type wp_template or wp_template_part.
+ * @param array $template_type 'wp_template' or 'wp_template_part'.
  *
  * @return WP_Block_Template Template.
@@ -536 +536 @@
  * Build a unified template object based a post Object.
  *
- * @access private
- * @since 5.9.0
+ * @since 5.9.0
+ * @access private
  *
  * @param WP_Post $post Template post.
@@ -604 +604 @@
  *     @type string $post_type Post type to get the templates for.
  * }
- * @param array $template_type wp_template or wp_template_part.
+ * @param array $template_type 'wp_template' or 'wp_template_part'.
  *
  * @return array Templates.