WordPress.org

Make WordPress Core

Opened 2 years ago

Last modified 3 months ago

#20513 new enhancement

Refactor $wp_scripts init checking code

Reported by: GaryJ Owned by:
Milestone: Awaiting Review Priority: normal
Severity: normal Version: 3.4
Component: Script Loader Keywords: has-patch needs-testing
Focuses: Cc:

Description

The functions in functions.wp-scripts.php seem to contain a lot of duplicate code in terms of checking and initializing the global $wp_scripts in each function.

Attached is rough first pass at creating a function to do this. I expect aspects of it could be done better.

I've included the first argument, to avoid relying on a global so that the function might be unit tested (pass something in, see what gets returned).

Attachments (3)

20513.diff (5.5 KB) - added by GaryJ 2 years ago.
First pass
20513.2.diff (5.8 KB) - added by scribu 2 years ago.
Second pass
20513.3.diff (5.7 KB) - added by scribu 2 years ago.
wp_scripts()

Download all attachments as: .zip

Change History (15)

GaryJ2 years ago

First pass

comment:1 scribu2 years ago

+1 in general. Note that __FUNCTION__ would have to be passed along.

scribu2 years ago

Second pass

comment:2 scribu2 years ago

20513.2.diff:

  • accept first parameter by reference, instead of returning a new instance
  • replaced $fallback parameter with $function

Not really sure if the extra check in wp_localize_script() is worth it. Could just instantiate anyway.

Version 0, edited 2 years ago by scribu (next)

scribu2 years ago

wp_scripts()

comment:3 scribu2 years ago

20513.3.diff replaces wp_scripts_maybe_initialize() with wp_scripts(), so you can do:

wp_scripts()->do_items( $handle );

etc.

Last edited 2 years ago by scribu (previous) (diff)

comment:4 scribu2 years ago

I don't think this init code is relevant for unit testing. If you want to unit test WP_Scripts, just create an instance manually.

Last edited 2 years ago by scribu (previous) (diff)

comment:5 GaryJ2 years ago

That looks good to me.

Might be another ticket, but I suspect something similar can be done with $wp_styles too.

comment:6 ocean902 years ago

  • Cc ocean90 added

comment:7 azaozz2 years ago

Think I attempted to do something similar for 3.2 (or was it 3.3). The argument against it is that this breaks the backtrace so if a plugin author calls any of these functions too early _doing_it_wrong() would show the wrong reference.

comment:8 scribu2 years ago

If the function reference is so important, we could pass it along:

wp_scripts( __FUNCTION__ )->do_items( $handle );

comment:10 follow-up: GaryJ2 years ago

Related discussion: #11526.

How expensive is debug_backtrace( false )?

How many themes and plugins are still firing these functions before init action has occurred? (Nacin's relatively recent post might have reminded some of the authors to be using the wp_enqueue_scripts hook.)

Could wp_debug_backtrace_summary() be used to pinpoint the original function called?

While scribu's suggestion may well work, it seems dirty to be including an argument purely for debugging purposes.

comment:11 in reply to: ↑ 10 SergeyBiryukov2 years ago

Replying to GaryJ:

How many themes and plugins are still firing these functions before init action has occurred?

Plugins: http://pastebin.com/szGUhsp0 (may have some false positives due to a lack of whitespace).
Themes: http://pastebin.com/bbM47tG8 (tried to filter out false positives).

comment:12 nacin3 months ago

  • Component changed from General to Script Loader
Note: See TracTickets for help on using tickets.