Ticket #43620: 43620.policy_url.policy_link_4.diff

src/wp-includes/link-template.php

@@ -4282 +4282 @@
  * @return string The URL to the privacy policy page. Empty string if it doesn't exist.
  */
 function get_privacy_policy_url() {
+        $url            = '';
         $policy_page_id = (int) get_option( 'wp_page_for_privacy_policy' );
 
         if ( ! empty( $policy_page_id ) && get_post_status( $policy_page_id ) === 'publish' ) {
-                return get_permalink( $policy_page_id );
+                $url = (string) get_permalink( $policy_page_id );
         }
 
-        return '';
+        /**
+         * Filters the URL of the privacy policy page.
+         *
+         * @since 4.9.6
+         *
+         * @param string $url  The URL to the privacy policy page. Empty string if it
+         *                     doesn't exist.
+         * @param int    $file The ID of privacy policy page.
+         */
+        return apply_filters( 'privacy_policy_url', $url, $policy_page_id );
+}
+
+/**
+ * Displays the privacy policy link with formatting, when applicable.
+ *
+ * @since 4.9.6
+ *
+ * @param string $before Optional. Display before privacy policy link. Default empty.
+ * @param string $after  Optional. Display after privacy policy link. Default empty.
+ */
+function the_privacy_policy_link( $before = '', $after = '' ) {
+        echo get_the_privacy_policy_link( $before, $after );
+}
+
+/**
+ * Returns the privacy policy link with formatting, when applicable.
+ *
+ * @since 4.9.6
+ *
+ * @param string $before Optional. Display before privacy policy link. Default empty.
+ * @param string $after  Optional. Display after privacy policy link. Default empty.
+ *
+ * @return string Markup for the link and surrounding elements. Empty string if it
+ *                doesn't exist.
+ */
+function get_the_privacy_policy_link( $before = '', $after = '' ) {
+        $link               = '';
+        $privacy_policy_url = get_privacy_policy_url();
+
+        if ( $privacy_policy_url ) {
+                $link = sprintf(
+                        '<a class="privacy-policy-link" href="%s">%s</a>',
+                        esc_url( $privacy_policy_url ),
+                        __( 'Privacy Policy' )
+                );
+        }
+
+        /**
+         * Filters the privacy policy link.
+         *
+         * @since 4.9.6
+         *
+         * @param string $link               The privacy policy link. Empty string if it
+         *                                   doesn't exist.
+         * @param string $privacy_policy_url The URL of the privacy policy. Empty string
+         *                                   if it doesn't exist.
+         */
+        $link = apply_filters( 'the_privacy_policy_link', $link, $privacy_policy_url );
+
+        if ( $link ) {
+                return $before . $link . $after;
+        }
+
+        return $link;
 }

tests/phpunit/tests/url.php

@@ -527 +527 @@
                         );
                 }
         }
+
+        /**
+         * Test `get_privacy_policy_url()`.
+         *
+         * @ticket 43620.
+         */
+        public function test_get_privacy_policy_url() {
+                $privacy_policy_page_id = self::factory()->post->create(
+                        array(
+                                'post_type'  => 'page',
+                                'post_title' => 'Privacy Policy'
+                        )
+                );
+                $expected_url = get_permalink( $privacy_policy_page_id );
+
+                $this->assertSame( '', get_privacy_policy_url() );
+
+                update_option( 'wp_page_for_privacy_policy', $privacy_policy_page_id );
+                $this->assertSame( $expected_url, get_privacy_policy_url() );
+        }
+
+        /**
+         * Test `get_the_privacy_policy_link()`.
+         *
+         * @ticket 43620.
+         */
+        public function test_get_the_privacy_policy_link() {
+                $privacy_policy_page_id = self::factory()->post->create(
+                        array(
+                                'post_type'  => 'page',
+                                'post_title' => WP_TESTS_DOMAIN . ' Privacy Policy'
+                        )
+                );
+
+                $before       = '<span class="privacy-policy-link-wrapper">';
+                $after        = '</span>';
+                $expected_url = get_permalink( $privacy_policy_page_id );
+
+                // Empty strings when a page is not set.
+                $this->assertSame( '', get_the_privacy_policy_link() );
+                $this->assertSame( '', get_the_privacy_policy_link( $before, $after ) );
+
+                // Valid link markup when a page is set.
+                update_option( 'wp_page_for_privacy_policy', $privacy_policy_page_id );
+                $link = get_the_privacy_policy_link();
+
+                $this->assertContains( $expected_url, $link );
+                $this->assertStringStartsWith( '<a', $link );
+                $this->assertStringEndsWith( '</a>', $link );
+
+                $link = get_the_privacy_policy_link( $before, $after );
+
+                $this->assertContains( $expected_url, $link );
+                $this->assertStringStartsWith( $before . '<a', $link );
+                $this->assertStringEndsWith( '</a>' . $after, $link );
+        }
 }