Make WordPress Core

Changeset 54275


Ignore:
Timestamp:
09/21/2022 01:40:03 PM (21 months ago)
Author:
hellofromTonya
Message:

Docs: Fix wp_get_layout_style() parameter documentation.

  • Changed boolean to bool.
  • Added Optional. and Default for each optional parameter.
  • Improved @return documentation to include empty string.

Follow-up to [54274], [53421], [53085], [52069].

Props mukesh27, hellofromTonya.
See #55646.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/block-supports/layout.php

    r54274 r54275  
    4040 * @param array                $layout                        Layout object. The one that is passed has already checked
    4141 *                                                            the existence of default block layout.
    42  * @param boolean              $has_block_gap_support         Whether the theme has support for the block gap.
     42 * @param bool                 $has_block_gap_support         Optional. Whether the theme has support for the block gap. Default false.
    4343 * @param string|string[]|null $gap_value                     Optional. The block gap value to apply. Default null.
    44  * @param boolean              $should_skip_gap_serialization Whether to skip applying the user-defined value set in the editor.
    45  * @param string               $fallback_gap_value            The block gap value to apply.
     44 * @param bool                 $should_skip_gap_serialization Optional. Whether to skip applying the user-defined value set in the editor. Default false.
     45 * @param string               $fallback_gap_value            Optional. The block gap value to apply. Default '0.5em'.
    4646 * @param array|null           $block_spacing                 Optional. Custom spacing set on the block. Default null.
    47  * @return string CSS style.
     47 * @return string CSS styles on success. Else, empty string.
    4848 */
    4949function wp_get_layout_style( $selector, $layout, $has_block_gap_support = false, $gap_value = null, $should_skip_gap_serialization = false, $fallback_gap_value = '0.5em', $block_spacing = null ) {
Note: See TracChangeset for help on using the changeset viewer.