wppaste
WordPress

graceful_fail( $message ): never

Since
MU (3.0.0)
Source
wp-includes/ms-deprecated.php:91
Deprecated functionality to gracefully fail.

Compatibility

Deprecated in WordPress 3.0.0. Use wp_die()

WordPress
since MU (3.0.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

$message

Return value

never

Performance profile

How much work a call to graceful_fail() 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

Touches nothing outside its own arguments.

Scaling
Constant

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

Instructions
24

Executed per call on PHP 8.5. The body compiles to 24.

Plugin surface
2 hooks

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

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

  • hookthird-party callbacksapply_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 graceful_fail() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always24_deprecated_function(), apply_filters(), apply_filters(), sprintf(), exit()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev24240
8.524240
8.4242403 more instructions than PHP 8.3
8.321210
8.221210
8.121210
7.421210

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 · 2

2 hooks fire while graceful_fail() runs, in this order:

  1. apply_filters( graceful_fail )filterline 93 (+2 into the body)
  2. apply_filters( graceful_fail_template )filterline 94 (+3 into the body)

Uses · 2

Source code

function graceful_fail( $message ) {	_deprecated_function( __FUNCTION__, '3.0.0', 'wp_die()' );	$message = apply_filters( 'graceful_fail', $message );	$message_template = apply_filters( 'graceful_fail_template','<!DOCTYPE html><html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Error!</title><style>img {	border: 0;}body {line-height: 1.6em; font-family: Georgia, serif; width: 390px; margin: auto;text-align: center;}.message {	font-size: 22px;	width: 350px;	margin: auto;}</style></head><body><p class="message">%s</p></body></html>' );	die( sprintf( $message_template, $message ) );}

Changelog

Introduced in MU (3.0.0). One change between 6.7.7 and 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.

7.1.0
Return type changed from none to never.verified against source
3.0.0
Deprecated. Use wp_die()from the docblock
MU (3.0.0)
MU (3.0.0)from the docblock

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/ms-deprecated.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.