Changeset 58197

Timestamp:

05/25/2024 03:02:48 AM (2 years ago)

Author:

SergeyBiryukov

Message:

Docs: Update pre_do_shortcode_tag and do_shortcode_tag filter DocBlocks.

This reflects the return type change of shortcode_parse_atts() from array|string to array in WordPress 6.5.

Follow-up to [38506], [38713], [39665], [55711], [57597], [58168].

Props marherumr.
Fixes #61288.

File:

• trunk/src/wp-includes/shortcodes.php (modified) (3 diffs)

trunk/src/wp-includes/shortcodes.php

@@ -418 +418 @@
          *
          * @since 4.7.0
+         * @since 6.5.0 The `$attr` parameter is always an array.
          *
          * @param false|string $output Short-circuit return value. Either false or the value to replace the shortcode with.
          * @param string       $tag    Shortcode name.
-         * @param array|string $attr   Shortcode attributes array or the original arguments string if it cannot be parsed.
+         * @param array        $attr   Shortcode attributes array, can be empty if the original arguments string cannot be parsed.
          * @param array        $m      Regular expression match array.
          */
@@ -437 +438 @@
          *
          * @since 4.7.0
+         * @since 6.5.0 The `$attr` parameter is always an array.
          *
-         * @param string       $output Shortcode output.
-         * @param string       $tag    Shortcode name.
-         * @param array|string $attr   Shortcode attributes array or the original arguments string if it cannot be parsed.
-         * @param array        $m      Regular expression match array.
+         * @param string $output Shortcode output.
+         * @param string $tag    Shortcode name.
+         * @param array  $attr   Shortcode attributes array, can be empty if the original arguments string cannot be parsed.
+         * @param array  $m      Regular expression match array.
          */
         return apply_filters( 'do_shortcode_tag', $output, $tag, $attr, $m );
@@ -601 +603 @@
  *
  * @since 2.5.0
- * @since 6.5.0 The function now always returns an empty array,
+ * @since 6.5.0 The function now always returns an array,
  *              even if the original arguments string cannot be parsed or is empty.
  *