Changeset 56603 for trunk/src/wp-admin/includes/misc.php

Timestamp:

09/18/2023 12:28:24 AM (3 years ago)

Author:

joedolson

Message:

Administration: Add support for attributes in wp_admin_notice().

Allow admin notices to be created with additional attributes. Test attributes include hidden, data-*, and role="*" values, which are all in use in various admin notices across core.

This commit adds aria-live and hidden to the KSES global attributes array to support core usages.

Follow up to [56408], [56409], [56410], [56518], [56570], [56571], [56572], [56573], [56576], [56589], [56590], [56597], [56599], [56600], [56601], [56602].

Props costdev, joedolson.
See #57791.

File:

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

trunk/src/wp-admin/includes/misc.php

@@ -1659 +1659 @@
  *     @type string   $id                 Optional. The value of the admin notice's ID attribute. Default empty string.
  *     @type string[] $additional_classes Optional. A string array of class names. Default empty array.
+ *     @type string[] $attributes         Optional. Additional attributes for the notice div. Default empty array.
  *     @type bool     $paragraph_wrap     Optional. Whether to wrap the message in paragraph tags. Default true.
  * }
@@ -1669 +1670 @@
                 'id'                 => '',
                 'additional_classes' => array(),
+                'attributes'         => array(),
                 'paragraph_wrap'     => true,
         );
@@ -1682 +1684 @@
          * @param string $message The message for the admin notice.
          */
-        $args    = apply_filters( 'wp_admin_notice_args', $args, $message );
-        $id      = '';
-        $classes = 'notice';
+        $args       = apply_filters( 'wp_admin_notice_args', $args, $message );
+        $id         = '';
+        $classes    = 'notice';
+        $attributes = '';
 
         if ( is_string( $args['id'] ) ) {
@@ -1722 +1725 @@
         }
 
+        if ( is_array( $args['attributes'] ) && ! empty( $args['attributes'] ) ) {
+                $attributes = '';
+                foreach ( $args['attributes'] as $attr => $val ) {
+                        if ( is_bool( $val ) ) {
+                                $attributes .= $val ? ' ' . $attr : '';
+                        } elseif ( is_int( $attr ) ) {
+                                $attributes .= ' ' . esc_attr( trim( $val ) );
+                        } elseif ( $val ) {
+                                $attributes .= ' ' . $attr . '="' . esc_attr( trim( $val ) ) . '"';
+                        }
+                }
+        }
+
         if ( false !== $args['paragraph_wrap'] ) {
                 $message = "<p>$message</p>";
         }
 
-        $markup = sprintf( '<div %1$sclass="%2$s">%3$s</div>', $id, $classes, $message );
+        $markup = sprintf( '<div %1$sclass="%2$s"%3$s>%4$s</div>', $id, $classes, $attributes, $message );
 
         /**