get_the_privacy_policy_link( string $before = '', string $after = '' ): string
- Since
- 4.9.6, 6.2.0
- Source
wp-includes/link-template.php:4813
Compatibility
- WordPress
- since 6.2.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$beforestringoptional- Display before privacy policy link. Default empty.Default:
'' $afterstringoptional- Display after privacy policy link. Default empty.Default:
''
Return value
string- Markup for the link and surrounding elements. Empty string if it doesn't exist.
Performance profile
How much work a call to get_the_privacy_policy_link() 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
- Scaling
- Constant
- Instructions
- 22–41
- Plugin surface
- 1 hook
- Called by
- 1
Reaches the database via get_post().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 43.
Third-party callbacks on 'the_privacy_policy_link' run inside this call, and their cost is not bounded by anything here.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- optionoption read or write
get_option()called directly - hookthird-party callbacks
apply_filters()called directly - cacheobject cache
wp_cache_get()one call below get_the_privacy_policy_link() - serializeserialisation
maybe_unserialize()one call below get_the_privacy_policy_link() - querycontent query
get_post()one call below get_the_privacy_policy_link()
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 · 4 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost get_the_privacy_policy_link() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 22–25 | get_privacy_policy_url(), get_option(), apply_filters() |
| always | 26–29 | get_privacy_policy_url(), get_option(), get_the_title(), apply_filters() |
| always | 35–37 | get_privacy_policy_url(), get_option(), esc_url(), esc_html(), apply_filters() |
| always | 39–41 | get_privacy_policy_url(), get_option(), get_the_title(), esc_url(), esc_html(), apply_filters() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 42 | 22–40 | 4 | 1 fewer instruction than PHP 8.5 |
| 8.5 | 43 | 22–41 | 4 | |
| 8.4 | 43 | 22–41 | 4 | |
| 8.3 | 43 | 22–41 | 4 | |
| 8.2 | 43 | 22–41 | 4 | |
| 8.1 | 43 | 22–41 | 4 | |
| 7.4 | 43 | 22–41 | 4 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Hooks and filters fired · 1
One hook fires while get_the_privacy_policy_link() runs, in this order:
- apply_filters( the_privacy_policy_link )filterline 4837 (+24 into the body)
Filters the privacy policy link.
Uses · 6
- get_privacy_policy_url()Retrieves the URL to the privacy policy page.
- get_option()Retrieves an option value based on an option name.
- get_the_title()Retrieves the post title.
- esc_url()Checks and cleans a URL.
- esc_html()Escaping for HTML blocks.
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 1
- the_privacy_policy_link()Displays the privacy policy link with formatting, when applicable.
Source code
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" rel="privacy-policy">%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 '';}Changelog
Introduced in 4.9.6. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.0.4 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.