_mce_set_direction( array $mce_init ): array
- Since
- 2.1.0
- Source
wp-includes/functions.php:4762
Description
Will only set the direction to 'rtl', if the WordPress locale has the text direction set to 'rtl'.
Fills in the 'directionality' setting, enables the 'directionality' plugin, and adds the 'ltr' button to 'toolbar1', formerly 'theme_advanced_buttons1' array keys. These keys are then returned in the $mce_init (TinyMCE settings) array.
Compatibility
- WordPress
- since 2.1.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
$mce_initarray- MCE settings array.
Return value
array- Direction set for 'rtl', if needed by locale.
Performance profile
How much work a call to _mce_set_direction() 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
- 5–23
- Plugin surface
- None
- Called by
- 0
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, depending on the branch taken. The body compiles to 23.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
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 _mce_set_direction() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 5–23 | is_rtl() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 23 | 5–23 | 5 | |
| 8.5 | 23 | 5–23 | 5 | |
| 8.4 | 23 | 5–23 | 5 | 6 fewer instructions than PHP 8.3 |
| 8.3 | 29 | 5–29 | 5 | |
| 8.2 | 29 | 5–29 | 5 | |
| 8.1 | 29 | 5–29 | 5 | 1 fewer instruction than PHP 7.4 |
| 7.4 | 30 | 5–30 | 5 |
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
- is_rtl()Determines whether the current locale is right-to-left (RTL).
- str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
Source code
function _mce_set_direction( $mce_init ) { if ( is_rtl() ) { $mce_init['directionality'] = 'rtl'; $mce_init['rtl_ui'] = true; if ( ! empty( $mce_init['plugins'] ) && ! str_contains( $mce_init['plugins'], 'directionality' ) ) { $mce_init['plugins'] .= ',directionality'; } if ( ! empty( $mce_init['toolbar1'] ) && ! preg_match( '/\bltr\b/', $mce_init['toolbar1'] ) ) { $mce_init['toolbar1'] .= ',ltr'; } } return $mce_init;}Changelog
Introduced in 2.1.0. 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 6.8.8 tag, from
src/wp-includes/functions.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.