enmi-conf.org: comparison wp/wp-includes/class-wp-editor.php

equal deleted inserted replaced

-:3d4e9c994f10
+:a86126ab1dd4
 	private static $has_tinymce        = false;
 	private static $has_quicktags      = false;
 	private static $has_medialib       = false;
 	private static $editor_buttons_css = true;
 	private static $drag_drop_upload   = false;
-	private static $old_dfw_compat     = false;
 	private static $translation;
 	private static $tinymce_scripts_printed = false;
 	private static $link_dialog_printed     = false;
 	private function __construct() {}
 	/**
 	 * Parse default arguments for the editor instance.
 	 *
-	 * @param string $editor_id ID for the current editor instance.
+	 * @since 3.3.0
+	 *
+	 * @param string $editor_id HTML ID for the textarea and TinyMCE and Quicktags instances.
+	 *                          Should not contain square brackets.
 	 * @param array  $settings {
 	 *     Array of editor arguments.
 	 *
 	 *     @type bool       $wpautop           Whether to use wpautop(). Default true.
 	 *     @type bool       $media_buttons     Whether to show the Add Media/other media buttons.
 	 *     @type string     $editor_css        Intended for extra styles for both Visual and Text editors.
 	 *                                         Should include `<style>` tags, and can use "scoped". Default empty.
 	 *     @type string     $editor_class      Extra classes to add to the editor textarea element. Default empty.
 	 *     @type bool       $teeny             Whether to output the minimal editor config. Examples include
 	 *                                         Press This and the Comment editor. Default false.
-	 *     @type bool       $dfw               Deprecated in 4.1. Since 4.3 used only to enqueue wp-fullscreen-stub.js
+	 *     @type bool       $dfw               Deprecated in 4.1. Unused.
-	 *                                         for backward compatibility.
 	 *     @type bool|array $tinymce           Whether to load TinyMCE. Can be used to pass settings directly to
 	 *                                         TinyMCE using an array. Default true.
 	 *     @type bool|array $quicktags         Whether to load Quicktags. Can be used to pass settings directly to
 	 *                                         Quicktags using an array. Default true.
 	 * }
 		 * @since 4.0.0
 		 *
 		 * @see _WP_Editors::parse_settings()
 		 *
 		 * @param array  $settings  Array of editor arguments.
-		 * @param string $editor_id ID for the current editor instance.
+		 * @param string $editor_id Unique editor identifier, e.g. 'content'. Accepts 'classic-block'
+		 *                          when called from block editor's Classic block.
 		 */
 		$settings = apply_filters( 'wp_editor_settings', $settings, $editor_id );
 		$set = wp_parse_args(
 			$settings,
 				'tabindex'            => '',
 				'tabfocus_elements'   => ':prev,:next',
 				'editor_css'          => '',
 				'editor_class'        => '',
 				'teeny'               => false,
-				'dfw'                 => false,
 				'_content_editor_dfw' => false,
 				'tinymce'             => true,
 				'quicktags'           => true,
 			)
 		);
 		if ( self::$this_quicktags ) {
 			self::$has_quicktags = true;
 		}
-		if ( $set['dfw'] ) {
-			self::$old_dfw_compat = true;
-		}
 		if ( empty( $set['editor_height'] ) ) {
 			return $set;
 		}
 		if ( 'content' === $editor_id && empty( $set['tinymce']['wp_autoresize_on'] ) ) {
 	}
 	/**
 	 * Outputs the HTML for a single instance of the editor.
 	 *
-	 * @param string $content The initial content of the editor.
+	 * @since 3.3.0
-	 * @param string $editor_id ID for the textarea and TinyMCE and Quicktags instances (can contain only ASCII letters and numbers).
+	 *
-	 * @param array $settings See _WP_Editors::parse_settings() for description.
+	 * @param string $content   Initial content for the editor.
+	 * @param string $editor_id HTML ID for the textarea and TinyMCE and Quicktags instances.
+	 *                          Should not contain square brackets.
+	 * @param array  $settings  See _WP_Editors::parse_settings() for description.
 	 */
 	public static function editor( $content, $editor_id, $settings = array() ) {
 		$set            = self::parse_settings( $editor_id, $settings );
 		$editor_class   = ' class="' . trim( esc_attr( $set['editor_class'] ) . ' wp-editor-area' ) . '"';
 		$tabindex       = $set['tabindex'] ? ' tabindex="' . (int) $set['tabindex'] . '"' : '';
 		$default_editor = 'html';
-		$buttons        = $autocomplete = '';
+		$buttons        = '';
+		$autocomplete   = '';
 		$editor_id_attr = esc_attr( $editor_id );
 		if ( $set['drag_drop_upload'] ) {
 			self::$drag_drop_upload = true;
 		}
 			if ( $set['media_buttons'] ) {
 				self::$has_medialib = true;
 				if ( ! function_exists( 'media_buttons' ) ) {
-					include( ABSPATH . 'wp-admin/includes/media.php' );
+					require ABSPATH . 'wp-admin/includes/media.php';
 				}
 				echo '<div id="wp-' . $editor_id_attr . '-media-buttons" class="wp-media-buttons">';
 				/**
 		}
 		$quicktags_toolbar = '';
 		if ( self::$this_quicktags ) {
-			if ( 'content' === $editor_id && ! empty( $GLOBALS['current_screen'] ) && $GLOBALS['current_screen']->base === 'post' ) {
+			if ( 'content' === $editor_id && ! empty( $GLOBALS['current_screen'] ) && 'post' === $GLOBALS['current_screen']->base ) {
 				$toolbar_id = 'ed_toolbar';
 			} else {
 				$toolbar_id = 'qt_' . $editor_id_attr . '_toolbar';
 			}
 		// Remove the filter as the next editor on the same page may not need it.
 		if ( self::$this_tinymce ) {
 			remove_filter( 'the_editor_content', 'format_for_editor' );
 		}
-		// Back-compat for the `htmledit_pre` and `richedit_pre` filters
+		// Back-compat for the `htmledit_pre` and `richedit_pre` filters.
 		if ( 'html' === $default_editor && has_filter( 'htmledit_pre' ) ) {
 			/** This filter is documented in wp-includes/deprecated.php */
 			$content = apply_filters_deprecated( 'htmledit_pre', array( $content ), '4.3.0', 'format_for_editor' );
 		} elseif ( 'tinymce' === $default_editor && has_filter( 'richedit_pre' ) ) {
 			/** This filter is documented in wp-includes/deprecated.php */
 		self::editor_settings( $editor_id, $set );
 	}
 	/**
-	 * @global string $tinymce_version
+	 * @since 3.3.0
 	 *
-	 * @param string $editor_id
+	 * @param string $editor_id Unique editor identifier, e.g. 'content'.
-	 * @param array  $set
+	 * @param array  $set       Array of editor arguments.
 	 */
 	public static function editor_settings( $editor_id, $set ) {
-		global $tinymce_version;
 		if ( empty( self::$first_init ) ) {
 			if ( is_admin() ) {
 				add_action( 'admin_print_footer_scripts', array( __CLASS__, 'editor_js' ), 50 );
 				add_action( 'admin_print_footer_scripts', array( __CLASS__, 'force_uncompressed_tinymce' ), 1 );
 				add_action( 'admin_print_footer_scripts', array( __CLASS__, 'enqueue_scripts' ), 1 );
 			 * Filters the Quicktags settings.
 			 *
 			 * @since 3.3.0
 			 *
 			 * @param array  $qtInit    Quicktags settings.
-			 * @param string $editor_id The unique editor ID, e.g. 'content'.
+			 * @param string $editor_id Unique editor identifier, e.g. 'content'.
 			 */
 			$qtInit = apply_filters( 'quicktags_settings', $qtInit, $editor_id );
 			self::$qt_settings[ $editor_id ] = $qtInit;
 					/**
 					 * Filters the list of teenyMCE plugins.
 					 *
 					 * @since 2.7.0
+					 * @since 3.3.0 The `$editor_id` parameter was added.
 					 *
 					 * @param array  $plugins   An array of teenyMCE plugins.
 					 * @param string $editor_id Unique editor identifier, e.g. 'content'.
 					 */
-					$plugins = apply_filters( 'teeny_mce_plugins', array( 'colorpicker', 'lists', 'fullscreen', 'image', 'wordpress', 'wpeditimage', 'wplink' ), $editor_id );
+					$plugins = apply_filters(
+						'teeny_mce_plugins',
+						array(
+							'colorpicker',
+							'lists',
+							'fullscreen',
+							'image',
+							'wordpress',
+							'wpeditimage',
+							'wplink',
+						),
+						$editor_id
+					);
 				} else {
 					/**
 					 * Filters the list of TinyMCE external plugins.
 					 *
 					 *
 					 * If the external plugin adds a button, it should be added with
 					 * one of the 'mce_buttons' filters.
 					 *
 					 * @since 2.5.0
+					 * @since 5.3.0 The `$editor_id` parameter was added.
 					 *
-					 * @param array $external_plugins An array of external TinyMCE plugins.
+					 * @param array  $external_plugins An array of external TinyMCE plugins.
+					 * @param string $editor_id        Unique editor identifier, e.g. 'content'. Accepts 'classic-block'
+					 *                                 when called from block editor's Classic block.
 					 */
-					$mce_external_plugins = apply_filters( 'mce_external_plugins', array() );
+					$mce_external_plugins = apply_filters( 'mce_external_plugins', array(), $editor_id );
 					$plugins = array(
 						'charmap',
 						'colorpicker',
 						'hr',
 					 *
 					 * The filter specifies which of the default plugins included
 					 * in WordPress should be added to the TinyMCE instance.
 					 *
 					 * @since 3.3.0
+					 * @since 5.3.0 The `$editor_id` parameter was added.
 					 *
-					 * @param array $plugins An array of default TinyMCE plugins.
+					 * @param array  $plugins   An array of default TinyMCE plugins.
+					 * @param string $editor_id Unique editor identifier, e.g. 'content'. Accepts 'classic-block'
+					 *                          when called from block editor's Classic block.
 					 */
-					$plugins = array_unique( apply_filters( 'tiny_mce_plugins', $plugins ) );
+					$plugins = array_unique( apply_filters( 'tiny_mce_plugins', $plugins, $editor_id ) );
-					if ( ( $key = array_search( 'spellchecker', $plugins ) ) !== false ) {
+					$key = array_search( 'spellchecker', $plugins, true );
+					if ( false !== $key ) {
 						// Remove 'spellchecker' from the internal plugins if added with 'tiny_mce_plugins' filter to prevent errors.
 						// It can be added with 'mce_external_plugins'.
 						unset( $plugins[ $key ] );
 					}
 						 *
 						 * The language file should follow the same format as wp_mce_translation(),
 						 * and should define a variable ($strings) that holds all translated strings.
 						 *
 						 * @since 2.5.0
+						 * @since 5.3.0 The `$editor_id` parameter was added.
 						 *
-						 * @param array $translations Translations for external TinyMCE plugins.
+						 * @param array  $translations Translations for external TinyMCE plugins.
+						 * @param string $editor_id    Unique editor identifier, e.g. 'content'.
 						 */
-						$mce_external_languages = apply_filters( 'mce_external_languages', array() );
+						$mce_external_languages = apply_filters( 'mce_external_languages', array(), $editor_id );
 						$loaded_langs = array();
 						$strings      = '';
 						if ( ! empty( $mce_external_languages ) ) {
 							foreach ( $mce_external_languages as $name => $path ) {
 								if ( @is_file( $path ) && @is_readable( $path ) ) {
-									include_once( $path );
+									include_once $path;
 									$ext_plugins   .= $strings . "\n";
 									$loaded_langs[] = $name;
 								}
 							}
 						}
 							$url                           = set_url_scheme( $url );
 							$mce_external_plugins[ $name ] = $url;
 							$plugurl                       = dirname( $url );
 							$strings                       = '';
-							// Try to load langs/[locale].js and langs/[locale]_dlg.js
+							// Try to load langs/[locale].js and langs/[locale]_dlg.js.
 							if ( ! in_array( $name, $loaded_langs, true ) ) {
 								$path = str_replace( content_url(), '', $plugurl );
 								$path = WP_CONTENT_DIR . $path . '/langs/';
-								if ( function_exists( 'realpath' ) ) {
+								$path = trailingslashit( realpath( $path ) );
-									$path = trailingslashit( realpath( $path ) );
-								}
 								if ( @is_file( $path . $mce_locale . '.js' ) ) {
 									$strings .= @file_get_contents( $path . $mce_locale . '.js' ) . "\n";
 								}
 								if ( @is_file( $path . $mce_locale . '_dlg.js' ) ) {
 									$strings .= @file_get_contents( $path . $mce_locale . '_dlg.js' ) . "\n";
 								}
-								if ( 'en' != $mce_locale && empty( $strings ) ) {
+								if ( 'en' !== $mce_locale && empty( $strings ) ) {
 									if ( @is_file( $path . 'en.js' ) ) {
 										$str1     = @file_get_contents( $path . 'en.js' );
 										$strings .= preg_replace( '/([\'"])en\./', '$1' . $mce_locale . '.', $str1, 1 ) . "\n";
 									}
 				/** This filter is documented in wp-admin/includes/media.php */
 				if ( apply_filters( 'disable_captions', '' ) ) {
 					$settings['wpeditimage_disable_captions'] = true;
 				}
-				$mce_css       = $settings['content_css'];
+				$mce_css = $settings['content_css'];
-				$editor_styles = get_editor_stylesheets();
+				/*
-				if ( ! empty( $editor_styles ) ) {
+				 * The `editor-style.css` added by the theme is generally intended for the editor instance on the Edit Post screen.
-					// Force urlencoding of commas.
+				 * Plugins that use wp_editor() on the front-end can decide whether to add the theme stylesheet
-					foreach ( $editor_styles as $key => $url ) {
+				 * by using `get_editor_stylesheets()` and the `mce_css` or `tiny_mce_before_init` filters, see below.
-						if ( strpos( $url, ',' ) !== false ) {
+				 */
-							$editor_styles[ $key ] = str_replace( ',', '%2C', $url );
+				if ( is_admin() ) {
+					$editor_styles = get_editor_stylesheets();
+					if ( ! empty( $editor_styles ) ) {
+						// Force urlencoding of commas.
+						foreach ( $editor_styles as $key => $url ) {
+							if ( strpos( $url, ',' ) !== false ) {
+								$editor_styles[ $key ] = str_replace( ',', '%2C', $url );
+							}
 						}
+						$mce_css .= ',' . implode( ',', $editor_styles );
 					}
-					$mce_css .= ',' . implode( ',', $editor_styles );
 				}
 				/**
 				 * Filters the comma-delimited list of stylesheets to load in TinyMCE.
 				 *
 				self::$first_init = $settings;
 			}
 			if ( $set['teeny'] ) {
+				$mce_buttons = array(
+					'bold',
+					'italic',
+					'underline',
+					'blockquote',
+					'strikethrough',
+					'bullist',
+					'numlist',
+					'alignleft',
+					'aligncenter',
+					'alignright',
+					'undo',
+					'redo',
+					'link',
+					'fullscreen',
+				);
 				/**
 				 * Filters the list of teenyMCE buttons (Text tab).
 				 *
 				 * @since 2.7.0
+				 * @since 3.3.0 The `$editor_id` parameter was added.
 				 *
-				 * @param array  $buttons   An array of teenyMCE buttons.
+				 * @param array  $mce_buttons An array of teenyMCE buttons.
-				 * @param string $editor_id Unique editor identifier, e.g. 'content'.
+				 * @param string $editor_id   Unique editor identifier, e.g. 'content'.
 				 */
-				$mce_buttons   = apply_filters( 'teeny_mce_buttons', array( 'bold', 'italic', 'underline', 'blockquote', 'strikethrough', 'bullist', 'numlist', 'alignleft', 'aligncenter', 'alignright', 'undo', 'redo', 'link', 'fullscreen' ), $editor_id );
+				$mce_buttons   = apply_filters( 'teeny_mce_buttons', $mce_buttons, $editor_id );
-				$mce_buttons_2 = $mce_buttons_3 = $mce_buttons_4 = array();
+				$mce_buttons_2 = array();
+				$mce_buttons_3 = array();
+				$mce_buttons_4 = array();
 			} else {
-				$mce_buttons = array( 'formatselect', 'bold', 'italic', 'bullist', 'numlist', 'blockquote', 'alignleft', 'aligncenter', 'alignright', 'link', 'wp_more', 'spellchecker' );
+				$mce_buttons = array(
+					'formatselect',
+					'bold',
+					'italic',
+					'bullist',
+					'numlist',
+					'blockquote',
+					'alignleft',
+					'aligncenter',
+					'alignright',
+					'link',
+					'wp_more',
+					'spellchecker',
+				);
 				if ( ! wp_is_mobile() ) {
 					if ( $set['_content_editor_dfw'] ) {
 						$mce_buttons[] = 'wp_adv';
 						$mce_buttons[] = 'dfw';
 				/**
 				 * Filters the first-row list of TinyMCE buttons (Visual tab).
 				 *
 				 * @since 2.0.0
+				 * @since 3.3.0 The `$editor_id` parameter was added.
 				 *
-				 * @param array  $buttons   First-row list of buttons.
+				 * @param array  $mce_buttons First-row list of buttons.
-				 * @param string $editor_id Unique editor identifier, e.g. 'content'.
+				 * @param string $editor_id   Unique editor identifier, e.g. 'content'. Accepts 'classic-block'
+				 *                            when called from block editor's Classic block.
 				 */
 				$mce_buttons = apply_filters( 'mce_buttons', $mce_buttons, $editor_id );
-				$mce_buttons_2 = array( 'strikethrough', 'hr', 'forecolor', 'pastetext', 'removeformat', 'charmap', 'outdent', 'indent', 'undo', 'redo' );
+				$mce_buttons_2 = array(
+					'strikethrough',
+					'hr',
+					'forecolor',
+					'pastetext',
+					'removeformat',
+					'charmap',
+					'outdent',
+					'indent',
+					'undo',
+					'redo',
+				);
 				if ( ! wp_is_mobile() ) {
 					$mce_buttons_2[] = 'wp_help';
 				}
 				/**
 				 * Filters the second-row list of TinyMCE buttons (Visual tab).
 				 *
 				 * @since 2.0.0
+				 * @since 3.3.0 The `$editor_id` parameter was added.
 				 *
-				 * @param array  $buttons   Second-row list of buttons.
+				 * @param array  $mce_buttons_2 Second-row list of buttons.
-				 * @param string $editor_id Unique editor identifier, e.g. 'content'.
+				 * @param string $editor_id     Unique editor identifier, e.g. 'content'. Accepts 'classic-block'
+				 *                              when called from block editor's Classic block.
 				 */
 				$mce_buttons_2 = apply_filters( 'mce_buttons_2', $mce_buttons_2, $editor_id );
 				/**
 				 * Filters the third-row list of TinyMCE buttons (Visual tab).
 				 *
 				 * @since 2.0.0
+				 * @since 3.3.0 The `$editor_id` parameter was added.
 				 *
-				 * @param array  $buttons   Third-row list of buttons.
+				 * @param array  $mce_buttons_3 Third-row list of buttons.
-				 * @param string $editor_id Unique editor identifier, e.g. 'content'.
+				 * @param string $editor_id     Unique editor identifier, e.g. 'content'. Accepts 'classic-block'
+				 *                              when called from block editor's Classic block.
 				 */
 				$mce_buttons_3 = apply_filters( 'mce_buttons_3', array(), $editor_id );
 				/**
 				 * Filters the fourth-row list of TinyMCE buttons (Visual tab).
 				 *
 				 * @since 2.5.0
+				 * @since 3.3.0 The `$editor_id` parameter was added.
 				 *
-				 * @param array  $buttons   Fourth-row list of buttons.
+				 * @param array  $mce_buttons_4 Fourth-row list of buttons.
-				 * @param string $editor_id Unique editor identifier, e.g. 'content'.
+				 * @param string $editor_id     Unique editor identifier, e.g. 'content'. Accepts 'classic-block'
+				 *                              when called from block editor's Classic block.
 				 */
 				$mce_buttons_4 = apply_filters( 'mce_buttons_4', array(), $editor_id );
 			}
 			$body_class = $editor_id;
-			if ( $post = get_post() ) {
+			$post = get_post();
+			if ( $post ) {
 				$body_class .= ' post-type-' . sanitize_html_class( $post->post_type ) . ' post-status-' . sanitize_html_class( $post->post_status );
 				if ( post_type_supports( $post->post_type, 'post-formats' ) ) {
 					$post_format = get_post_format( $post );
 					if ( $post_format && ! is_wp_error( $post_format ) ) {
 					}
 				}
 				$page_template = get_page_template_slug( $post );
-				if ( $page_template !== false ) {
+				if ( false !== $page_template ) {
 					$page_template = empty( $page_template ) ? 'default' : str_replace( '.', '-', basename( $page_template, '.php' ) );
 					$body_class   .= ' page-template-' . sanitize_html_class( $page_template );
 				}
 			}
 				'toolbar4'          => implode( ',', $mce_buttons_4 ),
 				'tabfocus_elements' => $set['tabfocus_elements'],
 				'body_class'        => $body_class,
 			);
-			// Merge with the first part of the init array
+			// Merge with the first part of the init array.
 			$mceInit = array_merge( self::$first_init, $mceInit );
 			if ( is_array( $set['tinymce'] ) ) {
 				$mceInit = array_merge( $mceInit, $set['tinymce'] );
 			}
 				/**
 				 * Filters the teenyMCE config before init.
 				 *
 				 * @since 2.7.0
+				 * @since 3.3.0 The `$editor_id` parameter was added.
 				 *
 				 * @param array  $mceInit   An array with teenyMCE config.
 				 * @param string $editor_id Unique editor identifier, e.g. 'content'.
 				 */
 				$mceInit = apply_filters( 'teeny_mce_before_init', $mceInit, $editor_id );
 				/**
 				 * Filters the TinyMCE config before init.
 				 *
 				 * @since 2.5.0
+				 * @since 3.3.0 The `$editor_id` parameter was added.
 				 *
 				 * @param array  $mceInit   An array with TinyMCE config.
-				 * @param string $editor_id Unique editor identifier, e.g. 'content'.
+				 * @param string $editor_id Unique editor identifier, e.g. 'content'. Accepts 'classic-block'
+				 *                          when called from block editor's Classic block.
 				 */
 				$mceInit = apply_filters( 'tiny_mce_before_init', $mceInit, $editor_id );
 			}
 			if ( empty( $mceInit['toolbar3'] ) && ! empty( $mceInit['toolbar4'] ) ) {
 				$mceInit['toolbar3'] = $mceInit['toolbar4'];
 				$mceInit['toolbar4'] = '';
 			}
 			self::$mce_settings[ $editor_id ] = $mceInit;
-		} // end if self::$this_tinymce
+		} // End if self::$this_tinymce.
 	}
 	/**
+	 * @since 3.3.0
+	 *
 	 * @param array $init
 	 * @return string
 	 */
 	private static function _parse_init( $init ) {
 		$options = '';
 			if ( is_bool( $value ) ) {
 				$val      = $value ? 'true' : 'false';
 				$options .= $key . ':' . $val . ',';
 				continue;
 			} elseif ( ! empty( $value ) && is_string( $value ) && (
-				( '{' == $value{0} && '}' == $value{strlen( $value ) - 1} ) ||
+				( '{' === $value[0] && '}' === $value[ strlen( $value ) - 1 ] ) ||
-				( '[' == $value{0} && ']' == $value{strlen( $value ) - 1} ) ||
+				( '[' === $value[0] && ']' === $value[ strlen( $value ) - 1 ] ) ||
 				preg_match( '/^\(?function ?\(/', $value ) ) ) {
 				$options .= $key . ':' . $value . ',';
 				continue;
 			}
 		return '{' . trim( $options, ' ,' ) . '}';
 	}
 	/**
-	 *
+	 * @since 3.3.0
-	 * @static
 	 *
 	 * @param bool $default_scripts Optional. Whether default scripts should be enqueued. Default false.
 	 */
 	public static function enqueue_scripts( $default_scripts = false ) {
 		if ( $default_scripts || self::$has_tinymce ) {
 		}
 		if ( $default_scripts || in_array( 'wplink', self::$plugins, true ) || in_array( 'link', self::$qt_buttons, true ) ) {
 			wp_enqueue_script( 'wplink' );
 			wp_enqueue_script( 'jquery-ui-autocomplete' );
-		}
-		if ( self::$old_dfw_compat ) {
-			wp_enqueue_script( 'wp-fullscreen-stub' );
 		}
 		if ( self::$has_medialib ) {
 			add_thickbox();
 			wp_enqueue_script( 'media-upload' );
 			return;
 		}
 		self::enqueue_scripts( true );
-		// Also add wp-includes/css/editor.css
+		// Also add wp-includes/css/editor.css.
 		wp_enqueue_style( 'editor-buttons' );
 		if ( is_admin() ) {
 			add_action( 'admin_print_footer_scripts', array( __CLASS__, 'force_uncompressed_tinymce' ), 1 );
 			add_action( 'admin_print_footer_scripts', array( __CLASS__, 'print_default_editor_scripts' ), 45 );
 			if ( is_rtl() ) {
 				$settings['directionality'] = 'rtl';
 			}
-			// In production all plugins are loaded (they are in wp-editor.js.gz).
+			/*
-			// The 'wpview', 'wpdialogs', and 'media' TinyMCE plugins are not initialized by default.
+			 * In production all plugins are loaded (they are in wp-editor.js.gz).
-			// Can be added from js by using the 'wp-before-tinymce-init' event.
+			 * The 'wpview', 'wpdialogs', and 'media' TinyMCE plugins are not initialized by default.
+			 * Can be added from js by using the 'wp-before-tinymce-init' event.
+			 */
 			$settings['plugins'] = implode(
 				',',
 				array(
 					'charmap',
 					'colorpicker',
 		do_action( 'print_default_editor_scripts' );
 		self::wp_link_dialog();
 	}
+	/**
+	 * Returns the TinyMCE locale.
+	 *
+	 * @since 4.8.0
+	 *
+	 * @return string
+	 */
 	public static function get_mce_locale() {
 		if ( empty( self::$mce_locale ) ) {
 			$mce_locale       = get_user_locale();
-			self::$mce_locale = empty( $mce_locale ) ? 'en' : strtolower( substr( $mce_locale, 0, 2 ) ); // ISO 639-1
+			self::$mce_locale = empty( $mce_locale ) ? 'en' : strtolower( substr( $mce_locale, 0, 2 ) ); // ISO 639-1.
 		}
 		return self::$mce_locale;
 	}
+	/**
+	 * Returns the TinyMCE base URL.
+	 *
+	 * @since 4.8.0
+	 *
+	 * @return string
+	 */
 	public static function get_baseurl() {
 		if ( empty( self::$baseurl ) ) {
 			self::$baseurl = includes_url( 'js/tinymce' );
 		}
 	}
 	/**
 	 * Returns the default TinyMCE settings.
 	 * Doesn't include plugins, buttons, editor selector.
+	 *
+	 * @since 4.8.0
 	 *
 	 * @global string $tinymce_version
 	 *
 	 * @return array
 	 */
 			'cache_suffix'                 => 'wp-mce-' . $tinymce_version,
 			'resize'                       => 'vertical',
 			'menubar'                      => false,
 			'branding'                     => false,
-			// Limit the preview styles in the menu/toolbar
+			// Limit the preview styles in the menu/toolbar.
 			'preview_styles'               => 'font-family font-size font-weight font-style text-decoration text-transform',
 			'end_container_on_empty_block' => true,
 			'wpeditimage_html5_captions'   => true,
 			'wp_lang_attr'                 => get_bloginfo( 'language' ),
 		);
 		$suffix  = SCRIPT_DEBUG ? '' : '.min';
 		$version = 'ver=' . get_bloginfo( 'version' );
-		// Default stylesheets
+		// Default stylesheets.
 		$settings['content_css'] = includes_url( "css/dashicons$suffix.css?$version" ) . ',' .
 			includes_url( "js/tinymce/skins/wordpress/wp-content.css?$version" );
 		return $settings;
 	}
+	/**
+	 * @since 4.7.0
+	 *
+	 * @return array
+	 */
 	private static function get_translation() {
 		if ( empty( self::$translation ) ) {
 			self::$translation = array(
-				// Default TinyMCE strings
+				// Default TinyMCE strings.
 				'New document'                         => __( 'New document' ),
 				'Formats'                              => _x( 'Formats', 'TinyMCE' ),
 				'Headings'                             => _x( 'Headings', 'TinyMCE' ),
 				'Heading 1'                            => array( __( 'Heading 1' ), 'access1' ),
 				'Heading 3'                            => array( __( 'Heading 3' ), 'access3' ),
 				'Heading 4'                            => array( __( 'Heading 4' ), 'access4' ),
 				'Heading 5'                            => array( __( 'Heading 5' ), 'access5' ),
 				'Heading 6'                            => array( __( 'Heading 6' ), 'access6' ),
-				/* translators: block tags */
+				/* translators: Block tags. */
 				'Blocks'                               => _x( 'Blocks', 'TinyMCE' ),
 				'Paragraph'                            => array( __( 'Paragraph' ), 'access7' ),
 				'Blockquote'                           => array( __( 'Blockquote' ), 'accessQ' ),
 				'Div'                                  => _x( 'Div', 'HTML tag' ),
 				'Pre'                                  => _x( 'Pre', 'HTML tag' ),
 				'Lower Alpha'                          => _x( 'Lower Alpha', 'list style' ),
 				'Upper Alpha'                          => _x( 'Upper Alpha', 'list style' ),
 				'Upper Roman'                          => _x( 'Upper Roman', 'list style' ),
 				'Lower Roman'                          => _x( 'Lower Roman', 'list style' ),
-				// Anchor plugin
+				// Anchor plugin.
 				'Name'                                 => _x( 'Name', 'Name of link anchor (TinyMCE)' ),
 				'Anchor'                               => _x( 'Anchor', 'Link anchor (TinyMCE)' ),
 				'Anchors'                              => _x( 'Anchors', 'Link anchors (TinyMCE)' ),
 				'Id should start with a letter, followed only by letters, numbers, dashes, dots, colons or underscores.' =>
 					__( 'Id should start with a letter, followed only by letters, numbers, dashes, dots, colons or underscores.' ),
 				'Id'                                   => _x( 'Id', 'Id for link anchor (TinyMCE)' ),
-				// Fullpage plugin
+				// Fullpage plugin.
 				'Document properties'                  => __( 'Document properties' ),
 				'Robots'                               => __( 'Robots' ),
 				'Title'                                => __( 'Title' ),
 				'Keywords'                             => __( 'Keywords' ),
 				'Encoding'                             => __( 'Encoding' ),
 				'Description'                          => __( 'Description' ),
 				'Author'                               => __( 'Author' ),
-				// Media, image plugins
+				// Media, image plugins.
 				'Image'                                => __( 'Image' ),
 				'Insert/edit image'                    => array( __( 'Insert/edit image' ), 'accessM' ),
 				'General'                              => __( 'General' ),
 				'Advanced'                             => __( 'Advanced' ),
 				'Source'                               => __( 'Source' ),
 				'Alternative source'                   => __( 'Alternative source' ),
 				'Paste your embed code below:'         => __( 'Paste your embed code below:' ),
 				'Insert video'                         => __( 'Insert video' ),
 				'Embed'                                => __( 'Embed' ),
-				// Each of these have a corresponding plugin
+				// Each of these have a corresponding plugin.
 				'Special character'                    => __( 'Special character' ),
 				'Right to left'                        => _x( 'Right to left', 'editor button' ),
 				'Left to right'                        => _x( 'Left to right', 'editor button' ),
 				'Emoticons'                            => __( 'Emoticons' ),
 				'Nonbreaking space'                    => __( 'Nonbreaking space' ),
 				'Horizontal space'                     => __( 'Horizontal space' ),
 				'Restore last draft'                   => __( 'Restore last draft' ),
 				'Insert/edit link'                     => array( __( 'Insert/edit link' ), 'metaK' ),
 				'Remove link'                          => array( __( 'Remove link' ), 'accessS' ),
-				// Link plugin
+				// Link plugin.
 				'Link'                                 => __( 'Link' ),
 				'Insert link'                          => __( 'Insert link' ),
 				'Target'                               => __( 'Target' ),
 				'New window'                           => __( 'New window' ),
 				'Text to display'                      => __( 'Text to display' ),
 				'The URL you entered seems to be an external link. Do you want to add the required http:// prefix?' =>
 					__( 'The URL you entered seems to be an external link. Do you want to add the required http:// prefix?' ),
 				'Color'                                => __( 'Color' ),
 				'Custom color'                         => __( 'Custom color' ),
-				'Custom...'                            => _x( 'Custom...', 'label for custom color' ), // no ellipsis
+				'Custom...'                            => _x( 'Custom...', 'label for custom color' ), // No ellipsis.
 				'No color'                             => __( 'No color' ),
 				'R'                                    => _x( 'R', 'Short for red in RGB' ),
 				'G'                                    => _x( 'G', 'Short for green in RGB' ),
 				'B'                                    => _x( 'B', 'Short for blue in RGB' ),
-				// Spelling, search/replace plugins
+				// Spelling, search/replace plugins.
 				'Could not find the specified string.' => __( 'Could not find the specified string.' ),
 				'Replace'                              => _x( 'Replace', 'find/replace' ),
 				'Next'                                 => _x( 'Next', 'find/replace' ),
-				/* translators: previous */
+				/* translators: Previous. */
 				'Prev'                                 => _x( 'Prev', 'find/replace' ),
 				'Whole words'                          => _x( 'Whole words', 'find/replace' ),
 				'Find and replace'                     => __( 'Find and replace' ),
 				'Replace with'                         => _x( 'Replace with', 'find/replace' ),
 				'Find'                                 => _x( 'Find', 'find/replace' ),
 				'Finish'                               => _x( 'Finish', 'spellcheck' ),
 				'Ignore all'                           => _x( 'Ignore all', 'spellcheck' ),
 				'Ignore'                               => _x( 'Ignore', 'spellcheck' ),
 				'Add to Dictionary'                    => __( 'Add to Dictionary' ),
-				// TinyMCE tables
+				// TinyMCE tables.
 				'Insert table'                         => __( 'Insert table' ),
 				'Delete table'                         => __( 'Delete table' ),
 				'Table properties'                     => __( 'Table properties' ),
 				'Row properties'                       => __( 'Table row properties' ),
 				'Cell properties'                      => __( 'Table cell properties' ),
 				'Background color'                     => __( 'Background color' ),
 				'Text color'                           => __( 'Text color' ),
 				'Show blocks'                          => _x( 'Show blocks', 'editor button' ),
 				'Show invisible characters'            => __( 'Show invisible characters' ),
-				/* translators: word count */
+				/* translators: Word count. */
 				'Words: {0}'                           => sprintf( __( 'Words: %s' ), '{0}' ),
 				'Paste is now in plain text mode. Contents will now be pasted as plain text until you toggle this option off.' =>
 					__( 'Paste is now in plain text mode. Contents will now be pasted as plain text until you toggle this option off.' ) . "\n\n" .
 					__( 'If you&#8217;re looking to paste rich content from Microsoft Word, try turning this option off. The editor will clean up text pasted from Word automatically.' ),
 				'Rich Text Area. Press ALT-F9 for menu. Press ALT-F10 for toolbar. Press ALT-0 for help' =>
 				'You have unsaved changes are you sure you want to navigate away?' =>
 					__( 'The changes you made will be lost if you navigate away from this page.' ),
 				'Your browser doesn\'t support direct access to the clipboard. Please use the Ctrl+X/C/V keyboard shortcuts instead.' =>
 					__( 'Your browser does not support direct access to the clipboard. Please use keyboard shortcuts or your browser&#8217;s edit menu instead.' ),
-				// TinyMCE menus
+				// TinyMCE menus.
 				'Insert'                               => _x( 'Insert', 'TinyMCE menu' ),
 				'File'                                 => _x( 'File', 'TinyMCE menu' ),
 				'Edit'                                 => _x( 'Edit', 'TinyMCE menu' ),
 				'Tools'                                => _x( 'Tools', 'TinyMCE menu' ),
 				'View'                                 => _x( 'View', 'TinyMCE menu' ),
 				'Table'                                => _x( 'Table', 'TinyMCE menu' ),
 				'Format'                               => _x( 'Format', 'TinyMCE menu' ),
-				// WordPress strings
+				// WordPress strings.
 				'Toolbar Toggle'                       => array( __( 'Toolbar Toggle' ), 'accessZ' ),
 				'Insert Read More tag'                 => array( __( 'Insert Read More tag' ), 'accessT' ),
 				'Insert Page Break tag'                => array( __( 'Insert Page Break tag' ), 'accessP' ),
-				'Read more...'                         => __( 'Read more...' ), // Title on the placeholder inside the editor (no ellipsis)
+				'Read more...'                         => __( 'Read more...' ), // Title on the placeholder inside the editor (no ellipsis).
 				'Distraction-free writing mode'        => array( __( 'Distraction-free writing mode' ), 'accessW' ),
-				'No alignment'                         => __( 'No alignment' ), // Tooltip for the 'alignnone' button in the image toolbar
+				'No alignment'                         => __( 'No alignment' ), // Tooltip for the 'alignnone' button in the image toolbar.
-				'Remove'                               => __( 'Remove' ), // Tooltip for the 'remove' button in the image toolbar
+				'Remove'                               => __( 'Remove' ),       // Tooltip for the 'remove' button in the image toolbar.
-				'Edit|button'                          => __( 'Edit' ), // Tooltip for the 'edit' button in the image toolbar
+				'Edit|button'                          => __( 'Edit' ),         // Tooltip for the 'edit' button in the image toolbar.
-				'Paste URL or type to search'          => __( 'Paste URL or type to search' ), // Placeholder for the inline link dialog
+				'Paste URL or type to search'          => __( 'Paste URL or type to search' ), // Placeholder for the inline link dialog.
-				'Apply'                                => __( 'Apply' ), // Tooltip for the 'apply' button in the inline link dialog
+				'Apply'                                => __( 'Apply' ),        // Tooltip for the 'apply' button in the inline link dialog.
-				'Link options'                         => __( 'Link options' ), // Tooltip for the 'link options' button in the inline link dialog
+				'Link options'                         => __( 'Link options' ), // Tooltip for the 'link options' button in the inline link dialog.
-				'Visual'                               => _x( 'Visual', 'Name for the Visual editor tab' ), // Editor switch tab label
+				'Visual'                               => _x( 'Visual', 'Name for the Visual editor tab' ),             // Editor switch tab label.
-				'Text'                                 => _x( 'Text', 'Name for the Text editor tab (formerly HTML)' ), // Editor switch tab label
+				'Text'                                 => _x( 'Text', 'Name for the Text editor tab (formerly HTML)' ), // Editor switch tab label.
-				'Add Media'                            => array( __( 'Add Media' ), 'accessM' ), // Tooltip for the 'Add Media' button in the Block Editor Classic block
+				'Add Media'                            => array( __( 'Add Media' ), 'accessM' ), // Tooltip for the 'Add Media' button in the block editor Classic block.
-				// Shortcuts help modal
+				// Shortcuts help modal.
 				'Keyboard Shortcuts'                   => array( __( 'Keyboard Shortcuts' ), 'accessH' ),
 				'Classic Block Keyboard Shortcuts'     => __( 'Classic Block Keyboard Shortcuts' ),
 				'Default shortcuts,'                   => __( 'Default shortcuts,' ),
 				'Additional shortcuts,'                => __( 'Additional shortcuts,' ),
 				'Focus shortcuts:'                     => __( 'Focus shortcuts:' ),
 		Imagetools plugin (not included):
 			'Edit image' => __( 'Edit image' ),
 			'Image options' => __( 'Image options' ),
 			'Back' => __( 'Back' ),
 			'Invert' => __( 'Invert' ),
-			'Flip horizontally' => __( 'Flip horizontally' ),
+			'Flip horizontally' => __( 'Flip horizontal' ),
-			'Flip vertically' => __( 'Flip vertically' ),
+			'Flip vertically' => __( 'Flip vertical' ),
 			'Crop' => __( 'Crop' ),
 			'Orientation' => __( 'Orientation' ),
 			'Resize' => __( 'Resize' ),
-			'Rotate clockwise' => __( 'Rotate clockwise' ),
+			'Rotate clockwise' => __( 'Rotate right' ),
-			'Rotate counterclockwise' => __( 'Rotate counterclockwise' ),
+			'Rotate counterclockwise' => __( 'Rotate left' ),
 			'Sharpen' => __( 'Sharpen' ),
 			'Brightness' => __( 'Brightness' ),
 			'Color levels' => __( 'Color levels' ),
 			'Contrast' => __( 'Contrast' ),
 			'Gamma' => __( 'Gamma' ),
 	/**
 	 * Translates the default TinyMCE strings and returns them as JSON encoded object ready to be loaded with tinymce.addI18n(),
 	 * or as JS snippet that should run after tinymce.js is loaded.
 	 *
+	 * @since 3.9.0
+	 *
 	 * @param string $mce_locale The locale used for the editor.
-	 * @param bool $json_only optional Whether to include the JavaScript calls to tinymce.addI18n() and tinymce.ScriptLoader.markDone().
+	 * @param bool   $json_only  Optional. Whether to include the JavaScript calls to tinymce.addI18n() and
+	 *                           tinymce.ScriptLoader.markDone().
 	 * @return string Translation object, JSON encoded.
 	 */
 	public static function wp_mce_translation( $mce_locale = '', $json_only = false ) {
 		if ( ! $mce_locale ) {
 			$mce_locale = self::get_mce_locale();
 			if ( false !== strpos( $value, '&' ) ) {
 				$mce_translation[ $key ] = html_entity_decode( $value, ENT_QUOTES, 'UTF-8' );
 			}
 		}
-		// Set direction
+		// Set direction.
 		if ( is_rtl() ) {
 			$mce_translation['_dir'] = 'rtl';
 		}
 		if ( $json_only ) {
 	 * Force uncompressed TinyMCE when a custom theme has been defined.
 	 *
 	 * The compressed TinyMCE file cannot deal with custom themes, so this makes
 	 * sure that we use the uncompressed TinyMCE file if a theme is defined.
 	 * Even if we are on a production environment.
+	 *
+	 * @since 5.0.0
 	 */
 	public static function force_uncompressed_tinymce() {
 		$has_custom_theme = false;
 		foreach ( self::$mce_settings as $init ) {
 			if ( ! empty( $init['theme_url'] ) ) {
 	/**
 	 * Print (output) the main TinyMCE scripts.
 	 *
 	 * @since 4.8.0
 	 *
-	 * @global string $tinymce_version
+	 * @global bool $concatenate_scripts
-	 * @global bool   $concatenate_scripts
-	 * @global bool   $compress_scripts
 	 */
 	public static function print_tinymce_scripts() {
 		global $concatenate_scripts;
 		if ( self::$tinymce_scripts_printed ) {
 		echo "<script type='text/javascript'>\n" . self::wp_mce_translation() . "</script>\n";
 	}
 	/**
 	 * Print (output) the TinyMCE configuration and initialization scripts.
+	 *
+	 * @since 3.3.0
 	 *
 	 * @global string $tinymce_version
 	 */
 	public static function editor_js() {
 		global $tinymce_version;
 		$tmce_on = ! empty( self::$mce_settings );
-		$mceInit = $qtInit = '';
+		$mceInit = '';
+		$qtInit  = '';
 		if ( $tmce_on ) {
 			foreach ( self::$mce_settings as $editor_id => $init ) {
 				$options  = self::_parse_init( $init );
 				$mceInit .= "'$editor_id':{$options},";
 		if ( $tmce_on ) {
 			self::print_tinymce_scripts();
 			if ( self::$ext_plugins ) {
-				// Load the old-format English strings to prevent unsightly labels in old style popups
+				// Load the old-format English strings to prevent unsightly labels in old style popups.
 				echo "<script type='text/javascript' src='{$baseurl}/langs/wp-langs-en.js?$version'></script>\n";
 			}
 		}
 		/**
 	 * Performs post queries for internal linking.
 	 *
 	 * @since 3.1.0
 	 *
 	 * @param array $args Optional. Accepts 'pagenum' and 's' (search) arguments.
-	 * @return false|array Results.
+	 * @return array|false Results.
 	 */
 	public static function wp_link_query( $args = array() ) {
 		$pts      = get_post_types( array( 'public' => true ), 'objects' );
 		$pt_names = array_keys( $pts );
 		$posts     = $get_posts->query( $query );
 		// Build results.
 		$results = array();
 		foreach ( $posts as $post ) {
-			if ( 'post' == $post->post_type ) {
+			if ( 'post' === $post->post_type ) {
 				$info = mysql2date( __( 'Y/m/d' ), $post->post_date );
 			} else {
 				$info = $pts[ $post->post_type ]->labels->singular_name;
 			}
 		 * @since 3.7.0
 		 *
 		 * @see 'wp_link_query_args' filter
 		 *
 		 * @param array $results {
-		 *     An associative array of query results.
+		 *     An array of associative arrays of query results.
 		 *
-		 *     @type array {
+		 *     @type array ...$0 {
 		 *         @type int    $ID        Post ID.
 		 *         @type string $title     The trimmed, escaped post title.
 		 *         @type string $permalink Post permalink.
 		 *         @type string $info      A 'Y/m/d'-formatted date for 'post' post type,
 		 *                                 the 'singular_name' post type label otherwise.
 	 * Dialog for internal linking.
 	 *
 	 * @since 3.1.0
 	 */
 	public static function wp_link_dialog() {
-		// Run once
+		// Run once.
 		if ( self::$link_dialog_printed ) {
 			return;
 		}
 		self::$link_dialog_printed = true;
-		// display: none is required here, see #WP27605
+		// `display: none` is required here, see #WP27605.
 		?>
 		<div id="wp-link-backdrop" style="display: none"></div>
 		<div id="wp-link-wrap" class="wp-core-ui" style="display: none" role="dialog" aria-labelledby="link-modal-title">
 		<form id="wp-link" tabindex="-1">
 		<?php wp_nonce_field( 'internal-linking', '_ajax_linking_nonce', false ); ?>
 					</div>
 					<ul></ul>
 					<div class="river-waiting">
 						<span class="spinner"></span>
 					</div>
-				 </div>
+				</div>
-			 </div>
+			</div>
 		</div>
 		<div class="submitbox">
 			<div id="wp-link-cancel">
 				<button type="button" class="button"><?php _e( 'Cancel' ); ?></button>
 			</div>

changeset 16	a86126ab1dd4
parent 9	177826044cd9
child 18	be944660c56a