is_allowed_http_origin( string|null $origin = null ): string
- Since
- 3.4.0
- Source
wp-includes/http.php:484
Compatibility
- WordPress
- since 3.4.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
$originstring|nulloptional- Origin URL. If not provided, the value of get_http_origin() is used.Default:
null
Return value
string- Origin URL if allowed, empty string if not.
Performance profile
How much work a call to is_allowed_http_origin() 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
- 11–20
- Plugin surface
- 1 hook
- 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 20.
Third-party callbacks on 'allowed_http_origin' 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
- hookthird-party callbacks
apply_filters()called directly
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 · 4 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost is_allowed_http_origin() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
$origin !== null | 11 | apply_filters() |
$origin === null | 14 | get_http_origin(), apply_filters() |
$origin !== null | 16–17 | get_allowed_http_origins(), apply_filters() |
$origin === null | 19–20 | get_http_origin(), get_allowed_http_origins(), apply_filters() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 20 | 11–20 | 3 | |
| 8.5 | 20 | 11–20 | 3 | |
| 8.4 | 20 | 11–20 | 3 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 23 | 11–23 | 3 | |
| 8.2 | 23 | 11–23 | 3 | |
| 8.1 | 23 | 11–23 | 3 | |
| 7.4 | 23 | 11–23 | 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.
Hooks and filters fired · 1
One hook fires while is_allowed_http_origin() runs, in this order:
- apply_filters( allowed_http_origin )filterline 503 (+19 into the body)
Changes the allowed HTTP origin result.
Uses · 3
- get_http_origin()Gets the HTTP Origin of the current request.
- get_allowed_http_origins()Retrieves list of allowed HTTP origins.
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 1
- send_origin_headers()Sends Access-Control-Allow-Origin and related headers if the current request is from an allowed origin.
Source code
function is_allowed_http_origin( $origin = null ) { $origin_arg = $origin; if ( null === $origin ) { $origin = get_http_origin(); } if ( $origin && ! in_array( $origin, get_allowed_http_origins(), true ) ) { $origin = ''; } /** * Changes the allowed HTTP origin result. * * @since 3.4.0 * * @param string $origin Origin URL if allowed, empty string if not. * @param string $origin_arg Original origin string passed into is_allowed_http_origin function. */ return apply_filters( 'allowed_http_origin', $origin, $origin_arg );}Changelog
Introduced in 3.4.0. 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.9.7 tag, from
src/wp-includes/http.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.