Changeset 54520

Timestamp:

10/16/2022 03:44:18 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Docs: Clarify default values for a few block function parameters.

This applies to:

• $block_name in strip_core_block_namespace()
• $allowed_html in filter_block_content()
• $pagination_type in get_comments_pagination_arrow()

Follow-up to [46896], [48794], [53138], [54181].

Props rakibwordpress, ironprogrammer, sabernhardt, SergeyBiryukov.
Fixes #56596.

File:

• trunk/src/wp-includes/blocks.php (modified) (4 diffs)

trunk/src/wp-includes/blocks.php

@@ -688 +688 @@
  * @since 5.3.1
  *
- * @param string $block_name Original block name.
+ * @param string|null $block_name Optional. Original block name. Null if the block name is unknown,
+ *                                e.g. Classic blocks have their name set to null. Default null.
  * @return string Block name to use for serialization.
  */
@@ -784 +785 @@
  *
  * @param string         $text              Text that may contain block content.
- * @param array[]|string $allowed_html      An array of allowed HTML elements and attributes,
+ * @param array[]|string $allowed_html      Optional. An array of allowed HTML elements and attributes,
  *                                          or a context name such as 'post'. See wp_kses_allowed_html()
- *                                          for the list of accepted context names.
+ *                                          for the list of accepted context names. Default 'post'.
  * @param string[]       $allowed_protocols Optional. Array of allowed URL protocols.
  *                                          Defaults to the result of wp_allowed_protocols().
@@ -1413 +1414 @@
  *
  * @param WP_Block $block Block instance.
- *
  * @return array Returns the comment query parameters to use with the
  *               WP_Comment_Query constructor.
@@ -1484 +1484 @@
  *
  * @param WP_Block $block           Block instance.
- * @param string   $pagination_type Type of the arrow we will be rendering.
- *                                  Default 'next'. Accepts 'next' or 'previous'.
- *
+ * @param string   $pagination_type Optional. Type of the arrow we will be rendering.
+ *                                  Accepts 'next' or 'previous'. Default 'next'.
  * @return string|null The pagination arrow HTML or null if there is none.
  */