Changeset 56654 for trunk/src/wp-includes/functions.php

Timestamp:

09/21/2023 06:22:10 PM (12 months ago)

Author:

joedolson

Message:

Login and Registration: Improve HTML for errors and notices.

Improve markup on Login and Registration errors. Use list markup for multiple issues, paragraph when only one to reduce semantic burden in the most common case. Normalize classes and markup for wrapper using wp_admin_notice() and wp_get_admin_notice() functions. Move definition of those functions from wp-admin\includes\misc.php to wp-includes\functions.php. Move tests to functions group.

Props extendwings, sabernhardt, afercia, lukecavanagh, rianrietveld, oglekler, sergeybiryukov, costdev, joedolson.
Fixes #30685.

File:

• trunk/src/wp-includes/functions.php (modified) (1 diff)

trunk/src/wp-includes/functions.php

@@ -8763 +8763 @@
     return abs( (float) $expected - (float) $actual ) <= $precision;
 }
+
+/**
+ * Creates and returns the markup for an admin notice.
+ *
+ * @since 6.4.0
+ *
+ * @param string $message The message.
+ * @param array  $args {
+ *     Optional. An array of arguments for the admin notice. Default empty array.
+ *
+ *     @type string   $type               Optional. The type of admin notice.
+ *                                        For example, 'error', 'success', 'warning', 'info'.
+ *                                        Default empty string.
+ *     @type bool     $dismissible        Optional. Whether the admin notice is dismissible. Default false.
+ *     @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.
+ * }
+ * @return string The markup for an admin notice.
+ */
+function wp_get_admin_notice( $message, $args = array() ) {
+    $defaults = array(
+        'type'               => '',
+        'dismissible'        => false,
+        'id'                 => '',
+        'additional_classes' => array(),
+        'attributes'         => array(),
+        'paragraph_wrap'     => true,
+    );
+
+    $args = wp_parse_args( $args, $defaults );
+
+    /**
+     * Filters the arguments for an admin notice.
+     *
+     * @since 6.4.0
+     *
+     * @param array  $args    The arguments for the admin notice.
+     * @param string $message The message for the admin notice.
+     */
+    $args       = apply_filters( 'wp_admin_notice_args', $args, $message );
+    $id         = '';
+    $classes    = 'notice';
+    $attributes = '';
+
+    if ( is_string( $args['id'] ) ) {
+        $trimmed_id = trim( $args['id'] );
+
+        if ( '' !== $trimmed_id ) {
+            $id = 'id="' . $trimmed_id . '" ';
+        }
+    }
+
+    if ( is_string( $args['type'] ) ) {
+        $type = trim( $args['type'] );
+
+        if ( str_contains( $type, ' ' ) ) {
+            _doing_it_wrong(
+                __FUNCTION__,
+                sprintf(
+                    /* translators: %s: The "type" key. */
+                    __( 'The %s key must be a string without spaces.' ),
+                    '<code>type</code>'
+                ),
+                '6.4.0'
+            );
+        }
+
+        if ( '' !== $type ) {
+            $classes .= ' notice-' . $type;
+        }
+    }
+
+    if ( true === $args['dismissible'] ) {
+        $classes .= ' is-dismissible';
+    }
+
+    if ( is_array( $args['additional_classes'] ) && ! empty( $args['additional_classes'] ) ) {
+        $classes .= ' ' . implode( ' ', $args['additional_classes'] );
+    }
+
+    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>%4$s</div>', $id, $classes, $attributes, $message );
+
+    /**
+     * Filters the markup for an admin notice.
+     *
+     * @since 6.4.0
+     *
+     * @param string $markup  The HTML markup for the admin notice.
+     * @param string $message The message for the admin notice.
+     * @param array  $args    The arguments for the admin notice.
+     */
+    return apply_filters( 'wp_admin_notice_markup', $markup, $message, $args );
+}
+
+/**
+ * Outputs an admin notice.
+ *
+ * @since 6.4.0
+ *
+ * @param string $message The message to output.
+ * @param array  $args {
+ *     Optional. An array of arguments for the admin notice. Default empty array.
+ *
+ *     @type string   $type               Optional. The type of admin notice.
+ *                                        For example, 'error', 'success', 'warning', 'info'.
+ *                                        Default empty string.
+ *     @type bool     $dismissible        Optional. Whether the admin notice is dismissible. Default false.
+ *     @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 bool     $paragraph_wrap     Optional. Whether to wrap the message in paragraph tags. Default true.
+ * }
+ */
+function wp_admin_notice( $message, $args = array() ) {
+    /**
+     * Fires before an admin notice is output.
+     *
+     * @since 6.4.0
+     *
+     * @param string $message The message for the admin notice.
+     * @param array  $args    The arguments for the admin notice.
+     */
+    do_action( 'wp_admin_notice', $message, $args );
+
+    echo wp_kses_post( wp_get_admin_notice( $message, $args ) );
+}