wppaste
WordPress

before_last_bar( string $text ): string

Since
2.8.0
Source
wp-includes/l10n.php:236
Removes last item on a pipe-delimited string.

Description

Meant for removing the last item in a string, such as 'Role name|User role'. The original string will be returned if no pipe '|' characters are found in the string.

Compatibility

WordPress
since 2.8.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
A pipe-delimited string.

Return value

string
Either $text or everything before the last pipe.

Performance profile

How much work a call to before_last_bar() 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
8–10

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
4

4 places in core call this, so the cost is paid more often than your own code shows.

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 before_last_bar() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always8–10strrpos()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev118–101
8.5118–101
8.4118–1013 fewer instructions than PHP 8.3
8.3148–131
8.2148–131
8.1148–131
7.4148–131

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.

Used by · 4

  • _c()Retrieve translated string with vertical bar context
  • _nc()Legacy version of _n(), which supports contexts.
  • translate_user_role()Translates role name.
  • translate_with_context()Translates $text like translate(), but assumes that the text contains a context after its last vertical bar.

Source code

function before_last_bar( $text ) {	$last_bar = strrpos( $text, '|' );	if ( false === $last_bar ) {		return $text;	} else {		return substr( $text, 0, $last_bar );	}}

Changelog

Introduced in 2.8.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 7.0.4 tag, from src/wp-includes/l10n.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.