user_can_richedit(): bool
- Since
- 2.0.0
- Source
wp-includes/general-template.php:3892
Description
Checks if the user can access the visual editor and that it's supported by the user's browser.
Compatibility
- WordPress
- since 2.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
bool- True if the user can access the visual editor, false otherwise.
Performance profile
How much work a call to user_can_richedit() 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
- 14–41
- Plugin surface
- 1 hook
- Called by
- 7
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 55.
Third-party callbacks on 'user_can_richedit' run inside this call, and their cost is not bounded by anything here.
7 places 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
Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 7 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost user_can_richedit() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
isset($wp_rich_edit) | 14 | apply_filters() |
!isset($wp_rich_edit) | 23–30 | get_user_option(), is_user_logged_in(), apply_filters() |
!isset($wp_rich_edit) | 24–27 | get_user_option(), apply_filters() |
!isset($wp_rich_edit) | 27–30 | get_user_option(), wp_is_mobile(), apply_filters() |
!isset($wp_rich_edit) && !is_user_logged_in() | 30–33 | get_user_option(), is_user_logged_in(), wp_is_mobile(), apply_filters() |
!isset($wp_rich_edit) && $value | 35–38 | get_user_option(), wp_is_mobile(), preg_match(), apply_filters() |
!isset($wp_rich_edit) && !is_user_logged_in() && $value | 38–41 | get_user_option(), is_user_logged_in(), wp_is_mobile(), preg_match(), apply_filters() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 55 | 14–41 | 12 | |
| 8.5 | 55 | 14–41 | 12 | |
| 8.4 | 55 | 14–41 | 12 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 58 | 14–41 | 12 | |
| 8.2 | 58 | 14–41 | 12 | |
| 8.1 | 58 | 14–41 | 12 | 1 fewer instruction than PHP 7.4 |
| 7.4 | 59 | 14–41 | 12 |
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 user_can_richedit() runs, in this order:
- apply_filters( user_can_richedit )filterline 3916 (+24 into the body)
Filters whether the user can access the visual editor.
Uses · 5
- get_user_option()Retrieves user option that can be either per Site or per Network.
- is_user_logged_in()Determines whether the current visitor is a logged in user.
- wp_is_mobile()Test if the current browser runs on a mobile device (smart phone, tablet, etc.).
- str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 7
- WP_Widget_Text::form()Outputs the Text widget settings form.
- _WP_Editors::parse_settings()Parse default arguments for the editor instance.
- _WP_Editors::print_default_editor_scripts()Print (output) all editor scripts and default settings.
- get_compat_media_markup()
- get_media_item()Retrieves HTML form for modifying the image attachment.
- sanitize_post_field()Sanitizes a post field based on context.
- wp_default_editor()Finds out which editor should be displayed by default.
Source code
function user_can_richedit() { global $wp_rich_edit, $is_gecko, $is_opera, $is_safari, $is_chrome, $is_IE, $is_edge; if ( ! isset( $wp_rich_edit ) ) { $wp_rich_edit = false; if ( 'true' === get_user_option( 'rich_editing' ) || ! is_user_logged_in() ) { // Default to 'true' for logged out users. if ( $is_safari ) { $wp_rich_edit = ! wp_is_mobile() || ( preg_match( '!AppleWebKit/(\d+)!', $_SERVER['HTTP_USER_AGENT'], $match ) && (int) $match[1] >= 534 ); } elseif ( $is_IE ) { $wp_rich_edit = str_contains( $_SERVER['HTTP_USER_AGENT'], 'Trident/7.0;' ); } elseif ( $is_gecko || $is_chrome || $is_edge || ( $is_opera && ! wp_is_mobile() ) ) { $wp_rich_edit = true; } } } /** * Filters whether the user can access the visual editor. * * @since 2.1.0 * * @param bool $wp_rich_edit Whether the user can access the visual editor. */ return apply_filters( 'user_can_richedit', $wp_rich_edit );}Changelog
Introduced in 2.0.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/general-template.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.