<!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" /><style type="text/css"><!--
#msg dl { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer { 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 #fc0 solid; padding: 6px; }
#msg ul, pre { overflow: auto; }
#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>
<title>[12531] trunk/wp-includes/functions.wp-styles.php:
phpDoc updates for functions.wp-styles.php.</title>
</head>
<body>
<div id="msg">
<dl>
<dt>Revision</dt> <dd><a href="http://trac.wordpress.org/changeset/12531">12531</a></dd>
<dt>Author</dt> <dd>westi</dd>
<dt>Date</dt> <dd>2009-12-24 08:21:16 +0000 (Thu, 24 Dec 2009)</dd>
</dl>
<h3>Log Message</h3>
<pre>phpDoc updates for functions.wp-styles.php. Merge from BackPress props CharlesClarkson.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpincludesfunctionswpstylesphp">trunk/wp-includes/functions.wp-styles.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwpincludesfunctionswpstylesphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/functions.wp-styles.php (12530 => 12531)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/functions.wp-styles.php 2009-12-24 08:08:13 UTC (rev 12530)
+++ trunk/wp-includes/functions.wp-styles.php 2009-12-24 08:21:16 UTC (rev 12531)
</span><span class="lines">@@ -13,7 +13,8 @@
</span><span class="cx"> * @uses do_action() Calls 'wp_print_styles' hook.
</span><span class="cx"> * @global object $wp_styles The WP_Styles object for printing styles.
</span><span class="cx"> *
</span><del>- * @param array $handles (optional) Styles to be printed. (void) prints queue, (string) prints that style, (array of strings) prints those styles.
</del><ins>+ * @param array|bool $handles Styles to be printed. An empty array prints the queue,
+ * an array with one string prints that style, and an array of strings prints those styles.
</ins><span class="cx"> * @return bool True on success, false on failure.
</span><span class="cx"> */
</span><span class="cx"> function wp_print_styles( $handles = false ) {
</span><span class="lines">@@ -36,7 +37,18 @@
</span><span class="cx"> * Register CSS style file.
</span><span class="cx"> *
</span><span class="cx"> * @since r79
</span><del>- * @see WP_Styles::add() For parameter and additional information.
</del><ins>+ * @see WP_Styles::add() For additional information.
+ * @global object $wp_styles The WP_Styles object for printing styles.
+ * @link http://www.w3.org/TR/CSS2/media.html#media-types List of CSS media types.
+ *
+ * @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 Array of handles of any stylesheet that this stylesheet depends on.
+ * (Stylesheets that must be loaded before this stylesheet.) Pass an empty array if there are no dependencies.
+ * @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 The media for which this stylesheet has been defined.
</ins><span class="cx"> */
</span><span class="cx"> function wp_register_style( $handle, $src, $deps = array(), $ver = false, $media = 'all' ) {
</span><span class="cx"> global $wp_styles;
</span><span class="lines">@@ -50,7 +62,10 @@
</span><span class="cx"> * Remove a registered CSS file.
</span><span class="cx"> *
</span><span class="cx"> * @since r79
</span><del>- * @see WP_Styles::remove() For parameter and additional information.
</del><ins>+ * @see WP_Styles::remove() For additional information.
+ * @global object $wp_styles The WP_Styles object for printing styles.
+ *
+ * @param string $handle Name of the stylesheet.
</ins><span class="cx"> */
</span><span class="cx"> function wp_deregister_style( $handle ) {
</span><span class="cx"> global $wp_styles;
</span><span class="lines">@@ -65,6 +80,17 @@
</span><span class="cx"> *
</span><span class="cx"> * @since r79
</span><span class="cx"> * @see WP_Styles::add(), WP_Styles::enqueue()
</span><ins>+ * @global object $wp_styles The WP_Styles object for printing styles.
+ * @link http://www.w3.org/TR/CSS2/media.html#media-types List of CSS media types.
+ *
+ * @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 Array of handles (names) of any stylesheet that this stylesheet depends on.
+ * (Stylesheets that must be loaded before this stylesheet.) Pass an empty array if there are no dependencies.
+ * @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 The media for which this stylesheet has been defined.
</ins><span class="cx"> */
</span><span class="cx"> function wp_enqueue_style( $handle, $src = false, $deps = array(), $ver = false, $media = false ) {
</span><span class="cx"> global $wp_styles;
</span><span class="lines">@@ -81,14 +107,14 @@
</span><span class="cx"> /**
</span><span class="cx"> * Check whether style has been added to WordPress Styles.
</span><span class="cx"> *
</span><del>- * The values for list defaults to 'queue', which is the same as enqueue for
- * styles.
</del><ins>+ * The values for list defaults to 'queue', which is the same as wp_enqueue_style().
</ins><span class="cx"> *
</span><span class="cx"> * @since WP unknown; BP unknown
</span><ins>+ * @global object $wp_styles The WP_Styles object for printing styles.
</ins><span class="cx"> *
</span><del>- * @param string $handle Handle used to add style.
- * @param string $list Optional, defaults to 'queue'. Others values are 'registered', 'queue', 'done', 'to_do'
- * @return bool
</del><ins>+ * @param string $handle Name of the stylesheet.
+ * @param string $list Values are 'registered', 'done', 'queue' and 'to_do'.
+ * @return bool True on success, false on failure.
</ins><span class="cx"> */
</span><span class="cx"> function wp_style_is( $handle, $list = 'queue' ) {
</span><span class="cx"> global $wp_styles;
</span></span></pre>
</div>
</div>
</body>
</html>