Changeset 54137

Timestamp:

09/12/2022 10:29:02 PM (2 years ago)

Author:

audrasjb

Message:

Comments: Make wp_required_field_indicator() and wp_required_field_message() output filterable.

This changeset introduces two new hooks:

• wp_required_field_indicator allows developers to filter the HTML output of the wp_required_field_indicator() function.
• wp_required_field_message does the same for the wp_required_field_message() function.

The changeset also adds new phpunit tests for these filters.

Follow-up to [53888], [54136].

Props kebbet, audrasjb, sabernhardt, costdev, mukesh27.
Fixes #56389.
See #54394.

Location:

trunk

Files:

• src/wp-includes/general-template.php (modified) (2 diffs)
• tests/phpunit/tests/general/wpRequiredFieldIndicator.php (added)
• tests/phpunit/tests/general/wpRequiredFieldMessage.php (added)

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

@@ -5027 +5027 @@
     $indicator = '<span class="required">' . esc_html( $glyph ) . '</span>';
 
-    return $indicator;
+    /**
+     * Filters the markup for a visual indicator of required form fields.
+     *
+     * @since 6.1.0
+     *
+     * @param string $indicator Markup for the indicator element.
+     */
+    return apply_filters( 'wp_required_field_indicator', $indicator );
 }
 
@@ -5044 +5051 @@
     );
 
-    return $message;
+    /**
+     * Filters the message to explain required form fields.
+     *
+     * @since 6.1.0
+     *
+     * @param string $message Message text and glyph wrapped in a `span` tag.
+     */
+    return apply_filters( 'wp_required_field_message', $message );
 }