wp_should_disable_pings_for_environment(): bool
- Since
- 7.1.0
- Source
wp-includes/comment.php:3436
Description
By default, all pings (outgoing pingbacks, trackbacks, and ping service notifications, as well as incoming pingbacks and trackbacks) are disabled for non-production environments ('local', 'development', 'staging').
Compatibility
- WordPress
- since 7.1.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in 1 of the 5 tracked releases, added in 7.1.0, and compiles on PHP 7.4 through 8.6-dev.
Return value
bool- True if pings should be disabled, false otherwise.
Performance profile
How much work a call to wp_should_disable_pings_for_environment() 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
- 10
- Plugin surface
- 1 hook
- Called by
- 3
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. The body compiles to 10.
Third-party callbacks on 'wp_should_disable_pings_for_environment' run inside this call, and their cost is not bounded by anything here.
3 places 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 query, option, cache, serialize 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 · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_should_disable_pings_for_environment() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 10 | wp_get_environment_type(), apply_filters() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 10 instructions, 10 executed per call, 0 branches. The work does not change between versions.
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 wp_should_disable_pings_for_environment() runs, in this order:
- apply_filters( wp_should_disable_pings_for_environment )filterline 3453 (+17 into the body)
Filters whether pings should be disabled for the current environment.
Uses · 2
- wp_get_environment_type()Retrieves the current environment type.
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 3
- wp_maybe_disable_outgoing_pings_for_environment()Removes outgoing ping callbacks in non-production environments.
- wp_maybe_disable_trackback_for_environment()Rejects incoming trackbacks in non-production environments.
- wp_maybe_disable_xmlrpc_pingback_for_environment()Removes the pingback XML-RPC method in non-production environments.
Source code
function wp_should_disable_pings_for_environment() { $environment_type = wp_get_environment_type(); $should_disable = 'production' !== $environment_type; /** * Filters whether pings should be disabled for the current environment. * * Returning false re-enables pings in non-production environments. * Returning true disables pings even in production. * * @since 7.1.0 * * @param bool $should_disable Whether pings should be disabled. Default true * for non-production environments, false for production. * @param string $environment_type The current environment type as returned by * wp_get_environment_type(). */ return apply_filters( 'wp_should_disable_pings_for_environment', $should_disable, $environment_type );}Changelog
Introduced in 7.1.0.
Signature, return type and hooks compared across 1 parsed release.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/comment.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.