<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[32483] trunk: Add a return value to `wp_register_script()` and `wp_register_style()` which matches the return value of `WP_Dependencies::add()`.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/32483">32483</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/32483","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>johnbillion</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-05-10 19:56:15 +0000 (Sun, 10 May 2015)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/ticket/31126">#31126</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpdependenciesphp">trunk/src/wp-includes/class.wp-dependencies.php</a></li>
<li><a href="#trunksrcwpincludesfunctionswpscriptsphp">trunk/src/wp-includes/functions.wp-scripts.php</a></li>
<li><a href="#trunksrcwpincludesfunctionswpstylesphp">trunk/src/wp-includes/functions.wp-styles.php</a></li>
<li><a href="#trunktestsphpunittestsdependenciesscriptsphp">trunk/tests/phpunit/tests/dependencies/scripts.php</a></li>
<li><a href="#trunktestsphpunittestsdependenciesstylesphp">trunk/tests/phpunit/tests/dependencies/styles.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpdependenciesphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class.wp-dependencies.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class.wp-dependencies.php 2015-05-10 18:23:21 UTC (rev 32482)
+++ trunk/src/wp-includes/class.wp-dependencies.php 2015-05-10 19:56:15 UTC (rev 32483)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -213,7 +213,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $deps Optional. An array of item handle strings on which this item depends.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $ver Optional. Version (used for cache busting).
</span><span class="cx" style="display: block; padding: 0 10px"> * @param mixed $args Optional. Custom property of the item. NOT the class property $args. Examples: $media, $in_footer.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return bool True on success, false on failure.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool Whether the item has been registered. True on success, false on failure.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function add( $handle, $src, $deps = array(), $ver = false, $args = null ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset($this->registered[$handle]) )
</span></span></pre></div>
<a id="trunksrcwpincludesfunctionswpscriptsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/functions.wp-scripts.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/functions.wp-scripts.php 2015-05-10 18:23:21 UTC (rev 32482)
+++ trunk/src/wp-includes/functions.wp-scripts.php 2015-05-10 19:56:15 UTC (rev 32483)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -94,6 +94,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.6.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.3.0 A return value was added.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $handle Name of the script. Should be unique.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $src Path to the script from the WordPress root directory. Example: '/js/myscript.js'.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -105,15 +106,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * If set to null, no version is added. Default 'false'. Accepts 'false', 'null', or 'string'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool $in_footer Optional. Whether to enqueue the script before </head> or before </body>.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default 'false'. Accepts 'false' or 'true'.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool Whether the script has been registered. True on success, false on failure.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_register_script( $handle, $src, $deps = array(), $ver = false, $in_footer = false ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_scripts = wp_scripts();
</span><span class="cx" style="display: block; padding: 0 10px"> _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $wp_scripts->add( $handle, $src, $deps, $ver );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $registered = $wp_scripts->add( $handle, $src, $deps, $ver );
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $in_footer ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_scripts->add_data( $handle, 'group', 1 );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ return $registered;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre></div>
<a id="trunksrcwpincludesfunctionswpstylesphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/functions.wp-styles.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/functions.wp-styles.php 2015-05-10 18:23:21 UTC (rev 32482)
+++ trunk/src/wp-includes/functions.wp-styles.php 2015-05-10 19:56:15 UTC (rev 32483)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -98,6 +98,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @link http://www.w3.org/TR/CSS2/media.html#media-types List of CSS media types.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.6.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.3.0 A return value was added.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $handle Name of the stylesheet.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|bool $src Path to the stylesheet from the WordPress root directory. Example: '/css/mystyle.css'.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -107,11 +108,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $media Optional. The media for which this stylesheet has been defined.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default 'all'. Accepts 'all', 'aural', 'braille', 'handheld', 'projection', 'print',
</span><span class="cx" style="display: block; padding: 0 10px"> * 'screen', 'tty', or 'tv'.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool Whether the style has been registered. True on success, false on failure.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_register_style( $handle, $src, $deps = array(), $ver = false, $media = 'all' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> _wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- wp_styles()->add( $handle, $src, $deps, $ver, $media );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return wp_styles()->add( $handle, $src, $deps, $ver, $media );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre></div>
<a id="trunktestsphpunittestsdependenciesscriptsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/dependencies/scripts.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/dependencies/scripts.php 2015-05-10 18:23:21 UTC (rev 32482)
+++ trunk/tests/phpunit/tests/dependencies/scripts.php 2015-05-10 19:56:15 UTC (rev 32483)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -155,4 +155,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // No scripts left to print
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( '', get_echo( 'wp_print_scripts' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * 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' ) );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestsdependenciesstylesphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/dependencies/styles.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/dependencies/styles.php 2015-05-10 18:23:21 UTC (rev 32482)
+++ trunk/tests/phpunit/tests/dependencies/styles.php 2015-05-10 19:56:15 UTC (rev 32483)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -229,4 +229,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $expected, get_echo( 'wp_print_styles' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * 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' ) );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>