Docs: Miscellaneous Docblock corrections in several /block-supports files.

See #53399.

Built from https://develop.svn.wordpress.org/trunk@52302


git-svn-id: http://core.svn.wordpress.org/trunk@51894 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
audrasjb 2021-12-01 23:16:04 +00:00
parent 931b03e4f9
commit 38e19413f6
7 changed files with 18 additions and 27 deletions

View File

@ -31,7 +31,7 @@ function wp_register_alignment_support( $block_type ) {
} }
/** /**
* Add CSS classes for block alignment to the incoming attributes array. * Adds CSS classes for block alignment to the incoming attributes array.
* This will be applied to the block markup in the front-end. * This will be applied to the block markup in the front-end.
* *
* @since 5.6.0 * @since 5.6.0
@ -39,7 +39,6 @@ function wp_register_alignment_support( $block_type ) {
* *
* @param WP_Block_Type $block_type Block Type. * @param WP_Block_Type $block_type Block Type.
* @param array $block_attributes Block attributes. * @param array $block_attributes Block attributes.
*
* @return array Block alignment CSS classes and inline styles. * @return array Block alignment CSS classes and inline styles.
*/ */
function wp_apply_alignment_support( $block_type, $block_attributes ) { function wp_apply_alignment_support( $block_type, $block_attributes ) {

View File

@ -47,7 +47,6 @@ function wp_register_border_support( $block_type ) {
* *
* @param WP_Block_Type $block_type Block type. * @param WP_Block_Type $block_type Block type.
* @param array $block_attributes Block attributes. * @param array $block_attributes Block attributes.
*
* @return array Border CSS classes and inline styles. * @return array Border CSS classes and inline styles.
*/ */
function wp_apply_border_support( $block_type, $block_attributes ) { function wp_apply_border_support( $block_type, $block_attributes ) {
@ -145,8 +144,8 @@ function wp_apply_border_support( $block_type, $block_attributes ) {
* @access private * @access private
* *
* @param WP_Block_Type $block_type Block type. * @param WP_Block_Type $block_type Block type.
* * @return bool Whether serialization of the current block's border properties
* @return bool * should occur.
*/ */
function wp_skip_border_serialization( $block_type ) { function wp_skip_border_serialization( $block_type ) {
$border_support = _wp_array_get( $block_type->supports, array( '__experimentalBorder' ), false ); $border_support = _wp_array_get( $block_type->supports, array( '__experimentalBorder' ), false );

View File

@ -40,7 +40,7 @@ function wp_register_dimensions_support( $block_type ) {
} }
/** /**
* Add CSS classes for block dimensions to the incoming attributes array. * Adds CSS classes for block dimensions to the incoming attributes array.
* This will be applied to the block markup in the front-end. * This will be applied to the block markup in the front-end.
* *
* @since 5.9.0 * @since 5.9.0
@ -48,7 +48,6 @@ function wp_register_dimensions_support( $block_type ) {
* *
* @param WP_Block_Type $block_type Block Type. * @param WP_Block_Type $block_type Block Type.
* @param array $block_attributes Block attributes. * @param array $block_attributes Block attributes.
*
* @return array Block dimensions CSS classes and inline styles. * @return array Block dimensions CSS classes and inline styles.
*/ */
function wp_apply_dimensions_support( $block_type, $block_attributes ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable function wp_apply_dimensions_support( $block_type, $block_attributes ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
@ -72,8 +71,7 @@ function wp_apply_dimensions_support( $block_type, $block_attributes ) { // phpc
* @access private * @access private
* *
* @param WP_Block_type $block_type Block type. * @param WP_Block_type $block_type Block type.
* * @return bool Whether to serialize spacing support styles & classes.
* @return boolean Whether to serialize spacing support styles & classes.
*/ */
function wp_skip_dimensions_serialization( $block_type ) { function wp_skip_dimensions_serialization( $block_type ) {
$dimensions_support = _wp_array_get( $block_type->supports, array( '__experimentalDimensions' ), false ); $dimensions_support = _wp_array_get( $block_type->supports, array( '__experimentalDimensions' ), false );

View File

@ -35,10 +35,10 @@ function wp_register_layout_support( $block_type ) {
* @since 5.9.0 * @since 5.9.0
* @access private * @access private
* *
* @param string $selector CSS selector. * @param string $selector CSS selector.
* @param array $layout Layout object. The one that is passed has already checked the existance of default block layout. * @param array $layout Layout object. The one that is passed has already checked
* @param boolean $has_block_gap_support Whether the theme has support for the block gap. * the existance of default block layout.
* * @param bool $has_block_gap_support Whether the theme has support for the block gap.
* @return string CSS style. * @return string CSS style.
*/ */
function wp_get_layout_style( $selector, $layout, $has_block_gap_support = false ) { function wp_get_layout_style( $selector, $layout, $has_block_gap_support = false ) {
@ -216,7 +216,6 @@ add_filter( 'render_block', 'wp_render_layout_support_flag', 10, 2 );
* *
* @param string $block_content Rendered block content. * @param string $block_content Rendered block content.
* @param array $block Block object. * @param array $block Block object.
*
* @return string Filtered block content. * @return string Filtered block content.
*/ */
function wp_restore_group_inner_container( $block_content, $block ) { function wp_restore_group_inner_container( $block_content, $block ) {

View File

@ -41,7 +41,6 @@ function wp_register_spacing_support( $block_type ) {
* *
* @param WP_Block_Type $block_type Block Type. * @param WP_Block_Type $block_type Block Type.
* @param array $block_attributes Block attributes. * @param array $block_attributes Block attributes.
*
* @return array Block spacing CSS classes and inline styles. * @return array Block spacing CSS classes and inline styles.
*/ */
function wp_apply_spacing_support( $block_type, $block_attributes ) { function wp_apply_spacing_support( $block_type, $block_attributes ) {
@ -86,8 +85,7 @@ function wp_apply_spacing_support( $block_type, $block_attributes ) {
* @access private * @access private
* *
* @param WP_Block_Type $block_type Block type. * @param WP_Block_Type $block_type Block type.
* * @return bool Whether to serialize spacing support styles & classes.
* @return boolean Whether to serialize spacing support styles & classes.
*/ */
function wp_skip_spacing_serialization( $block_type ) { function wp_skip_spacing_serialization( $block_type ) {
$spacing_support = _wp_array_get( $block_type->supports, array( 'spacing' ), false ); $spacing_support = _wp_array_get( $block_type->supports, array( 'spacing' ), false );
@ -104,9 +102,9 @@ function wp_skip_spacing_serialization( $block_type ) {
* @since 5.9.0 * @since 5.9.0
* @access private * @access private
* *
* @param string $block_content Rendered block content. * @param string $block_content Rendered block content.
* @param array $block Block object. * @param array $block Block object.
* @return string Filtered block content. * @return string Filtered block content.
*/ */
function wp_render_spacing_gap_support( $block_content, $block ) { function wp_render_spacing_gap_support( $block_content, $block ) {
$block_type = WP_Block_Type_Registry::get_instance()->get_registered( $block['blockName'] ); $block_type = WP_Block_Type_Registry::get_instance()->get_registered( $block['blockName'] );

View File

@ -60,16 +60,15 @@ function wp_register_typography_support( $block_type ) {
} }
/** /**
* Add CSS classes and inline styles for typography features such as font sizes * Adds CSS classes and inline styles for typography features such as font sizes
* to the incoming attributes array. This will be applied to the block markup in * to the incoming attributes array. This will be applied to the block markup in
* the front-end. * the front-end.
* *
* @since 5.6.0 * @since 5.6.0
* @access private * @access private
* *
* @param WP_Block_Type $block_type Block type. * @param WP_Block_Type $block_type Block type.
* @param array $block_attributes Block attributes. * @param array $block_attributes Block attributes.
*
* @return array Typography CSS classes and inline styles. * @return array Typography CSS classes and inline styles.
*/ */
function wp_apply_typography_support( $block_type, $block_attributes ) { function wp_apply_typography_support( $block_type, $block_attributes ) {
@ -192,8 +191,7 @@ function wp_apply_typography_support( $block_type, $block_attributes ) {
* @param array $attributes Block's attributes. * @param array $attributes Block's attributes.
* @param string $feature Key for the feature within the typography styles. * @param string $feature Key for the feature within the typography styles.
* @param string $css_property Slug for the CSS property the inline style sets. * @param string $css_property Slug for the CSS property the inline style sets.
* * @return string CSS inline style.
* @return string CSS inline style.
*/ */
function wp_typography_get_css_variable_inline_style( $attributes, $feature, $css_property ) { function wp_typography_get_css_variable_inline_style( $attributes, $feature, $css_property ) {
// Retrieve current attribute value or skip if not found. // Retrieve current attribute value or skip if not found.

View File

@ -16,7 +16,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '5.9-beta1-52301'; $wp_version = '5.9-beta1-52302';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.