wp_original_referer_field( bool $display = true, string $jump_back_to = 'current' ): string
- Since
- 2.0.4
- Source
wp-includes/functions.php:1949
Description
The input name is '_wp_original_http_referer' and will be either the same value of wp_referer_field(), if that was posted already or it will be the current page, if it doesn't exist.
Compatibility
- WordPress
- since 2.0.4
- 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
$displaybooloptional- Whether to echo the original http referer. Default true.Default:
true $jump_back_tostringoptional- Can be 'previous' or page you want to jump back to.
Default 'current'.Default:'current'
Return value
string- Original referer field.
Performance profile
How much work a call to wp_original_referer_field() 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
- Trivial
- Scaling
- Constant
- Instructions
- 13–24
- Plugin surface
- None
- Called by
- 1
Touches nothing outside its own arguments.
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 28.
Nothing here hands control to plugin code.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()one call below wp_original_referer_field()
Further down the call graph this can also reach option, cache, serialize, query and transient. Those are 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 wp_original_referer_field() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 13–14 | wp_get_original_referer(), esc_attr() |
$jump_back_to === "previous" | 20–21 | wp_get_original_referer(), wp_get_referer(), esc_attr() |
$jump_back_to !== "previous" | 23–24 | wp_get_original_referer(), wp_unslash(), esc_attr() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 26 | 13–23 | 3 | 2 fewer instructions than PHP 8.5 |
| 8.5 | 28 | 13–24 | 3 | |
| 8.4 | 28 | 13–24 | 3 | |
| 8.3 | 28 | 13–24 | 3 | |
| 8.2 | 28 | 13–24 | 3 | |
| 8.1 | 28 | 13–24 | 3 | |
| 7.4 | 28 | 13–24 | 3 |
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.
Uses · 4
- wp_get_original_referer()Retrieves original referer that was posted, if it exists.
- wp_get_referer()Retrieves referer from '_wp_http_referer' or HTTP referer.
- wp_unslash()Removes slashes from a string or recursively removes slashes from strings within an array.
- esc_attr()Escaping for HTML attributes.
Used by · 1
- the_block_editor_meta_box_post_form_hidden_fields()Renders the hidden form required for the meta boxes form.
Source code
function wp_original_referer_field( $display = true, $jump_back_to = 'current' ) { $ref = wp_get_original_referer(); if ( ! $ref ) { $ref = ( 'previous' === $jump_back_to ) ? wp_get_referer() : wp_unslash( $_SERVER['REQUEST_URI'] ); } $orig_referer_field = '<input type="hidden" name="_wp_original_http_referer" value="' . esc_attr( $ref ) . '" />'; if ( $display ) { echo $orig_referer_field; } return $orig_referer_field;}Changelog
Introduced in 2.0.4. 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 6.8.8 tag, from
src/wp-includes/functions.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.