Skip to content

Accessibility: Add aria-live attribute support to settings_errors() #8642

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: trunk
Choose a base branch
from
Open

Accessibility: Add aria-live attribute support to settings_errors() #8642

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
67c14ef
Accessibility: Add aria-live attribute support to settings_errors()
himanshupathak95 Mar 30, 2025
d04bc62
Update tests to include the aria-live attribute
himanshupathak95 Apr 4, 2025
35aac1e
Fix linting errors
himanshupathak95 Apr 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 18 additions & 9 deletions src/wp-admin/includes/template.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1854,24 +1854,28 @@ function do_settings_fields( $page, $section ) {
*
* @since 3.0.0
* @since 5.3.0 Added `warning` and `info` as possible values for `$type`.
* @since 6.9.0 Added `$aria_live` parameter to control the screen reader announcement.
*
* @global array[] $wp_settings_errors Storage array of errors registered during this pageload
*
* @param string $setting Slug title of the setting to which this error applies.
* @param string $code Slug-name to identify the error. Used as part of 'id' attribute in HTML output.
* @param string $message The formatted message text to display to the user (will be shown inside styled
* @param string $setting Slug title of the setting to which this error applies.
* @param string $code Slug-name to identify the error. Used as part of 'id' attribute in HTML output.
* @param string $message The formatted message text to display to the user (will be shown inside styled
* `<div>` and `<p>` tags).
* @param string $type Optional. Message type, controls HTML class. Possible values include 'error',
* 'success', 'warning', 'info'. Default 'error'.
* @param string $aria_live Optional. The ARIA live attribute value. Possible values include 'off', 'polite',
* 'assertive'. Default empty string which doesn't add the attribute.
*/
function add_settings_error( $setting, $code, $message, $type = 'error' ) {
function add_settings_error( $setting, $code, $message, $type = 'error', $aria_live = '' ) {
global $wp_settings_errors;

$wp_settings_errors[] = array(
'setting' => $setting,
'code' => $code,
'message' => $message,
'type' => $type,
'setting' => $setting,
'code' => $code,
'message' => $message,
'type' => $type,
'aria_live' => $aria_live,
);
}

Expand Down Expand Up @@ -2011,7 +2015,12 @@ function settings_errors( $setting = '', $sanitize = false, $hide_on_update = fa
esc_attr( $details['type'] )
);

$output .= "<div id='$css_id' class='$css_class'> \n";
$aria_live_attr = '';
if ( ! empty( $details['aria_live'] ) && in_array( $details['aria_live'], array( 'off', 'polite', 'assertive' ), true ) ) {
$aria_live_attr = sprintf( ' aria-live="%s"', esc_attr( $details['aria_live'] ) );
}

$output .= "<div id='$css_id' class='$css_class'$aria_live_attr> \n";
$output .= "<p><strong>{$details['message']}</strong></p>";
$output .= "</div> \n";
}
Expand Down
9 changes: 5 additions & 4 deletions tests/phpunit/tests/admin/includesTemplate.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -390,10 +390,11 @@ public function test_get_settings_errors_sources() {
'type' => 'error',
);
$blogdescription_error = array(
'setting' => 'blogdescription',
'code' => 'blogdescription',
'message' => 'Too short',
'type' => 'error',
'setting' => 'blogdescription',
'code' => 'blogdescription',
'message' => 'Too short',
'type' => 'error',
'aria_live' => '',
);

$wp_settings_errors = null;
Expand Down
Loading