<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[56603] trunk: Administration: Add support for attributes in `wp_admin_notice()`.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/56603">56603</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/56603","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>joedolson</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-09-18 00:28:24 +0000 (Mon, 18 Sep 2023)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/changeset/56408">[56408]</a>, <a href="https://core.trac.wordpress.org/changeset/56409">[56409]</a>, <a href="https://core.trac.wordpress.org/changeset/56410">[56410]</a>, <a href="https://core.trac.wordpress.org/changeset/56518">[56518]</a>, <a href="https://core.trac.wordpress.org/changeset/56570">[56570]</a>, <a href="https://core.trac.wordpress.org/changeset/56571">[56571]</a>, <a href="https://core.trac.wordpress.org/changeset/56572">[56572]</a>, <a href="https://core.trac.wordpress.org/changeset/56573">[56573]</a>, <a href="https://core.trac.wordpress.org/changeset/56576">[56576]</a>, <a href="https://core.trac.wordpress.org/changeset/56589">[56589]</a>, <a href="https://core.trac.wordpress.org/changeset/56590">[56590]</a>, <a href="https://core.trac.wordpress.org/changeset/56597">[56597]</a>, <a href="https://core.trac.wordpress.org/changeset/56599">[56599]</a>, <a href="https://core.trac.wordpress.org/changeset/56600">[566
00]</a>, <a href="https://core.trac.wordpress.org/changeset/56601">[56601]</a>, <a href="https://core.trac.wordpress.org/changeset/56602">[56602]</a>.
Props costdev, joedolson.
See <a href="https://core.trac.wordpress.org/ticket/57791">#57791</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesmiscphp">trunk/src/wp-admin/includes/misc.php</a></li>
<li><a href="#trunksrcwpincludesksesphp">trunk/src/wp-includes/kses.php</a></li>
<li><a href="#trunktestsphpunittestsadminwpAdminNoticephp">trunk/tests/phpunit/tests/admin/wpAdminNotice.php</a></li>
<li><a href="#trunktestsphpunittestsadminwpGetAdminNoticephp">trunk/tests/phpunit/tests/admin/wpGetAdminNotice.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesmiscphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/misc.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/misc.php 2023-09-17 22:49:06 UTC (rev 56602)
+++ trunk/src/wp-admin/includes/misc.php 2023-09-18 00:28:24 UTC (rev 56603)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1658,6 +1658,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type bool $dismissible Optional. Whether the admin notice is dismissible. Default false.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $id Optional. The value of the admin notice's ID attribute. Default empty string.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string[] $additional_classes Optional. A string array of class names. Default empty array.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string[] $attributes Optional. Additional attributes for the notice div. Default empty array.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type bool $paragraph_wrap Optional. Whether to wrap the message in paragraph tags. Default true.
</span><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string The markup for an admin notice.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1668,6 +1669,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'dismissible' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'id' => '',
</span><span class="cx" style="display: block; padding: 0 10px"> 'additional_classes' => array(),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'attributes' => array(),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'paragraph_wrap' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1681,9 +1683,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args The arguments for the admin notice.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $message The message for the admin notice.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $args = apply_filters( 'wp_admin_notice_args', $args, $message );
- $id = '';
- $classes = 'notice';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $args = apply_filters( 'wp_admin_notice_args', $args, $message );
+ $id = '';
+ $classes = 'notice';
+ $attributes = '';
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_string( $args['id'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $trimmed_id = trim( $args['id'] );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1721,11 +1724,24 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $classes .= ' ' . implode( ' ', $args['additional_classes'] );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 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 ) ) . '"';
+ }
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( false !== $args['paragraph_wrap'] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $message = "<p>$message</p>";
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $markup = sprintf( '<div %1$sclass="%2$s">%3$s</div>', $id, $classes, $message );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $markup = sprintf( '<div %1$sclass="%2$s"%3$s>%4$s</div>', $id, $classes, $attributes, $message );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the markup for an admin notice.
</span></span></pre></div>
<a id="trunksrcwpincludesksesphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/kses.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/kses.php 2023-09-17 22:49:06 UTC (rev 56602)
+++ trunk/src/wp-includes/kses.php 2023-09-18 00:28:24 UTC (rev 56603)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2645,12 +2645,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'aria-describedby' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> 'aria-details' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> 'aria-expanded' => true,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'aria-hidden' => true,
</ins><span class="cx" style="display: block; padding: 0 10px"> 'aria-label' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> 'aria-labelledby' => true,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'aria-hidden' => true,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'aria-live' => true,
</ins><span class="cx" style="display: block; padding: 0 10px"> 'class' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> 'data-*' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> 'dir' => true,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'hidden' => true,
</ins><span class="cx" style="display: block; padding: 0 10px"> 'id' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> 'lang' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> 'style' => true,
</span></span></pre></div>
<a id="trunktestsphpunittestsadminwpAdminNoticephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/admin/wpAdminNotice.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/admin/wpAdminNotice.php 2023-09-17 22:49:06 UTC (rev 56602)
+++ trunk/tests/phpunit/tests/admin/wpAdminNotice.php 2023-09-18 00:28:24 UTC (rev 56603)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -212,6 +212,71 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'expected' => '<div class="notice"><p>A notice with additional classes that are not an array.</p></div>',
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'additional attribute with a value' => array(
+ 'message' => 'A notice with an additional attribute with a value.',
+ 'args' => array(
+ 'attributes' => array( 'aria-live' => 'assertive' ),
+ ),
+ 'expected' => '<div class="notice" aria-live="assertive"><p>A notice with an additional attribute with a value.</p></div>',
+ ),
+ 'additional hidden attribute' => array(
+ 'message' => 'A notice with the hidden attribute.',
+ 'args' => array(
+ 'attributes' => array( 'hidden' => true ),
+ ),
+ 'expected' => '<div class="notice" hidden><p>A notice with the hidden attribute.</p></div>',
+ ),
+ 'additional attribute no associative keys' => array(
+ 'message' => 'A notice with a boolean attribute without an associative key.',
+ 'args' => array(
+ 'attributes' => array( 'hidden' ),
+ ),
+ 'expected' => '<div class="notice" hidden><p>A notice with a boolean attribute without an associative key.</p></div>',
+ ),
+ 'additional attribute with role' => array(
+ 'message' => 'A notice with an additional attribute role.',
+ 'args' => array(
+ 'attributes' => array( 'role' => 'alert' ),
+ ),
+ 'expected' => '<div class="notice" role="alert"><p>A notice with an additional attribute role.</p></div>',
+ ),
+ 'multiple additional attributes' => array(
+ 'message' => 'A notice with multiple additional attributes.',
+ 'args' => array(
+ 'attributes' => array(
+ 'role' => 'alert',
+ 'data-test' => -1,
+ ),
+ ),
+ 'expected' => '<div class="notice" role="alert" data-test="-1"><p>A notice with multiple additional attributes.</p></div>',
+ ),
+ 'data attribute with unsafe value' => array(
+ 'message' => 'A notice with an additional attribute with an unsafe value.',
+ 'args' => array(
+ 'attributes' => array( 'data-unsafe' => '<script>alert( "Howdy, admin!" );</script>' ),
+ ),
+ 'expected' => '<div class="notice" data-unsafe="<script>alert( "Howdy, admin!" );</script>"><p>A notice with an additional attribute with an unsafe value.</p></div>',
+ ),
+ 'additional invalid attribute' => array(
+ 'message' => 'A notice with an additional attribute that is invalid.',
+ 'args' => array(
+ 'attributes' => array( 'not-valid' => 'not-valid' ),
+ ),
+ 'expected' => '<div class="notice"><p>A notice with an additional attribute that is invalid.</p></div>',
+ ),
+ 'multiple attributes with "role", invalid, data-*, numeric, and boolean' => array(
+ 'message' => 'A notice with multiple attributes with "role", invalid, "data-*", numeric, and boolean.',
+ 'args' => array(
+ 'attributes' => array(
+ 'role' => 'alert',
+ 'disabled' => 'disabled',
+ 'data-name' => 'my-name',
+ 'data-id' => 1,
+ 'hidden',
+ ),
+ ),
+ 'expected' => '<div class="notice" role="alert" data-name="my-name" data-id="1" hidden><p>A notice with multiple attributes with "role", invalid, "data-*", numeric, and boolean.</p></div>',
+ ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'paragraph wrapping as a falsy value rather than (bool) false' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'message' => 'A notice with paragraph wrapping as a falsy value rather than (bool) false.',
</span><span class="cx" style="display: block; padding: 0 10px"> 'args' => array(
</span></span></pre></div>
<a id="trunktestsphpunittestsadminwpGetAdminNoticephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/admin/wpGetAdminNotice.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/admin/wpGetAdminNotice.php 2023-09-17 22:49:06 UTC (rev 56602)
+++ trunk/tests/phpunit/tests/admin/wpGetAdminNotice.php 2023-09-18 00:28:24 UTC (rev 56603)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -208,6 +208,64 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'expected' => '<div class="notice"><p>A notice with additional classes that are not an array.</p></div>',
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'additional attribute with a value' => array(
+ 'message' => 'A notice with an additional attribute with a value.',
+ 'args' => array(
+ 'attributes' => array( 'aria-live' => 'assertive' ),
+ ),
+ 'expected' => '<div class="notice" aria-live="assertive"><p>A notice with an additional attribute with a value.</p></div>',
+ ),
+ 'additional hidden attribute' => array(
+ 'message' => 'A notice with the hidden attribute.',
+ 'args' => array(
+ 'attributes' => array( 'hidden' => true ),
+ ),
+ 'expected' => '<div class="notice" hidden><p>A notice with the hidden attribute.</p></div>',
+ ),
+ 'additional attribute no associative keys' => array(
+ 'message' => 'A notice with a boolean attribute without an associative key.',
+ 'args' => array(
+ 'attributes' => array( 'hidden' ),
+ ),
+ 'expected' => '<div class="notice" hidden><p>A notice with a boolean attribute without an associative key.</p></div>',
+ ),
+ 'additional attribute with role' => array(
+ 'message' => 'A notice with an additional attribute role.',
+ 'args' => array(
+ 'attributes' => array( 'role' => 'alert' ),
+ ),
+ 'expected' => '<div class="notice" role="alert"><p>A notice with an additional attribute role.</p></div>',
+ ),
+ 'multiple additional attributes' => array(
+ 'message' => 'A notice with multiple additional attributes.',
+ 'args' => array(
+ 'attributes' => array(
+ 'role' => 'alert',
+ 'data-test' => -1,
+ ),
+ ),
+ 'expected' => '<div class="notice" role="alert" data-test="-1"><p>A notice with multiple additional attributes.</p></div>',
+ ),
+ 'data attribute with unsafe value' => array(
+ 'message' => 'A notice with an additional attribute with an unsafe value.',
+ 'args' => array(
+ 'attributes' => array( 'data-unsafe' => '<script>alert( "Howdy, admin!" );</script>' ),
+ ),
+ 'expected' => '<div class="notice" data-unsafe="<script>alert( "Howdy, admin!" );</script>"><p>A notice with an additional attribute with an unsafe value.</p></div>',
+ ),
+ 'multiple attributes with "role", invalid, data-*, numeric, and boolean' => array(
+ 'message' => 'A notice with multiple attributes with "role", invalid, "data-*", numeric, and boolean.',
+ 'args' => array(
+ 'attributes' => array(
+ 'role' => 'alert',
+ 'disabled' => 'disabled',
+ 'data-name' => 'my-name',
+ 'data-id' => 1,
+ 'hidden',
+ ),
+ ),
+ 'expected' => '<div class="notice" role="alert" disabled="disabled" data-name="my-name" data-id="1" hidden><p>A notice with multiple attributes with "role", invalid, "data-*", numeric, and boolean.</p></div>',
+ ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'paragraph wrapping as a falsy value rather than (bool) false' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'message' => 'A notice with paragraph wrapping as a falsy value rather than (bool) false.',
</span><span class="cx" style="display: block; padding: 0 10px"> 'args' => array(
</span></span></pre>
</div>
</div>
</body>
</html>