Skip to content

Add _doing_it_wrong() notices for missing script, style, and script module dependencies #10545

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
deepakpra wants to merge 16 commits into from
Closed

Add _doing_it_wrong() notices for missing script, style, and script module dependencies #10545

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
e1a8c92
Script Modules: Add warning when enqueued with missing dependencies.
deepakpra Nov 24, 2025
bc18fd0
Scripts: Add warning when enqueued with missing dependencies.
deepakpra Nov 24, 2025
29772af
Tests: Add doing_it_wrong() check for missing classic script dependen…
deepakpra Nov 25, 2025
5c80d79
Tests: Add doing_it_wrong() test for missing script module dependencies
deepakpra Nov 25, 2025
7a688c7
Refactor missing-dependencies check for readability
deepakpra Nov 25, 2025
9295970
fix phpcs error
deepakpra Nov 25, 2025
4d06b0f
Tests: Add doing_it_wrong() test for missing wp_styles dependencies
deepakpra Nov 26, 2025
f5cc8d1
add get_dependency_warning_message() helper to WP_Dependencies, overr…
deepakpra Nov 26, 2025
3706e96
Remove logic that suppressed duplicate dependency warnings
deepakpra Nov 26, 2025
36b480b
Merge branch 'trunk' into feature/64229-warn-missing-dependencies
westonruter Nov 29, 2025
0d28424
Add double quotes around handle/ID in warning
westonruter Nov 29, 2025
1070c33
Avoid duplicate warnings
westonruter Nov 29, 2025
69eaceb
Use more appropriate methods in _doing_it_wrong() calls
westonruter Nov 29, 2025
a553244
Remove expected deprecation notice by fixing module deregistration
westonruter Nov 30, 2025
b52c39c
Fix reference to handles
westonruter Nov 30, 2025
925f49b
Improve message consistency
westonruter Nov 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion src/wp-includes/class-wp-dependencies.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,9 +200,27 @@ public function all_deps( $handles, $recursion = false, $group = false ) {
}

$keep_going = true;
$missing_dependencies = ( isset( $this->registered[ $handle ] ) && $this->registered[ $handle ]->deps ) ? array_diff( $this->registered[ $handle ]->deps, array_keys( $this->registered ) ) : array();
Comment thread
deepakpra marked this conversation as resolved.
Outdated
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 ( $missing_dependencies ) {
Comment thread
deepakpra marked this conversation as resolved.
Outdated
// Prevent duplicate notices.
static $reported = array();

if ( ! isset( $reported[ $handle ] ) ) {
$reported[ $handle ] = true;
Comment thread
deepakpra marked this conversation as resolved.
Outdated

_doing_it_wrong(
__METHOD__,
sprintf(
/* translators: 1: Script module ID, 2: Comma-separated list of missing dependency IDs. */
__( 'The script with the handle %1$s was enqueued with dependencies that are not registered: %2$s.' ),
Comment thread
deepakpra marked this conversation as resolved.
Outdated
$handle,
implode( ', ', $missing_dependencies )
),
'7.0.0'
);
}
$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 ) ) {
$keep_going = false; // Item requires dependencies that don't exist.
Expand Down
21 changes: 20 additions & 1 deletion src/wp-includes/class-wp-script-modules.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -722,7 +722,26 @@ private function sort_item_dependencies( string $id, array $import_types, array
}

// If the item requires dependencies that do not exist, fail.
if ( count( array_diff( $dependency_ids, array_keys( $this->registered ) ) ) > 0 ) {
$missing_dependencies = array_diff( $dependency_ids, array_keys( $this->registered ) );
if ( count( $missing_dependencies ) > 0 ) {
// Prevent duplicate notices.
static $reported = array();

if ( ! isset( $reported[ $id ] ) ) {
$reported[ $id ] = true;

_doing_it_wrong(
__METHOD__,
sprintf(
/* translators: 1: Script module ID, 2: Comma-separated list of missing dependency IDs. */
__( 'The script module %1$s was enqueued with dependencies that are not registered: %2$s.' ),
$id,
implode( ', ', $missing_dependencies )
),
'7.0.0'
);
}

return false;
}

Expand Down
Loading