wppaste
WordPress

capital_P_dangit( string $text ): string

Since
3.0.0
Source
wp-includes/formatting.php:5691
Forever eliminate "Wordpress" from the planet (or at least the little bit we can influence).

Description

Violating our coding standards for a good function name.

Compatibility

WordPress
since 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

$textstring
The text to be modified.

Return value

string
The modified text.

Performance profile

How much work a call to capital_P_dangit() 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
9–31

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 34.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

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

What one call costs · 2 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost capital_P_dangit() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always9–26current_filter()
$current_filter !== "the_title" && $current_filter !== "wp_title" && $dblq === false31current_filter(), _x()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev349–313
8.5349–313
8.4349–3136 fewer instructions than PHP 8.3
8.34012–343
8.24012–343
8.14012–343
7.44012–343

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

  • current_filter()Retrieves the name of the current filter hook.
  • _x()Retrieves translated string with gettext context.

Source code

function capital_P_dangit( $text ) {	// Simple replacement for titles.	$current_filter = current_filter();	if ( 'the_title' === $current_filter || 'wp_title' === $current_filter ) {		return str_replace( 'Wordpress', 'WordPress', $text );	}	// Still here? Use the more judicious replacement.	static $dblq = false;	if ( false === $dblq ) {		$dblq = _x( '“', 'opening curly double quote' );	}	return str_replace(		array( ' Wordpress', '‘Wordpress', $dblq . 'Wordpress', '>Wordpress', '(Wordpress' ),		array( ' WordPress', '‘WordPress', $dblq . 'WordPress', '>WordPress', '(WordPress' ),		$text	);}

Changelog

Introduced in 3.0.0. Unchanged from 6.7.7 through 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.

About this page

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