Changeset 45814

Timestamp:

08/15/2019 11:00:38 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Administration: In add_settings_error(), add warning and info as possible values for message type.

Account for these new values in settings_errors(), resulting in notice-warning and notice-info CSS classes.

Map legacy error and updated CSS classes to notice-error and notice-success.

Props donmhico, toddhalfpenny, flixos90, desrosj, javorszky, SergeyBiryukov.
Fixes #44640, #44941.

File:

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

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

@@ -1686 +1686 @@
  *
  * @since 3.0.0
+ * @since 5.3.0 Added `warning` and `info` as possible values for `$type`.
  *
  * @global array $wp_settings_errors Storage array of errors registered during this pageload
@@ -1693 +1694 @@
  * @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. Accepts 'error' or 'updated'.
- *                        Default 'error'.
+ * @param string $type    Optional. Message type, controls HTML class. Possible values include 'error',
+ *                        'success', 'warning', 'info'. Default 'error'.
  */
 function add_settings_error( $setting, $code, $message, $type = 'error' ) {
@@ -1788 +1789 @@
  *
  * @since 3.0.0
+ * @since 5.3.0 Legacy `error` and `updated` CSS classes are mapped to
+ *              `notice-error` and `notice-success`.
  *
  * @param string $setting        Optional slug title of a specific setting whose errors you want.
@@ -1808 +1811 @@
     $output = '';
     foreach ( $settings_errors as $key => $details ) {
-        $css_id    = 'setting-error-' . $details['code'];
-        $css_class = $details['type'] . ' settings-error notice is-dismissible';
-        $output   .= "<div id='$css_id' class='$css_class'> \n";
-        $output   .= "<p><strong>{$details['message']}</strong></p>";
-        $output   .= "</div> \n";
+        if ( 'updated' === $details['type'] ) {
+            $details['type'] = 'success';
+        }
+
+        $css_id    = sprintf(
+            'setting-error-%s',
+            sanitize_html_class( $details['code'] )
+        );
+        $css_class = sprintf(
+            'notice notice-%s settings-error is-dismissible',
+            sanitize_html_class( $details['type'] )
+        );
+
+        $output .= "<div id='$css_id' class='$css_class'> \n";
+        $output .= "<p><strong>{$details['message']}</strong></p>";
+        $output .= "</div> \n";
     }
     echo $output;