Changeset 38707 for trunk/src/wp-includes/general-template.php

Timestamp:

10/03/2016 07:54:14 AM (8 years ago)

Author:

swissspidy

Message:

Editor: Improve documentation for user_can_richedit().

Clarifies the various global variables used in the function.

Props gma992.
Fixes #37321.

File:

• trunk/src/wp-includes/general-template.php (modified) (2 diffs)

trunk/src/wp-includes/general-template.php

@@ -2900 +2900 @@
 
 /**
- * Whether the user should have a WYSIWIG editor.
- *
- * Checks that the user requires a WYSIWIG editor and that the editor is
- * supported in the users browser.
+ * Whether the user can access the visual editor.
+ *
+ * Checks if the user can access the visual editor and that it's supported by the user's browser.
  *
  * @since 2.0.0
  *
- * @global bool $wp_rich_edit
- * @global bool $is_gecko
- * @global bool $is_opera
- * @global bool $is_safari
- * @global bool $is_chrome
- * @global bool $is_IE
- *
- * @return bool
+ * @global bool $wp_rich_edit Whether the user can access the visual editor.
+ * @global bool $is_gecko     Whether the browser is Gecko-based.
+ * @global bool $is_opera     Whether the browser is Opera.
+ * @global bool $is_safari    Whether the browser is Safari.
+ * @global bool $is_chrome    Whether the browser is Chrome.
+ * @global bool $is_IE        Whether the browser is Internet Explorer.
+ * @global bool $is_edge      Whether the browser is Microsoft Edge.
+ *
+ * @return bool True if the user can access the visual editor, false otherwise.
  */
 function user_can_richedit() {
@@ -2932 +2932 @@
 
     /**
-     * Filters whether the user can access the rich (Visual) editor.
+     * Filters whether the user can access the visual editor.
      *
      * @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 );