Changeset 53888 for trunk/src/wp-includes/general-template.php

Timestamp:

08/12/2022 12:09:10 PM (16 months ago)

Author:

audrasjb

Message:

General: Add required fields helper functions for better reusability.

This changeset introduces new wp_required_field_indicator() and wp_required_field_message() helper functions to generate reusable and consistent required field indicator and message. It also implements these functions in various admin screens.

Props sabernhardt, ryokuhi, joedolson, audrasjb, SergeyBiryukov.
Fixes #54394.

File:

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

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

@@ -5023 +5023 @@
 
 /**
+ * Assigns a visual indicator for required form fields.
+ *
+ * @since 6.1.0
+ *
+ * @return string Indicator glyph wrapped in a `span` tag.
+ */
+function wp_required_field_indicator() {
+    /* translators: Character to identify required form fields. */
+    $glyph     = __( '*' );
+    $indicator = '<span class="required" aria-hidden="true">' . esc_html( $glyph ) . '</span>';
+
+    return $indicator;
+}
+
+/**
+ * Creates a message to explain required form fields.
+ *
+ * @since 6.1.0
+ *
+ * @return string Message text and glyph wrapped in a `span` tag.
+ */
+function wp_required_field_message() {
+    $message = sprintf(
+        '<span class="required-field-message" aria-hidden="true">%s</span>',
+        /* translators: %s: Asterisk symbol (*). */
+        sprintf( __( 'Required fields are marked %s' ), wp_required_field_indicator() )
+    );
+
+    return $message;
+}
+
+/**
  * Default settings for heartbeat.
  *