wppaste
WordPress

wp_get_list_item_separator(): string

Since
6.0.0
Source
wp-includes/l10n.php:2040
Retrieves the list item separator based on the locale.

Compatibility

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

Return value

string
Locale-specific list item separator.

Performance profile

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

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
21

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

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

WhenInstructionsCalls it makes
$wp_locale instanceof6->get_list_item_separator()
!($wp_locale instanceof)7__()

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, 6–7 executed per call, 1 branch. 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.

Uses · 1

  • __()Retrieves the translation of $text.

Used by · 21

Show all 21

Source code

function wp_get_list_item_separator() {	global $wp_locale; 	if ( ! ( $wp_locale instanceof WP_Locale ) ) {		// Default value of WP_Locale::get_list_item_separator().		/* translators: Used between list items, there is a space after the comma. */		return __( ', ' );	} 	return $wp_locale->get_list_item_separator();}

Changelog

Introduced in 6.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 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.