<!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>[59948] trunk/src: Menus: Validate custom links and add accessible error messages.</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/59948">59948</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/59948","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>joedolson</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2025-03-06 23:46:47 +0000 (Thu, 06 Mar 2025)</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'>Menus: Validate custom links and add accessible error messages.
Add URL validation in the admin navigation menu manager that matches the validation in the customizer when adding custom links. Improve accessibility of both custom link forms by adding `aria-invalid` and `aria-describedby` attributes with visible error messages and announcing the error using `wp.a11y.speak()`.
Props joedolson, nikitasolanki1812, akrocks, pathan-amaankhan, rcreators, ironprogrammer, audrasjb, ankit-k-gupta, chaion07, rinkalpagdar, snehapatil02, jainil07, parthvataliya.
Fixes <a href="https://core.trac.wordpress.org/ticket/60619">#60619</a>, <a href="https://core.trac.wordpress.org/ticket/60969">#60969</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcjs_enqueueslibnavmenujs">trunk/src/js/_enqueues/lib/nav-menu.js</a></li>
<li><a href="#trunksrcjs_enqueueswpcustomizenavmenusjs">trunk/src/js/_enqueues/wp/customize/nav-menus.js</a></li>
<li><a href="#trunksrcwpadmincssnavmenuscss">trunk/src/wp-admin/css/nav-menus.css</a></li>
<li><a href="#trunksrcwpadminincludesnavmenuphp">trunk/src/wp-admin/includes/nav-menu.php</a></li>
<li><a href="#trunksrcwpincludesclasswpcustomizenavmenusphp">trunk/src/wp-includes/class-wp-customize-nav-menus.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcjs_enqueueslibnavmenujs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/js/_enqueues/lib/nav-menu.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/js/_enqueues/lib/nav-menu.js 2025-03-06 21:19:10 UTC (rev 59947)
+++ trunk/src/js/_enqueues/lib/nav-menu.js 2025-03-06 23:46:47 UTC (rev 59948)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1102,7 +1102,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }, 500 ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $('#add-custom-links input[type="text"]').on( 'keypress', function(e){
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $('#customlinkdiv').removeClass('form-invalid');
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $( '#customlinkdiv' ).removeClass( 'form-invalid' );
+ $( '#custom-menu-item-url' ).removeAttr( 'aria-invalid' ).removeAttr( 'aria-describedby' );
+ $( '#custom-url-error' ).hide();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( e.keyCode === 13 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> e.preventDefault();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1109,6 +1111,44 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $( '#submit-customlinkdiv' ).trigger( 'click' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> });
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $( '#submit-customlinkdiv' ).on( 'click', function (e) {
+ var urlInput = $( '#custom-menu-item-url' ),
+ url = urlInput.val().trim(),
+ errorMessage = $( '#custom-url-error' ),
+ urlWrap = $( '#menu-item-url-wrap' ),
+ urlRegex;
+
+ // Hide the error message initially
+ errorMessage.hide();
+ urlWrap.removeClass( 'has-error' );
+
+ /*
+ * Allow URLs including:
+ * - http://example.com/
+ * - //example.com
+ * - /directory/
+ * - ?query-param
+ * - #target
+ * - mailto:foo@example.com
+ *
+ * Any further validation will be handled on the server when the setting is attempted to be saved,
+ * so this pattern does not need to be complete.
+ */
+ urlRegex = /^((\w+:)?\/\/\w.*|\w+:(?!\/\/$)|\/|\?|#)/;
+ if ( ! urlRegex.test( url ) ) {
+ e.preventDefault();
+ urlInput.addClass( 'form-invalid' )
+ .attr( 'aria-invalid', 'true' )
+ .attr( 'aria-describedby', 'custom-url-error' );
+
+ errorMessage.show();
+ var errorText = errorMessage.text();
+ urlWrap.addClass( 'has-error' );
+ // Announce error message via screen reader
+ wp.a11y.speak( errorText, 'assertive' );
+ }
+ });
</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">@@ -1389,7 +1429,8 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> addCustomLink : function( processMethod ) {
</span><span class="cx" style="display: block; padding: 0 10px"> var url = $('#custom-menu-item-url').val().toString(),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- label = $('#custom-menu-item-name').val();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ label = $('#custom-menu-item-name').val(),
+ urlRegex;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( '' !== url ) {
</span><span class="cx" style="display: block; padding: 0 10px"> url = url.trim();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1397,7 +1438,20 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> processMethod = processMethod || api.addMenuItemToBottom;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( '' === url || 'https://' == url || 'http://' == url ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * Allow URLs including:
+ * - http://example.com/
+ * - //example.com
+ * - /directory/
+ * - ?query-param
+ * - #target
+ * - mailto:foo@example.com
+ *
+ * Any further validation will be handled on the server when the setting is attempted to be saved,
+ * so this pattern does not need to be complete.
+ */
+ urlRegex = /^((\w+:)?\/\/\w.*|\w+:(?!\/\/$)|\/|\?|#)/;
+ if ( ! urlRegex.test( url ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $('#customlinkdiv').addClass('form-invalid');
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcjs_enqueueswpcustomizenavmenusjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/js/_enqueues/wp/customize/nav-menus.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/js/_enqueues/wp/customize/nav-menus.js 2025-03-06 21:19:10 UTC (rev 59947)
+++ trunk/src/js/_enqueues/wp/customize/nav-menus.js 2025-03-06 23:46:47 UTC (rev 59948)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -223,6 +223,9 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> this.$el.on( 'input', '#custom-menu-item-name.invalid, #custom-menu-item-url.invalid', function() {
</span><span class="cx" style="display: block; padding: 0 10px"> $( this ).removeClass( 'invalid' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ var errorMessageId = $( this ).attr( 'aria-describedby' );
+ $( '#' + errorMessageId ).hide();
+ $( this ).removeAttr( 'aria-invalid' ).removeAttr( 'aria-describedby' );
</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"> // Load available items if it looks like we'll need them.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -546,8 +549,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> var menuItem,
</span><span class="cx" style="display: block; padding: 0 10px"> itemName = $( '#custom-menu-item-name' ),
</span><span class="cx" style="display: block; padding: 0 10px"> itemUrl = $( '#custom-menu-item-url' ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ urlErrorMessage = $( '#custom-url-error' ),
+ nameErrorMessage = $( '#custom-name-error' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> url = itemUrl.val().trim(),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- urlRegex;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ urlRegex,
+ errorText;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! this.currentMenuControl ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -566,15 +572,37 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * so this pattern does not need to be complete.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> urlRegex = /^((\w+:)?\/\/\w.*|\w+:(?!\/\/$)|\/|\?|#)/;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- if ( '' === itemName.val() ) {
- itemName.addClass( 'invalid' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! urlRegex.test( url ) || '' === itemName.val() ) {
+ if ( ! urlRegex.test( url ) ) {
+ itemUrl.addClass( 'invalid' )
+ .attr( 'aria-invalid', 'true' )
+ .attr( 'aria-describedby', 'custom-url-error' );
+ urlErrorMessage.show();
+ errorText = urlErrorMessage.text();
+ // Announce error message via screen reader
+ wp.a11y.speak( errorText, 'assertive' );
+ }
+ if ( '' === itemName.val() ) {
+ itemName.addClass( 'invalid' )
+ .attr( 'aria-invalid', 'true' )
+ .attr( 'aria-describedby', 'custom-name-error' );
+ nameErrorMessage.show();
+ errorText = ( '' === errorText ) ? nameErrorMessage.text() : errorText + nameErrorMessage.text();
+ // Announce error message via screen reader
+ wp.a11y.speak( errorText, 'assertive' );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> return;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- } else if ( ! urlRegex.test( url ) ) {
- itemUrl.addClass( 'invalid' );
- return;
</del><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ urlErrorMessage.hide();
+ nameErrorMessage.hide();
+ itemName.removeClass( 'invalid' )
+ .removeAttr( 'aria-invalid', 'true' )
+ .removeAttr( 'aria-describedby', 'custom-name-error' );
+ itemUrl.removeClass( 'invalid' )
+ .removeAttr( 'aria-invalid', 'true' )
+ .removeAttr( 'aria-describedby', 'custom-name-error' );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> menuItem = {
</span><span class="cx" style="display: block; padding: 0 10px"> 'title': itemName.val(),
</span><span class="cx" style="display: block; padding: 0 10px"> 'url': url,
</span></span></pre></div>
<a id="trunksrcwpadmincssnavmenuscss"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/css/nav-menus.css</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/css/nav-menus.css 2025-03-06 21:19:10 UTC (rev 59947)
+++ trunk/src/wp-admin/css/nav-menus.css 2025-03-06 23:46:47 UTC (rev 59948)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -377,11 +377,16 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /* Add Menu Item Boxes */
</span><span class="cx" style="display: block; padding: 0 10px"> .postbox .howto input,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-.customlinkdiv .menu-item-textbox {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+.customlinkdiv .menu-item-textbox,
+.customlinkdiv .error-message {
</ins><span class="cx" style="display: block; padding: 0 10px"> width: 180px;
</span><span class="cx" style="display: block; padding: 0 10px"> float: right;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+.customlinkdiv .error-message {
+ clear: right;
+}
+
</ins><span class="cx" style="display: block; padding: 0 10px"> .accordion-container .outer-border {
</span><span class="cx" style="display: block; padding: 0 10px"> margin: 0;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcwpadminincludesnavmenuphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/nav-menu.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/nav-menu.php 2025-03-06 21:19:10 UTC (rev 59947)
+++ trunk/src/wp-admin/includes/nav-menu.php 2025-03-06 23:46:47 UTC (rev 59948)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -351,6 +351,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> type="text"<?php wp_nav_menu_disabled_check( $nav_menu_selected_id ); ?>
</span><span class="cx" style="display: block; padding: 0 10px"> class="code menu-item-textbox form-required" placeholder="https://"
</span><span class="cx" style="display: block; padding: 0 10px"> />
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <span id="custom-url-error" class="error-message" style="display: none;"><?php _e( 'Please provide a valid link.' ); ?></span>
</ins><span class="cx" style="display: block; padding: 0 10px"> </p>
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> <p id="menu-item-name-wrap" class="wp-clearfix">
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpcustomizenavmenusphp"></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/class-wp-customize-nav-menus.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-customize-nav-menus.php 2025-03-06 21:19:10 UTC (rev 59947)
+++ trunk/src/wp-includes/class-wp-customize-nav-menus.php 2025-03-06 23:46:47 UTC (rev 59948)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1268,10 +1268,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <p id="menu-item-url-wrap" class="wp-clearfix">
</span><span class="cx" style="display: block; padding: 0 10px"> <label class="howto" for="custom-menu-item-url"><?php _e( 'URL' ); ?></label>
</span><span class="cx" style="display: block; padding: 0 10px"> <input id="custom-menu-item-url" name="menu-item[-1][menu-item-url]" type="text" class="code menu-item-textbox" placeholder="https://">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <span id="custom-url-error" class="error-message" style="display: none;"><?php _e( 'Please provide a valid link.' ); ?></span>
</ins><span class="cx" style="display: block; padding: 0 10px"> </p>
</span><span class="cx" style="display: block; padding: 0 10px"> <p id="menu-item-name-wrap" class="wp-clearfix">
</span><span class="cx" style="display: block; padding: 0 10px"> <label class="howto" for="custom-menu-item-name"><?php _e( 'Link Text' ); ?></label>
</span><span class="cx" style="display: block; padding: 0 10px"> <input id="custom-menu-item-name" name="menu-item[-1][menu-item-title]" type="text" class="regular-text menu-item-textbox">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <span id="custom-name-error" class="error-message" style="display: none;"><?php _e( 'The link text cannot be empty.' ); ?></span>
</ins><span class="cx" style="display: block; padding: 0 10px"> </p>
</span><span class="cx" style="display: block; padding: 0 10px"> <p class="button-controls">
</span><span class="cx" style="display: block; padding: 0 10px"> <span class="add-to-menu">
</span></span></pre>
</div>
</div>
</body>
</html>