<!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>[36993] trunk/src/wp-includes: Docs: Improvements and corrections for the `$ver` parameter of the dependencies API functions.</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/36993">36993</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/36993","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>2016-03-14 22:36:26 +0000 (Mon, 14 Mar 2016)</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'>Docs: Improvements and corrections for the `$ver` parameter of the dependencies API functions.
See <a href="https://core.trac.wordpress.org/ticket/32246">#32246</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>
</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 2016-03-14 22:30:31 UTC (rev 36992)
+++ trunk/src/wp-includes/class.wp-dependencies.php 2016-03-14 22:36:26 UTC (rev 36993)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -204,11 +204,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.6.0 Moved from `WP_Scripts`.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $handle Unique item name.
- * @param string $src The item url.
- * @param array $deps Optional. An array of item handle strings on which this item depends.
- * @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.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $handle Name of the item. Should be unique.
+ * @param string $src Full URL of the item, or path of the item relative to the WordPress root directory.
+ * @param array $deps Optional. An array of registered item handles this item depends on. Default empty array.
+ * @param string|bool|null $ver Optional. String specifying item version number, if it has one, which is added to the URL
+ * as a query string for cache busting purposes. If version is set to false, a version
+ * number is automatically added equal to current installed WordPress version.
+ * If set to null, no version is added.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool Whether the item has been registered. True on success, false on failure.
</span><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></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 2016-03-14 22:30:31 UTC (rev 36992)
+++ trunk/src/wp-includes/functions.wp-scripts.php 2016-03-14 22:36:26 UTC (rev 36993)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -97,7 +97,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see WP_Scripts::add_inline_script()
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $handle Name of the script to add the inline script to. Must be lowercase.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $handle Name of the script to add the inline script to.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $data String containing the javascript to be added.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $position Optional. Whether to add the inline script before the handle
</span><span class="cx" style="display: block; padding: 0 10px"> * or after. Default 'after'.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -117,7 +117,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Register a new script.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Registers a script to be linked later using the wp_enqueue_script() function.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Registers a script to be enqueued later using the wp_enqueue_script() function.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see WP_Dependencies::add()
</span><span class="cx" style="display: block; padding: 0 10px"> * @see WP_Dependencies::add_data()
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -125,16 +125,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.3.0 A return value was added.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $handle Name of the script. Should be unique.
- * @param string $src Path to the script from the WordPress root directory. Example: '/js/myscript.js'.
- * @param array $deps Optional. An array of registered script handles this script depends on. Set to false if there
- * are no dependencies. Default empty array.
- * @param string|bool $ver Optional. String specifying script version number, if it has one, which is concatenated
- * to end of path as a query string. If no version is specified or set to false, a version
- * number is automatically added equal to current installed WordPress version.
- * If set to null, no version is added. Default 'false'. Accepts 'false', 'null', or 'string'.
- * @param bool $in_footer Optional. Whether to enqueue the script before </head> or before </body>.
- * Default 'false'. Accepts 'false' or 'true'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $handle Name of the script. Should be unique.
+ * @param string $src Full URL of the script, or path of the script relative to the WordPress root directory.
+ * @param array $deps Optional. An array of registered script handles this script depends on. Default empty array.
+ * @param string|bool|null $ver Optional. String specifying script version number, if it has one, which is added to the URL
+ * as a query string for cache busting purposes. If version is set to false, a version
+ * number is automatically added equal to current installed WordPress version.
+ * If set to null, no version is added.
+ * @param bool $in_footer Optional. Whether to enqueue the script before </body> instead of in the <head>.
+ * Default 'false'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool Whether the script has been registered. True on success, false on failure.
</span><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="lines" style="display: block; padding: 0 10px; color: #888">@@ -241,14 +240,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $handle Name of the script.
- * @param string|bool $src Path to the script from the root directory of WordPress. Example: '/js/myscript.js'.
- * @param array $deps An array of registered handles this script depends on. Default empty array.
- * @param string|bool $ver Optional. String specifying the script version number, if it has one. This parameter
- * is used to ensure that the correct version is sent to the client regardless of caching,
- * and so should be included if a version number is available and makes sense for the script.
- * @param bool $in_footer Optional. Whether to enqueue the script before </head> or before </body>.
- * Default 'false'. Accepts 'false' or 'true'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $handle Name of the script. Should be unique.
+ * @param string $src Full URL of the script, or path of the script relative to the WordPress root directory.
+ * @param array $deps Optional. An array of registered script handles this script depends on. Default empty array.
+ * @param string|bool|null $ver Optional. String specifying script version number, if it has one, which is added to the URL
+ * as a query string for cache busting purposes. If version is set to false, a version
+ * number is automatically added equal to current installed WordPress version.
+ * If set to null, no version is added.
+ * @param bool $in_footer Optional. Whether to enqueue the script before </body> instead of in the <head>.
+ * Default 'false'.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_enqueue_script( $handle, $src = false, $deps = array(), $ver = false, $in_footer = false ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_scripts = wp_scripts();
</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 2016-03-14 22:30:31 UTC (rev 36992)
+++ trunk/src/wp-includes/functions.wp-styles.php 2016-03-14 22:36:26 UTC (rev 36993)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -76,7 +76,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.3.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $handle Name of the stylesheet to add the extra styles to. Must be lowercase.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $handle Name of the stylesheet to add the extra styles to.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $data String containing the CSS styles to be added.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool True on success, false on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -100,15 +100,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.6.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.3.0 A return value was added.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $handle Name of the stylesheet.
- * @param string|bool $src Path to the stylesheet from the WordPress root directory. Example: '/css/mystyle.css'.
- * @param array $deps An array of registered style handles this stylesheet depends on. Default empty array.
- * @param string|bool $ver String specifying the stylesheet version number. Used to ensure that the correct version
- * is sent to the client regardless of caching. Default 'false'. Accepts 'false', 'null', or 'string'.
- * @param string $media Optional. The media for which this stylesheet has been defined.
- * Default 'all'. Accepts media types like 'all', 'print' and 'screen', or media queries like
- * '(orientation: portrait)' and '(max-width: 640px)'.
- *
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $handle Name of the stylesheet. Should be unique.
+ * @param string $src Full URL of the stylesheet, or path of the stylesheet relative to the WordPress root directory.
+ * @param array $deps Optional. An array of registered stylesheet handles this stylesheet depends on. Default empty array.
+ * @param string|bool|null $ver Optional. String specifying stylesheet version number, if it has one, which is added to the URL
+ * as a query string for cache busting purposes. If version is set to false, a version
+ * number is automatically added equal to current installed WordPress version.
+ * If set to null, no version is added.
+ * @param string $media Optional. The media for which this stylesheet has been defined.
+ * Default 'all'. Accepts media types like 'all', 'print' and 'screen', or media queries like
+ * '(orientation: portrait)' and '(max-width: 640px)'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool Whether the style has been registered. True on success, false on failure.
</span><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="lines" style="display: block; padding: 0 10px; color: #888">@@ -143,15 +144,16 @@
</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><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $handle Name of the stylesheet.
- * @param string|bool $src Path to the stylesheet from the root directory of WordPress. Example: '/css/mystyle.css'.
- * @param array $deps An array of registered style handles this stylesheet depends on. Default empty array.
- * @param string|bool $ver String specifying the stylesheet version number, if it has one. This parameter is used
- * to ensure that the correct version is sent to the client regardless of caching, and so
- * should be included if a version number is available and makes sense for the stylesheet.
- * @param string $media Optional. The media for which this stylesheet has been defined.
- * Default 'all'. Accepts media types like 'all', 'print' and 'screen', or media queries like
- * '(orientation: portrait)' and '(max-width: 640px)'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $handle Name of the stylesheet. Should be unique.
+ * @param string $src Full URL of the stylesheet, or path of the stylesheet relative to the WordPress root directory.
+ * @param array $deps Optional. An array of registered stylesheet handles this stylesheet depends on. Default empty array.
+ * @param string|bool|null $ver Optional. String specifying stylesheet version number, if it has one, which is added to the URL
+ * as a query string for cache busting purposes. If version is set to false, a version
+ * number is automatically added equal to current installed WordPress version.
+ * If set to null, no version is added.
+ * @param string $media Optional. The media for which this stylesheet has been defined.
+ * Default 'all'. Accepts media types like 'all', 'print' and 'screen', or media queries like
+ * '(orientation: portrait)' and '(max-width: 640px)'.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_enqueue_style( $handle, $src = false, $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></pre>
</div>
</div>
</body>
</html>