Changeset 44121

Timestamp:

12/13/2018 08:11:09 PM (6 years ago)

Author:

desrosj

Message:

General: Extract the code editor settings from wp_enqueue_code_editor().

They're now returned by a new function, wp_get_code_editor_settings(), so they can be reused by the block editor.

Props pento.

Merges [43761] to trunk.

Fixes #45127.

Location:

trunk

Files:

• . (modified) (1 prop)
• src/wp-includes/general-template.php (modified) (5 diffs)

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

@@ -3199 +3199 @@
  *
  * @see wp_enqueue_editor()
+ * @see wp_get_code_editor_settings();
  * @see _WP_Editors::parse_settings()
+ *
  * @param array $args {
  *     Args.
@@ -3212 +3214 @@
  *     @type array    $htmlhint   JSHint rule overrides.
  * }
- * @returns array|false Settings for the enqueued code editor, or false if the editor was not enqueued .
+ * @return array|false Settings for the enqueued code editor, or false if the editor was not enqueued.
  */
 function wp_enqueue_code_editor( $args ) {
@@ -3219 +3221 @@
     }
 
+    $settings = wp_get_code_editor_settings( $args );
+
+    if ( empty( $settings ) || empty( $settings['codemirror'] ) ) {
+        return false;
+    }
+
+    wp_enqueue_script( 'code-editor' );
+    wp_enqueue_style( 'code-editor' );
+
+    if ( isset( $settings['codemirror']['mode'] ) ) {
+        $mode = $settings['codemirror']['mode'];
+        if ( is_string( $mode ) ) {
+            $mode = array(
+                'name' => $mode,
+            );
+        }
+
+        if ( ! empty( $settings['codemirror']['lint'] ) ) {
+            switch ( $mode['name'] ) {
+                case 'css':
+                case 'text/css':
+                case 'text/x-scss':
+                case 'text/x-less':
+                    wp_enqueue_script( 'csslint' );
+                    break;
+                case 'htmlmixed':
+                case 'text/html':
+                case 'php':
+                case 'application/x-httpd-php':
+                case 'text/x-php':
+                    wp_enqueue_script( 'htmlhint' );
+                    wp_enqueue_script( 'csslint' );
+                    wp_enqueue_script( 'jshint' );
+                    if ( ! current_user_can( 'unfiltered_html' ) ) {
+                        wp_enqueue_script( 'htmlhint-kses' );
+                    }
+                    break;
+                case 'javascript':
+                case 'application/ecmascript':
+                case 'application/json':
+                case 'application/javascript':
+                case 'application/ld+json':
+                case 'text/typescript':
+                case 'application/typescript':
+                    wp_enqueue_script( 'jshint' );
+                    wp_enqueue_script( 'jsonlint' );
+                    break;
+            }
+        }
+    }
+
+    wp_add_inline_script( 'code-editor', sprintf( 'jQuery.extend( wp.codeEditor.defaultSettings, %s );', wp_json_encode( $settings ) ) );
+
+    /**
+     * Fires when scripts and styles are enqueued for the code editor.
+     *
+     * @since 4.9.0
+     *
+     * @param array $settings Settings for the enqueued code editor.
+     */
+    do_action( 'wp_enqueue_code_editor', $settings );
+
+    return $settings;
+}
+
+/**
+ * Generate and return code editor settings.
+ *
+ * @since 5.0.0
+ *
+ * @see wp_enqueue_code_editor()
+ *
+ * @param array $args {
+ *     Args.
+ *
+ *     @type string   $type       The MIME type of the file to be edited.
+ *     @type string   $file       Filename to be edited. Extension is used to sniff the type. Can be supplied as alternative to `$type` param.
+ *     @type WP_Theme $theme      Theme being edited when on theme editor.
+ *     @type string   $plugin     Plugin being edited when on plugin editor.
+ *     @type array    $codemirror Additional CodeMirror setting overrides.
+ *     @type array    $csslint    CSSLint rule overrides.
+ *     @type array    $jshint     JSHint rule overrides.
+ *     @type array    $htmlhint   JSHint rule overrides.
+ * }
+ * @return array|false Settings for the code editor.
+ */
+function wp_get_code_editor_settings( $args ) {
     $settings = array(
         'codemirror' => array(
@@ -3551 +3640 @@
      * @param array $settings The array of settings passed to the code editor. A falsey value disables the editor.
      * @param array $args {
-     *     Args passed when calling `wp_enqueue_code_editor()`.
+     *     Args passed when calling `get_code_editor_settings()`.
      *
      *     @type string   $type       The MIME type of the file to be edited.
@@ -3563 +3652 @@
      * }
      */
-    $settings = apply_filters( 'wp_code_editor_settings', $settings, $args );
-
-    if ( empty( $settings ) || empty( $settings['codemirror'] ) ) {
-        return false;
-    }
-
-    wp_enqueue_script( 'code-editor' );
-    wp_enqueue_style( 'code-editor' );
-
-    if ( isset( $settings['codemirror']['mode'] ) ) {
-        $mode = $settings['codemirror']['mode'];
-        if ( is_string( $mode ) ) {
-            $mode = array(
-                'name' => $mode,
-            );
-        }
-
-        if ( ! empty( $settings['codemirror']['lint'] ) ) {
-            switch ( $mode['name'] ) {
-                case 'css':
-                case 'text/css':
-                case 'text/x-scss':
-                case 'text/x-less':
-                    wp_enqueue_script( 'csslint' );
-                    break;
-                case 'htmlmixed':
-                case 'text/html':
-                case 'php':
-                case 'application/x-httpd-php':
-                case 'text/x-php':
-                    wp_enqueue_script( 'htmlhint' );
-                    wp_enqueue_script( 'csslint' );
-                    wp_enqueue_script( 'jshint' );
-                    if ( ! current_user_can( 'unfiltered_html' ) ) {
-                        wp_enqueue_script( 'htmlhint-kses' );
-                    }
-                    break;
-                case 'javascript':
-                case 'application/ecmascript':
-                case 'application/json':
-                case 'application/javascript':
-                case 'application/ld+json':
-                case 'text/typescript':
-                case 'application/typescript':
-                    wp_enqueue_script( 'jshint' );
-                    wp_enqueue_script( 'jsonlint' );
-                    break;
-            }
-        }
-    }
-
-    wp_add_inline_script( 'code-editor', sprintf( 'jQuery.extend( wp.codeEditor.defaultSettings, %s );', wp_json_encode( $settings ) ) );
-
-    /**
-     * Fires when scripts and styles are enqueued for the code editor.
-     *
-     * @since 4.9.0
-     *
-     * @param array $settings Settings for the enqueued code editor.
-     */
-    do_action( 'wp_enqueue_code_editor', $settings );
-
-    return $settings;
+    return apply_filters( 'wp_code_editor_settings', $settings, $args );
 }