sanitize_locale_name( string $locale_name ): string
- Since
- 6.2.1
- Source
wp-includes/formatting.php:2468
Compatibility
- WordPress
- since 6.2.1
- 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
$locale_namestring- The locale name to be sanitized.
Return value
string- The sanitized value.
Performance profile
How much work a call to sanitize_locale_name() 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
- 9
- Plugin surface
- 1 hook
- Called by
- 1
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 9.
Third-party callbacks on 'sanitize_locale_name' run inside this call, and their cost is not bounded by anything here.
1 place 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
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 sanitize_locale_name() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 9 | apply_filters() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 9 | 9 | 0 | |
| 8.5 | 9 | 9 | 0 | |
| 8.4 | 9 | 9 | 0 | 4 fewer instructions than PHP 8.3 |
| 8.3 | 13 | 13 | 0 | |
| 8.2 | 13 | 13 | 0 | |
| 8.1 | 13 | 13 | 0 | |
| 7.4 | 13 | 13 | 0 |
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 sanitize_locale_name() runs, in this order:
- apply_filters( sanitize_locale_name )filterline 2480 (+12 into the body)
Filters a sanitized locale name string.
Uses · 1
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 1
- determine_locale()Determines the current locale desired for the request.
Source code
function sanitize_locale_name( $locale_name ) { // Limit to A-Z, a-z, 0-9, '_', '-'. $sanitized = preg_replace( '/[^A-Za-z0-9_-]/', '', $locale_name ); /** * Filters a sanitized locale name string. * * @since 6.2.1 * * @param string $sanitized The sanitized locale name. * @param string $locale_name The locale name before sanitization. */ return apply_filters( 'sanitize_locale_name', $sanitized, $locale_name );}Changelog
Introduced in 6.2.1. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 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.