云策 WordPress 开发者社区

函数文档

user_can_richedit()

查看官方原文 ↗
💡 云策文档标注

概述

user_can_richedit() 函数用于判断用户是否可以访问可视化编辑器，基于用户设置和浏览器支持情况。

关键要点

  • 检查用户是否启用富文本编辑（通过 get_user_option('rich_editing')）和浏览器是否支持
  • 返回布尔值：true 表示用户可访问可视化编辑器，false 表示不可访问
  • 内部使用全局变量（如 $wp_rich_edit, $is_safari 等）和服务器环境变量（HTTP_USER_AGENT）进行判断
  • 提供 apply_filters('user_can_richedit', $wp_rich_edit) 钩子，允许开发者过滤结果
  • 与 wp_is_mobile(), get_user_option(), is_user_logged_in() 等函数相关

代码示例

if ( user_can_richedit() ) {
    wp_editor( $content, 'mycustomeditor' );
} else {
    echo __( 'You cannot use the rich editor', 'textdomain' );
}
📄 原文内容

Determines whether the user can access the visual editor.

Description

Checks if the user can access the visual editor and that it’s supported by the user’s browser.

Return

bool True if the user can access the visual editor, false otherwise.

Source

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 );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘user_can_richedit’, bool $wp_rich_edit )

Filters whether the user can access the visual editor.

Uses Description
wp_is_mobile()wp-includes/vars.php

Test if the current browser runs on a mobile device (smart phone, tablet, etc.).
get_user_option()wp-includes/user.php

Retrieves user option that can be either per Site or per Network.
is_user_logged_in()wp-includes/pluggable.php

Determines whether the current visitor is a logged in user.
apply_filters()wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.

Show 2 moreShow less

Used by Description
_WP_Editors::print_default_editor_scripts()wp-includes/class-wp-editor.php

Print (output) all editor scripts and default settings.
get_media_item()wp-admin/includes/media.php

Retrieves HTML form for modifying the image attachment.
get_compat_media_markup()wp-admin/includes/media.php
wp_default_editor()wp-includes/general-template.php

Finds out which editor should be displayed by default.
WP_Widget_Text::form()wp-includes/widgets/class-wp-widget-text.php

Outputs the Text widget settings form.
sanitize_post_field()wp-includes/post.php

Sanitizes a post field based on context.
_WP_Editors::parse_settings()wp-includes/class-wp-editor.php

Parse default arguments for the editor instance.

Show 2 moreShow less

Changelog

Version Description
2.0.0 Introduced.

User Contributed Notes