sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Editor: Improve documentation for user_can_richedit().

Browse Source 
Clarifies the various global variables used in the function.

Props gma992.
Fixes #37321.

git-svn-id: https://develop.svn.wordpress.org/trunk@38707 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Pascal Birchler 2016-10-03 07:54:14 +00:00
parent 7387321059
commit 25f3c04a58
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
src/wp-includes/general-template.php
View File

@ -2899,21 +2899,21 @@ function wp_dependencies_unique_hosts() {
} }
/** /**
* Whether the user should have a WYSIWIG editor. * Whether the user can access the visual editor.
* *
* Checks that the user requires a WYSIWIG editor and that the editor is * Checks if the user can access the visual editor and that it's supported by the user's browser.
* supported in the users browser.
* *
* @since 2.0.0 * @since 2.0.0
* *
* @global bool $wp_rich_edit * @global bool $wp_rich_edit Whether the user can access the visual editor.
* @global bool $is_gecko * @global bool $is_gecko Whether the browser is Gecko-based.
* @global bool $is_opera * @global bool $is_opera Whether the browser is Opera.
* @global bool $is_safari * @global bool $is_safari Whether the browser is Safari.
* @global bool $is_chrome * @global bool $is_chrome Whether the browser is Chrome.
* @global bool $is_IE * @global bool $is_IE Whether the browser is Internet Explorer.
* @global bool $is_edge Whether the browser is Microsoft Edge.
* *
* @return bool * @return bool True if the user can access the visual editor, false otherwise.
*/ */
function user_can_richedit() { function user_can_richedit() {
global $wp_rich_edit, $is_gecko, $is_opera, $is_safari, $is_chrome, $is_IE, $is_edge; global $wp_rich_edit, $is_gecko, $is_opera, $is_safari, $is_chrome, $is_IE, $is_edge;
@ -2931,11 +2931,11 @@ function user_can_richedit() {
} }
/** /**
* Filters whether the user can access the rich (Visual) editor. * Filters whether the user can access the visual editor.
* *
* @since 2.1.0 * @since 2.1.0
* *
* @param bool $wp_rich_edit Whether the user can access to the rich (Visual) editor. * @param bool $wp_rich_edit Whether the user can access the visual editor.
*/ */
return apply_filters( 'user_can_richedit', $wp_rich_edit ); return apply_filters( 'user_can_richedit', $wp_rich_edit );
} }