Changeset 32483

Timestamp:

05/10/2015 07:56:15 PM (9 years ago)

Author:

johnbillion

Message:

Add a return value to wp_register_script() and wp_register_style() which matches the return value of WP_Dependencies::add().

Props katzwebdesign, pareshradadiya, DrewAPicture.

Fixes #31126

Location:

trunk

Files:

• src/wp-includes/class.wp-dependencies.php (modified) (1 diff)
• src/wp-includes/functions.wp-scripts.php (modified) (3 diffs)
• src/wp-includes/functions.wp-styles.php (modified) (2 diffs)
• tests/phpunit/tests/dependencies/scripts.php (modified) (1 diff)
• tests/phpunit/tests/dependencies/styles.php (modified) (1 diff)

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

@@ -214 +214 @@
      * @param string $ver    Optional. Version (used for cache busting).
      * @param mixed  $args   Optional. Custom property of the item. NOT the class property $args. Examples: $media, $in_footer.
-     * @return bool True on success, false on failure.
+     * @return bool Whether the item has been registered. True on success, false on failure.
      */
     public function add( $handle, $src, $deps = array(), $ver = false, $args = null ) {

trunk/src/wp-includes/functions.wp-scripts.php

@@ -95 +95 @@
  *
  * @since 2.6.0
+ * @since 4.3.0 A return value was added.
  *
  * @param string      $handle    Name of the script. Should be unique.
@@ -106 +107 @@
  * @param bool        $in_footer Optional. Whether to enqueue the script before </head> or before </body>.
  *                               Default 'false'. Accepts 'false' or 'true'.
+ * @return bool Whether the script has been registered. True on success, false on failure.
  */
 function wp_register_script( $handle, $src, $deps = array(), $ver = false, $in_footer = false ) {
@@ -111 +113 @@
     _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
 
-    $wp_scripts->add( $handle, $src, $deps, $ver );
+    $registered = $wp_scripts->add( $handle, $src, $deps, $ver );
     if ( $in_footer ) {
         $wp_scripts->add_data( $handle, 'group', 1 );
     }
+
+    return $registered;
 }
 

trunk/src/wp-includes/functions.wp-styles.php

@@ -99 +99 @@
  *
  * @since 2.6.0
+ * @since 4.3.0 A return value was added.
  *
  * @param string      $handle Name of the stylesheet.
@@ -108 +109 @@
  *                            Default 'all'. Accepts 'all', 'aural', 'braille', 'handheld', 'projection', 'print',
  *                            'screen', 'tty', or 'tv'.
+ * @return bool Whether the style has been registered. True on success, false on failure.
  */
 function wp_register_style( $handle, $src, $deps = array(), $ver = false, $media = 'all' ) {
     _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
 
-    wp_styles()->add( $handle, $src, $deps, $ver, $media );
+    return wp_styles()->add( $handle, $src, $deps, $ver, $media );
 }
 

trunk/tests/phpunit/tests/dependencies/scripts.php

@@ -156 +156 @@
         $this->assertEquals( '', get_echo( 'wp_print_scripts' ) );
     }
+
+    /**
+     * Testing 'wp_register_script' return boolean success/failure value.
+     *
+     * @ticket 31126
+     */
+    function test_wp_register_script() {
+        $this->assertTrue( wp_register_script( 'duplicate-handler', 'http://example.com' ) );
+        $this->assertFalse( wp_register_script( 'duplicate-handler', 'http://example.com' ) );
+    }
+
 }

trunk/tests/phpunit/tests/dependencies/styles.php

@@ -230 +230 @@
     }
 
+    /**
+     * Testing 'wp_register_style' return boolean success/failure value.
+     *
+     * @ticket 31126
+     */
+    function test_wp_register_style(){
+        $this->assertTrue( wp_register_style( 'duplicate-handler', 'http://example.com' ) );
+        $this->assertFalse( wp_register_style( 'duplicate-handler', 'http://example.com' ) );
+    }
+
 }