WordPress.org

Make WordPress Core

Changeset 52317


Ignore:
Timestamp:
12/03/2021 10:08:31 PM (7 weeks ago)
Author:
audrasjb
Message:

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

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

See #53399.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/block-template-utils.php

    r52286 r52317  
    9393     * @since 5.9.0
    9494     *
    95      * @param array $default_areas An array of supported area objects.
     95     * @param array $default_area_definitions An array of supported area objects.
    9696     */
    9797    return apply_filters( 'default_wp_template_part_areas', $default_area_definitions );
     
    189189 * Returns the input if supported, otherwise returns the 'uncategorized' value.
    190190 *
    191  * @access private
    192  * @since 5.9.0
     191 * @since 5.9.0
     192 * @access private
    193193 *
    194194 * @param string $type Template part area name.
     
    220220 * Finds all nested template part file paths in a theme's directory.
    221221 *
    222  * @access private
    223  * @since 5.9.0
     222 * @since 5.9.0
     223 * @access private
    224224 *
    225225 * @param string $base_directory The theme's file path.
     
    241241 * Retrieves the template file from the theme for a given slug.
    242242 *
    243  * @access private
    244  * @since 5.9.0
    245  *
    246  * @param string $template_type wp_template or wp_template_part.
    247  * @param string $slug template slug.
     243 * @since 5.9.0
     244 * @access private
     245 *
     246 * @param string $template_type 'wp_template' or 'wp_template_part'.
     247 * @param string $slug          Template slug.
    248248 *
    249249 * @return array|null Template.
     
    285285
    286286/**
    287  * Retrieves the template files from  the theme.
    288  *
    289  * @access private
    290  * @since 5.9.0
    291  *
    292  * @param string $template_type wp_template or wp_template_part.
     287 * Retrieves the template files from the theme.
     288 *
     289 * @since 5.9.0
     290 * @access private
     291 *
     292 * @param string $template_type 'wp_template' or 'wp_template_part'.
    293293 *
    294294 * @return array Template.
     
    339339 * Attempts to add custom template information to the template item.
    340340 *
    341  * @access private
    342  * @since 5.9.0
     341 * @since 5.9.0
     342 * @access private
    343343 *
    344344 * @param array $template_item Template to add information to (requires 'slug' field).
    345  * @return array Template
     345 * @return array Template item.
    346346 */
    347347function _add_block_template_info( $template_item ) {
     
    362362 * Attempts to add the template part's area information to the input template.
    363363 *
    364  * @access private
    365  * @since 5.9.0
     364 * @since 5.9.0
     365 * @access private
    366366 *
    367367 * @param array $template_info Template to add information to (requires 'type' and 'slug' fields).
    368368 *
    369  * @return array Template.
     369 * @return array Template info.
    370370 */
    371371function _add_block_template_part_area_info( $template_info ) {
     
    388388 * the passed blocks and their inner blocks.
    389389 *
    390  * @access private
    391  * @since 5.9.0
     390 * @since 5.9.0
     391 * @access private
    392392 *
    393393 * @param array $blocks array of blocks.
     
    421421 * stylesheet as a theme attribute into each wp_template_part
    422422 *
    423  * @access private
    424  * @since 5.9.0
     423 * @since 5.9.0
     424 * @access private
    425425 *
    426426 * @param string $template_content serialized wp_template content.
    427427 *
    428  * @return string Updated wp_template content.
     428 * @return string Updated 'wp_template' content.
    429429 */
    430430function _inject_theme_attribute_in_block_template_content( $template_content ) {
     
    458458 * Parses a block template and removes the theme attribute from each template part.
    459459 *
    460  * @access private
    461  * @since 5.9.0
     460 * @since 5.9.0
     461 * @access private
    462462 *
    463463 * @param string $template_content Serialized block template content.
     
    491491 * Build a unified template object based on a theme file.
    492492 *
    493  * @access private
    494  * @since 5.9.0
     493 * @since 5.9.0
     494 * @access private
    495495 *
    496496 * @param array $template_file Theme file.
    497  * @param array $template_type wp_template or wp_template_part.
     497 * @param array $template_type 'wp_template' or 'wp_template_part'.
    498498 *
    499499 * @return WP_Block_Template Template.
     
    536536 * Build a unified template object based a post Object.
    537537 *
    538  * @access private
    539  * @since 5.9.0
     538 * @since 5.9.0
     539 * @access private
    540540 *
    541541 * @param WP_Post $post Template post.
     
    604604 *     @type string $post_type Post type to get the templates for.
    605605 * }
    606  * @param array $template_type wp_template or wp_template_part.
     606 * @param array $template_type 'wp_template' or 'wp_template_part'.
    607607 *
    608608 * @return array Templates.
Note: See TracChangeset for help on using the changeset viewer.