Changeset 43109

Timestamp:

05/02/2018 03:38:23 AM (8 years ago)

Author:

SergeyBiryukov

Message:

Privacy: Add template tags for building link to privacy policy page.

This introduces the get_the_privacy_policy_link() and the_privacy_policy_link() functions, as well as the privacy_policy_url filter.

A new tests/url/ folder was added to better organize tests related to get_*_url() functions. Previously, those tests were placed in tests/url.php and tests/link/, but neither of those locations are optimal. Placing tests in tests/url.php violates the guideline of creating separate files/classes for each function under test, and using tests/link/ conflates two distinct -- albeit related -- groups of functions. Over time, URL-related tests can be migrated to the new folder.

Props birgire, xkon, azaozz, iandunn.
Merges [43002] to the 4.9 branch.
See #43850.

Location:

branches/4.9

Files:

• . (modified) (1 prop)
• src/wp-includes/link-template.php (modified) (1 diff)
• tests/phpunit/tests/link/getThePrivacyPolicyLink.php (copied) (copied from trunk/tests/phpunit/tests/link/getThePrivacyPolicyLink.php )
• tests/phpunit/tests/url (copied) (copied from trunk/tests/phpunit/tests/url )

branches/4.9/src/wp-includes/link-template.php

@@ -4114 +4114 @@
  */
 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 );
+        }
+
+        /**
+         * 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    $policy_page_id 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;
         }