Changeset 61323 for trunk/src/wp-includes/class-wp-dependencies.php

Timestamp:

11/30/2025 12:54:26 AM (9 months ago)

Author:

westonruter

Message:

Script Loader: Emit notices when enqueueing a script, style, or script module with missing dependencies.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/10545

Follow-up to [60999].

Props deepakprajapati, westonruter.
See #63486.
Fixes #64229.

File:

• trunk/src/wp-includes/class-wp-dependencies.php (modified) (3 diffs)

trunk/src/wp-includes/class-wp-dependencies.php

@@ -104 +104 @@
          */
         private $queued_before_register = array();
+
+        /**
+         * List of handles for dependencies encountered which themselves have missing dependencies.
+         *
+         * A dependency handle is added to this list when it is discovered to have missing dependencies. At this time, a
+         * warning is emitted with {@see _doing_it_wrong()}. The handle is then added to this list, so that duplicate
+         * warnings don't occur.
+         *
+         * @since 7.0.0
+         * @var string[]
+         */
+        private $dependencies_with_missing_dependencies = array();
 
         /**
@@ -200 +212 @@
                         }
 
-                        $keep_going = true;
+                        $keep_going           = true;
+                        $missing_dependencies = array();
+                        if ( isset( $this->registered[ $handle ] ) && count( $this->registered[ $handle ]->deps ) > 0 ) {
+                                $missing_dependencies = array_diff( $this->registered[ $handle ]->deps, array_keys( $this->registered ) );
+                        }
                         if ( ! isset( $this->registered[ $handle ] ) ) {
                                 $keep_going = false; // Item doesn't exist.
-                        } elseif ( $this->registered[ $handle ]->deps && array_diff( $this->registered[ $handle ]->deps, array_keys( $this->registered ) ) ) {
+                        } elseif ( count( $missing_dependencies ) > 0 ) {
+                                if ( ! in_array( $handle, $this->dependencies_with_missing_dependencies, true ) ) {
+                                        _doing_it_wrong(
+                                                get_class( $this ) . '::add',
+                                                $this->get_dependency_warning_message( $handle, $missing_dependencies ),
+                                                '7.0.0'
+                                        );
+                                        $this->dependencies_with_missing_dependencies[] = $handle;
+                                }
                                 $keep_going = false; // Item requires dependencies that don't exist.
                         } elseif ( $this->registered[ $handle ]->deps && ! $this->all_deps( $this->registered[ $handle ]->deps, true, $new_group ) ) {
@@ -536 +560 @@
                 return 'W/"' . md5( $etag ) . '"';
         }
+
+        /**
+         * Gets a dependency warning message for a handle.
+         *
+         * @since 7.0.0
+         *
+         * @param string   $handle                     Handle with missing dependencies.
+         * @param string[] $missing_dependency_handles Missing dependency handles.
+         * @return string Formatted, localized warning message.
+         */
+        protected function get_dependency_warning_message( $handle, $missing_dependency_handles ) {
+                return sprintf(
+                        /* translators: 1: Handle, 2: Comma-separated list of missing dependency handles. */
+                        __( 'The handle "%1$s" was enqueued with dependencies that are not registered: %2$s.' ),
+                        $handle,
+                        implode( ', ', $missing_dependency_handles )
+                );
+        }
 }