get_the_privacy_policy_link() WordPress Function

The get_the_privacy_policy_link() function is used to retrieve the privacy policy link for the site. This function is useful for displaying the privacy policy link in the footer of the site or in the sidebar.

get_the_privacy_policy_link( string $before = '', string $after = '' ) #

Returns the privacy policy link with formatting, when applicable.


Parameters

$before

(string)(Optional) Display before privacy policy link.

Default value: ''

$after

(string)(Optional) Display after privacy policy link.

Default value: ''


Top ↑

Return

(string) Markup for the link and surrounding elements. Empty string if it doesn't exist.


Top ↑

Source

File: wp-includes/link-template.php

function get_the_privacy_policy_link( $before = '', $after = '' ) {
	$link               = '';
	$privacy_policy_url = get_privacy_policy_url();
	$policy_page_id     = (int) get_option( 'wp_page_for_privacy_policy' );
	$page_title         = ( $policy_page_id ) ? get_the_title( $policy_page_id ) : '';

	if ( $privacy_policy_url && $page_title ) {
		$link = sprintf(
			'<a class="privacy-policy-link" href="%s">%s</a>',
			esc_url( $privacy_policy_url ),
			esc_html( $page_title )
		);
	}

	/**
	 * 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 '';
}


Top ↑

Changelog

Changelog
VersionDescription
4.9.6Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.

Show More
Show More