get_privacy_policy_url(): string

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Return value

string

The URL to the privacy policy page. Empty string if it doesn't exist.

Performance profile

How much work a call to get_privacy_policy_url() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via get_post().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

13–23

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 23.

Plugin surface

1 hook

Third-party callbacks on 'privacy_policy_url' run inside this call, and their cost is not bounded by anything here.

Called by

3

3 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• optionoption read or writeget_option()called directly
• hookthird-party callbacksapply_filters()called directly
• cacheobject cachewp_cache_get()one call below get_privacy_policy_url()
• serializeserialisationmaybe_unserialize()one call below get_privacy_policy_url()
• querycontent queryget_post()one call below get_privacy_policy_url()

Further down the call graph this can also reach transient. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 3 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost get_privacy_policy_url() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while get_privacy_policy_url() runs, in this order:

1. 1
   apply_filters( privacy_policy_url )filterline 4787 (+17 into the body)

   Filters the URL of the privacy policy page.

Uses · 4

• get_option()Retrieves an option value based on an option name.
• get_post_status()Retrieves the post status based on the post ID.
• get_permalink()Retrieves the full permalink for the current post or post ID.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 3

• Walker_Nav_Menu::__construct()Constructor.
• _wp_privacy_send_erasure_fulfillment_notification()Notifies the user when their erasure request is fulfilled.
• get_the_privacy_policy_link()Returns the privacy policy link with formatting, when applicable.

Source code

View on Trac ↗View on GitHub ↗

4770function get_privacy_policy_url() {4771	$url            = '';4772	$policy_page_id = (int) get_option( 'wp_page_for_privacy_policy' );4773 4774	if ( ! empty( $policy_page_id ) && get_post_status( $policy_page_id ) === 'publish' ) {4775		$url = (string) get_permalink( $policy_page_id );4776	}4777 4778	/**4779	 * Filters the URL of the privacy policy page.4780	 *4781	 * @since 4.9.64782	 *4783	 * @param string $url            The URL to the privacy policy page. Empty string4784	 *                               if it doesn't exist.4785	 * @param int    $policy_page_id The ID of privacy policy page.4786	 */4787	return apply_filters( 'privacy_policy_url', $url, $policy_page_id );4788}

Changelog

Introduced in 4.9.6. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/link-template.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.