<!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>[55261] trunk: Privacy: Add `rel="privacy-policy"` to the Privacy Policy link.</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/55261">55261</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/55261","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>2023-02-07 14:03:26 +0000 (Tue, 07 Feb 2023)</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'>Privacy: Add `rel="privacy-policy"` to the Privacy Policy link.
This changeset adds a `rel="privacy-policy"` attribute to user-facing links to the Privacy Policy of the website, when a privacy policy page is set and available. While this `rel` value is still a RFC of the Link Types HTML specification, this changeset helps to make Privacy Policy link more discoverable for user agents and HTML parsers.
Props dshanske, audrasjb, bhavz-10, bookwyrm, faisal03, JeffPaul, peterwilsoncc, paapst, davidbaumwald, costdev, robinwpdeveloper, kawserz.
Fixes <a href="https://core.trac.wordpress.org/ticket/56345">#56345</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswalkernavmenuphp">trunk/src/wp-includes/class-walker-nav-menu.php</a></li>
<li><a href="#trunksrcwpincludeslinktemplatephp">trunk/src/wp-includes/link-template.php</a></li>
<li><a href="#trunktestsphpunittestslinkgetThePrivacyPolicyLinkphp">trunk/tests/phpunit/tests/link/getThePrivacyPolicyLink.php</a></li>
<li><a href="#trunktestsphpunittestsmenuwalkernavmenuphp">trunk/tests/phpunit/tests/menu/walker-nav-menu.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswalkernavmenuphp"></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-walker-nav-menu.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-walker-nav-menu.php 2023-02-07 13:51:39 UTC (rev 55260)
+++ trunk/src/wp-includes/class-walker-nav-menu.php 2023-02-07 14:03:26 UTC (rev 55261)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -182,7 +182,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $atts['rel'] = $menu_item->xfn;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $atts['href'] = ! empty( $menu_item->url ) ? $menu_item->url : '';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ if ( ! empty( $menu_item->url ) ) {
+ if ( get_privacy_policy_url() === $menu_item->url ) {
+ $atts['rel'] = empty( $atts['rel'] ) ? 'privacy-policy' : $atts['rel'] . ' privacy-policy';
+ }
+
+ $atts['href'] = $menu_item->url;
+ } else {
+ $atts['href'] = '';
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $atts['aria-current'] = $menu_item->current ? 'page' : '';
</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="trunksrcwpincludeslinktemplatephp"></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/link-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/link-template.php 2023-02-07 13:51:39 UTC (rev 55260)
+++ trunk/src/wp-includes/link-template.php 2023-02-07 14:03:26 UTC (rev 55261)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4664,7 +4664,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $privacy_policy_url && $page_title ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $link = sprintf(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '<a class="privacy-policy-link" href="%s">%s</a>',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '<a class="privacy-policy-link" href="%s" rel="privacy-policy">%s</a>',
</ins><span class="cx" style="display: block; padding: 0 10px"> esc_url( $privacy_policy_url ),
</span><span class="cx" style="display: block; padding: 0 10px"> esc_html( $page_title )
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span></span></pre></div>
<a id="trunktestsphpunittestslinkgetThePrivacyPolicyLinkphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/link/getThePrivacyPolicyLink.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/link/getThePrivacyPolicyLink.php 2023-02-07 13:51:39 UTC (rev 55260)
+++ trunk/tests/phpunit/tests/link/getThePrivacyPolicyLink.php 2023-02-07 14:03:26 UTC (rev 55261)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -160,4 +160,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public static function modify_link_markup( $link, $privacy_policy_url ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return 'Policy: ' . $privacy_policy_url;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Tests that `get_the_privacy_policy_link()` adds `rel="privacy-policy"`.
+ *
+ * @ticket 56345
+ */
+ public function test_get_the_privacy_policy_link_should_add_rel_privacy_policy() {
+ update_option( 'wp_page_for_privacy_policy', self::$privacy_policy_page_id );
+
+ $this->assertStringContainsString( 'rel="privacy-policy"', get_the_privacy_policy_link() );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestsmenuwalkernavmenuphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/menu/walker-nav-menu.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/menu/walker-nav-menu.php 2023-02-07 13:51:39 UTC (rev 55260)
+++ trunk/tests/phpunit/tests/menu/walker-nav-menu.php 2023-02-07 14:03:26 UTC (rev 55261)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -152,4 +152,217 @@
</span><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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Tests that `Walker_Nav_Menu::start_el()` adds `rel="privacy-policy"`.
+ *
+ * @ticket 56345
+ *
+ * @covers Walker_Nav_Menu::start_el
+ *
+ * @dataProvider data_walker_nav_menu_start_el_should_add_rel_privacy_policy_to_privacy_policy_url
+ *
+ * @param string $expected The expected substring containing the "rel" attribute and value.
+ * @param string $xfn Optional. The XFN value. Default empty string.
+ * @param string $target Optional. The target value. Default empty string.
+ */
+ public function test_walker_nav_menu_start_el_should_add_rel_privacy_policy_to_privacy_policy_url( $expected, $xfn = '', $target = '' ) {
+ $post_id = self::factory()->post->create(
+ array(
+ 'post_type' => 'page',
+ 'post_title' => 'Test Privacy Policy',
+ 'post_status' => 'publish',
+ )
+ );
+
+ // Set the privacy policy page.
+ update_option( 'wp_page_for_privacy_policy', $post_id );
+ $privacy_policy_id = (int) get_option( 'wp_page_for_privacy_policy' );
+
+ $output = '';
+
+ $item = array(
+ 'ID' => $privacy_policy_id,
+ 'object_id' => $privacy_policy_id,
+ 'title' => 'Privacy Policy',
+ 'target' => $target,
+ 'xfn' => $xfn,
+ 'current' => false,
+ 'url' => get_privacy_policy_url(),
+ );
+
+ $args = array(
+ 'before' => '',
+ 'after' => '',
+ 'link_before' => '',
+ 'link_after' => '',
+ );
+
+ $this->walker->start_el( $output, (object) $item, 0, (object) $args );
+
+ $this->assertStringContainsString( $expected, $output );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array[]
+ */
+ public function data_walker_nav_menu_start_el_should_add_rel_privacy_policy_to_privacy_policy_url() {
+ return array(
+ 'no xfn value' => array(
+ 'expected' => 'rel="privacy-policy"',
+ ),
+ 'an xfn value' => array(
+ 'expected' => 'rel="nofollow privacy-policy"',
+ 'xfn' => 'nofollow',
+ ),
+ 'no xfn value and a target of "_blank"' => array(
+ 'expected' => 'rel="noopener privacy-policy"',
+ 'xfn' => '',
+ 'target' => '_blank',
+ ),
+ 'an xfn value and a target of "_blank"' => array(
+ 'expected' => 'rel="nofollow privacy-policy"',
+ 'xfn' => 'nofollow',
+ 'target' => '_blank',
+ ),
+ );
+ }
+
+ /**
+ * Tests that `Walker_Nav_Menu::start_el()` does not add `rel="privacy-policy"` when no
+ * privacy policy page exists.
+ *
+ * @ticket 56345
+ *
+ * @covers Walker_Nav_Menu::start_el
+ */
+ public function test_walker_nav_menu_start_el_should_not_add_rel_privacy_policy_when_no_privacy_policy_exists() {
+ $post_id = self::factory()->post->create(
+ array(
+ 'post_type' => 'page',
+ 'post_title' => 'Test Privacy Policy',
+ 'post_status' => 'publish',
+ )
+ );
+
+ // Do not set the privacy policy page.
+
+ $output = '';
+
+ $item = array(
+ 'ID' => $post_id,
+ 'object_id' => $post_id,
+ 'title' => 'Privacy Policy',
+ 'target' => '',
+ 'xfn' => '',
+ 'current' => false,
+ 'url' => get_the_permalink( $post_id ),
+ );
+
+ $args = array(
+ 'before' => '',
+ 'after' => '',
+ 'link_before' => '',
+ 'link_after' => '',
+ );
+
+ $this->walker->start_el( $output, (object) $item, 0, (object) $args );
+
+ $this->assertStringNotContainsString( 'rel="privacy-policy"', $output );
+ }
+
+ /**
+ * Tests that `Walker_Nav_Menu::start_el()` does not add `rel="privacy-policy"` when no URL
+ * is passed in the menu item object.
+ *
+ * @ticket 56345
+ *
+ * @covers Walker_Nav_Menu::start_el
+ */
+ public function test_walker_nav_menu_start_el_should_not_add_rel_privacy_policy_when_no_url_is_passed() {
+ $post_id = self::factory()->post->create(
+ array(
+ 'post_type' => 'page',
+ 'post_title' => 'Test Privacy Policy',
+ 'post_status' => 'publish',
+ )
+ );
+
+ // Set the privacy policy page.
+ update_option( 'wp_page_for_privacy_policy', $post_id );
+ $privacy_policy_id = (int) get_option( 'wp_page_for_privacy_policy' );
+
+ $output = '';
+
+ $item = array(
+ 'ID' => $privacy_policy_id,
+ 'object_id' => $privacy_policy_id,
+ 'title' => 'Privacy Policy',
+ 'target' => '',
+ 'xfn' => '',
+ 'current' => false,
+ // Do not pass URL.
+ );
+
+ $args = array(
+ 'before' => '',
+ 'after' => '',
+ 'link_before' => '',
+ 'link_after' => '',
+ );
+
+ $this->walker->start_el( $output, (object) $item, 0, (object) $args );
+
+ $this->assertStringNotContainsString( 'rel="privacy-policy"', $output );
+ }
+
+ /**
+ * Tests that `Walker_Nav_Menu::start_el()` does not add `rel="privacy-policy"` when the
+ * menu item's ID does not match the privacy policy page, but the URL does.
+ *
+ * @ticket 56345
+ *
+ * @covers Walker_Nav_Menu::start_el
+ */
+ public function test_walker_nav_menu_start_el_should_add_rel_privacy_policy_when_id_does_not_match_but_url_does() {
+ $post_id = self::factory()->post->create(
+ array(
+ 'post_type' => 'page',
+ 'post_title' => 'Test Privacy Policy',
+ 'post_status' => 'publish',
+ )
+ );
+
+ // Set the privacy policy page.
+ update_option( 'wp_page_for_privacy_policy', $post_id );
+ $privacy_policy_id = (int) get_option( 'wp_page_for_privacy_policy' );
+
+ $output = '';
+
+ // Ensure the ID does not match the privacy policy.
+ $not_privacy_policy_id = $privacy_policy_id - 1;
+
+ $item = array(
+ 'ID' => $not_privacy_policy_id,
+ 'object_id' => $not_privacy_policy_id,
+ 'title' => 'Privacy Policy',
+ 'target' => '',
+ 'xfn' => '',
+ 'current' => false,
+ 'url' => get_privacy_policy_url(),
+ );
+
+ $args = array(
+ 'before' => '',
+ 'after' => '',
+ 'link_before' => '',
+ 'link_after' => '',
+ );
+
+ $this->walker->start_el( $output, (object) $item, 0, (object) $args );
+
+ $this->assertStringContainsString( 'rel="privacy-policy"', $output );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>