<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[54137] trunk: Comments: Make `wp_required_field_indicator()` and `wp_required_field_message()` output filterable.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/54137">54137</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/54137","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>audrasjb</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-09-12 22:29:02 +0000 (Mon, 12 Sep 2022)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/changeset/53888">[53888]</a>, <a href="https://core.trac.wordpress.org/changeset/54136">[54136]</a>.
Props kebbet, audrasjb, sabernhardt, costdev, mukesh27.
Fixes <a href="https://core.trac.wordpress.org/ticket/56389">#56389</a>.
See <a href="https://core.trac.wordpress.org/ticket/54394">#54394</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesgeneraltemplatephp">trunk/src/wp-includes/general-template.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsgeneralwpRequiredFieldIndicatorphp">trunk/tests/phpunit/tests/general/wpRequiredFieldIndicator.php</a></li>
<li><a href="#trunktestsphpunittestsgeneralwpRequiredFieldMessagephp">trunk/tests/phpunit/tests/general/wpRequiredFieldMessage.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesgeneraltemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/general-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/general-template.php 2022-09-12 21:50:57 UTC (rev 54136)
+++ trunk/src/wp-includes/general-template.php 2022-09-12 22:29:02 UTC (rev 54137)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -5026,7 +5026,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $glyph = __( '*' );
</span><span class="cx" style="display: block; padding: 0 10px"> $indicator = '<span class="required">' . esc_html( $glyph ) . '</span>';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return $indicator;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * 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 );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -5043,7 +5050,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> sprintf( __( 'Required fields are marked %s' ), wp_required_field_indicator() )
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return $message;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * 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 );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre></div>
<a id="trunktestsphpunittestsgeneralwpRequiredFieldIndicatorphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/general/wpRequiredFieldIndicator.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/general/wpRequiredFieldIndicator.php (rev 0)
+++ trunk/tests/phpunit/tests/general/wpRequiredFieldIndicator.php 2022-09-12 22:29:02 UTC (rev 54137)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,45 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Test wp_required_field_indicator().
+ *
+ * @group general
+ * @group template
+ *
+ * @covers ::wp_required_field_indicator
+ */
+class Tests_General_wpRequiredFieldIndicator extends WP_UnitTestCase {
+
+ /**
+ * Tests that `wp_required_field_indicator()` returns the expected default value.
+ *
+ * @ticket 56389
+ */
+ public function test_wp_required_field_indicator_should_return_default_value() {
+ $this->assertSame( '<span class="required">*</span>', wp_required_field_indicator() );
+ }
+
+ /**
+ * Tests that `wp_required_field_indicator()` applies 'wp_required_field_indicator' filters.
+ *
+ * @ticket 56389
+ */
+ public function test_wp_required_field_indicator_should_apply_wp_required_field_indicator_filters() {
+ $filter = new MockAction();
+ add_filter( 'wp_required_field_indicator', array( &$filter, 'filter' ) );
+
+ wp_required_field_indicator();
+
+ $this->assertSame( 1, $filter->get_call_count() );
+ }
+
+ /**
+ * Tests that the final return value of `wp_required_field_indicator()` is the result of
+ * 'wp_required_field_indicator' filters.
+ *
+ * @ticket 56389
+ */
+ public function test_wp_required_field_indicator_should_return_wp_required_field_indicator_filters() {
+ add_filter( 'wp_required_field_indicator', '__return_empty_string' );
+ $this->assertSame( '', wp_required_field_indicator() );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/general/wpRequiredFieldIndicator.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="trunktestsphpunittestsgeneralwpRequiredFieldMessagephp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/general/wpRequiredFieldMessage.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/general/wpRequiredFieldMessage.php (rev 0)
+++ trunk/tests/phpunit/tests/general/wpRequiredFieldMessage.php 2022-09-12 22:29:02 UTC (rev 54137)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,48 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Test wp_required_field_message().
+ *
+ * @group general
+ * @group template
+ *
+ * @covers ::wp_required_field_message
+ */
+class Tests_General_wpRequiredFieldMessage extends WP_UnitTestCase {
+
+ /**
+ * Tests that `wp_required_field_message()` returns the expected default value.
+ *
+ * @ticket 56389
+ */
+ public function test_wp_required_field_message_should_return_default_value() {
+ $expected = '<span class="required-field-message">';
+ $expected .= 'Required fields are marked <span class="required">*</span>';
+ $expected .= '</span>';
+ $this->assertSame( $expected, wp_required_field_message() );
+ }
+
+ /**
+ * Tests that `wp_required_field_message()` applies 'wp_required_field_message' filters.
+ *
+ * @ticket 56389
+ */
+ public function test_wp_required_field_message_should_apply_wp_required_field_message_filters() {
+ $filter = new MockAction();
+ add_filter( 'wp_required_field_message', array( &$filter, 'filter' ) );
+
+ wp_required_field_message();
+
+ $this->assertSame( 1, $filter->get_call_count() );
+ }
+
+ /**
+ * Tests that the final return value of `wp_required_field_message()` is the result of
+ * 'wp_required_field_message' filters.
+ *
+ * @ticket 56389
+ */
+ public function test_wp_required_field_message_should_return_wp_required_field_message_filters() {
+ add_filter( 'wp_required_field_message', '__return_empty_string' );
+ $this->assertSame( '', wp_required_field_message() );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/general/wpRequiredFieldMessage.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span></div>
</body>
</html>