Changeset 9524

Timestamp:

02/22/2015 08:17:12 PM (10 years ago)

Author:

djpaul

Message:

BP-Legacy: add a new param to locate_asset_in_stack to allow the enqueued asset's $handleto be explicitly set.

Originally designed to load a template pack's main CSS and JS files in a theme compatibility manner, in r8686 locate_asset_in_stack was used to enqueue a JS file for password strength meters (registration and settings screens). This worked, but the $handle, dynamically constructed and passed to wp_enqueue_script, for the password strength JS file is likely to be the exact same handle as that used for a template pack's main JS file. This has the consequence of making the file(s) registered first unenqueue-able.

The new parameter introduced by this change allows us to explicitly set the name of an enqueued asset's handle, which avoids this problem. Technically the script handle for the password strength meter JS was never intentionally set, so we avoid most of the concerns of a backwards compatibility break, and now allow developers to actually unenqueue a template pack's CSS and JS.

Fixes #5972.
See also #5797.

File:

• trunk/src/bp-templates/bp-legacy/buddypress-functions.php (modified) (3 diffs)

trunk/src/bp-templates/bp-legacy/buddypress-functions.php

@@ -265 +265 @@
 
             // Locate the Register Page JS file
-            $asset = $this->locate_asset_in_stack( "password-verify{$min}.js", 'js' );
+            $asset = $this->locate_asset_in_stack( "password-verify{$min}.js", 'js', 'bp-legacy-password-verify' );
 
             $dependencies = array_merge( bp_core_get_js_dependencies(), array(
@@ -300 +300 @@
      * @since BuddyPress (1.8)
      * @access private
-     * @param string $file A filename like buddypress.cs
-     * @param string $type css|js
+     * @param string $file A filename like buddypress.css
+     * @param string $type Optional. Either "js" or "css" (the default).
+     * @param string $script_handle Optional. If set, used as the script name in `wp_enqueue_script`.
      * @return array An array of data for the wp_enqueue_* function:
      *   'handle' (eg 'bp-child-css') and a 'location' (the URI of the
      *   asset)
      */
-    private function locate_asset_in_stack( $file, $type = 'css' ) {
+    private function locate_asset_in_stack( $file, $type = 'css', $script_handle = '' ) {
         // Child, parent, theme compat
         $locations = array();
@@ -344 +345 @@
                 if ( file_exists( trailingslashit( $location['dir'] ) . trailingslashit( $subdir ) . $location['file'] ) ) {
                     $retval['location'] = trailingslashit( $location['uri'] ) . trailingslashit( $subdir ) . $location['file'];
-                    $retval['handle']   = $location_type . '-' . $type;
+                    $retval['handle']   = ( $script_handle ) ? $script_handle : "{$location_type}-{$type}";
+
                     break 2;
                 }