Changeset 51394

Timestamp:

07/09/2021 05:58:45 PM (3 years ago)

Author:

desrosj

Message:

Docs: Some documentation improvements for wp_check_widget_editor_deps():

• Add missing short description for the function.
• Correct function names in _doing_it_wrong() calls.
• Document the usage of $wp_scripts and $wp_styles globals.
• Update syntax for multi-line comment per the documentation standards.

Follow-up to [51387], [51388].

Props SergeyBiryukov.
Merges [51390] to the 5.8 branch.
See #53437, #53569.

Location:

branches/5.8

Files:

• . (modified) (1 prop)
• src/wp-includes/script-loader.php (modified) (2 diffs)
• src/wp-includes/widgets.php (modified) (3 diffs)

branches/5.8/src/wp-includes/script-loader.php

@@ -383 +383 @@
     );
 
-    // wp-editor module is exposed as window.wp.editor
-    // Problem: there is quite some code expecting window.wp.oldEditor object available under window.wp.editor
-    // Solution: fuse the two objects together to maintain backward compatibility
-    // For more context, see https://github.com/WordPress/gutenberg/issues/33203
+    /*
+     * wp-editor module is exposed as window.wp.editor.
+     * Problem: there is quite some code expecting window.wp.oldEditor object available under window.wp.editor.
+     * Solution: fuse the two objects together to maintain backward compatibility.
+     * For more context, see https://github.com/WordPress/gutenberg/issues/33203.
+     */
     $scripts->add_inline_script(
         'wp-editor',
@@ -2270 +2272 @@
  *
  * @since 5.8.0
- *
- * @return void
  */
 function wp_enqueue_global_styles() {

branches/5.8/src/wp-includes/widgets.php

@@ -2009 +2009 @@
 
 /**
+ * Displays a _doing_it_wrong() message for conflicting widget editor scripts.
+ *
  * The 'wp-editor' script module is exposed as window.wp.editor. This overrides
  * the legacy TinyMCE editor module which is required by the widgets editor.
- * Because of that conflict, these two shouldn't be enqueued together. See
- * https://core.trac.wordpress.org/ticket/53569.
+ * Because of that conflict, these two shouldn't be enqueued together.
+ * See https://core.trac.wordpress.org/ticket/53569.
  *
  * There is also another conflict related to styles where the block widgets
- * editor is hidden if a block enqueues 'wp-edit-post' stylesheet. See
- * https://core.trac.wordpress.org/ticket/53569.
+ * editor is hidden if a block enqueues 'wp-edit-post' stylesheet.
+ * See https://core.trac.wordpress.org/ticket/53569.
  *
  * @since 5.8.0
  * @access private
+ *
+ * @global WP_Scripts $wp_scripts
+ * @global WP_Styles  $wp_styles
  */
 function wp_check_widget_editor_deps() {
     global $wp_scripts, $wp_styles;
+
     if (
         $wp_scripts->query( 'wp-edit-widgets', 'enqueued' ) ||
@@ -2029 +2035 @@
         if ( $wp_scripts->query( 'wp-editor', 'enqueued' ) ) {
             _doing_it_wrong(
-                'enqueue_script',
+                'wp_enqueue_script()',
                 '"wp-editor" script should not be enqueued together with the new widgets editor (wp-edit-widgets or wp-customize-widgets).',
                 '5.8.0'
@@ -2036 +2042 @@
         if ( $wp_styles->query( 'wp-edit-post', 'enqueued' ) ) {
             _doing_it_wrong(
-                'enqueue_style',
+                'wp_enqueue_style()',
                 '"wp-edit-post" style should not be enqueued together with the new widgets editor (wp-edit-widgets or wp-customize-widgets).',
                 '5.8.0'