<!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>[27708] trunk/src/wp-includes/category-template.php: Clarify the return value of wp_generate_tag_cloud().</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">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/27708">27708</a></dd>
<dt>Author</dt> <dd>nacin</dd>
<dt>Date</dt> <dd>2014-03-25 12:55:11 +0000 (Tue, 25 Mar 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Clarify the return value of wp_generate_tag_cloud().
props SergeyBiryukov, DrewAPicture.
fixes <a href="http://core.trac.wordpress.org/ticket/27487">#27487</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescategorytemplatephp">trunk/src/wp-includes/category-template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludescategorytemplatephp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/category-template.php (27707 => 27708)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/category-template.php 2014-03-25 12:52:48 UTC (rev 27707)
+++ trunk/src/wp-includes/category-template.php 2014-03-25 12:55:11 UTC (rev 27708)
</span><span class="lines">@@ -665,7 +665,7 @@
</span><span class="cx"> *
</span><span class="cx"> * @param array $tags List of tags.
</span><span class="cx"> * @param string|array $args Optional, override default arguments.
</span><del>- * @return string
</del><ins>+ * @return string|array Tag cloud as a string or an array, depending on 'format' argument.
</ins><span class="cx"> */
</span><span class="cx"> function wp_generate_tag_cloud( $tags, $args = '' ) {
</span><span class="cx"> $defaults = array(
</span><span class="lines">@@ -678,9 +678,12 @@
</span><span class="cx"> $args = wp_parse_args( $args, $defaults );
</span><span class="cx"> extract( $args, EXTR_SKIP );
</span><span class="cx">
</span><del>- if ( empty( $tags ) )
- return;
</del><ins>+ $return = ( 'array' === $format ) ? array() : '';
</ins><span class="cx">
</span><ins>+ if ( empty( $tags ) ) {
+ return $return;
+ }
+
</ins><span class="cx"> // Juggle topic count tooltips:
</span><span class="cx"> if ( isset( $args['topic_count_text'] ) ) {
</span><span class="cx"> // First look for nooped plural support via topic_count_text.
</span><span class="lines">@@ -791,9 +794,11 @@
</span><span class="cx"> *
</span><span class="cx"> * @see wp_generate_tag_cloud()
</span><span class="cx"> *
</span><del>- * @param string $return Generated HTML output of the tag cloud.
- * @param array $tags An array of terms used in the tag cloud.
- * @param array $args An array of wp_generate_tag_cloud() arguments.
</del><ins>+ * @param array|string $return String containing the generated HTML tag cloud output
+ * or an array of tag links if the 'format' argument
+ * equals 'array'.
+ * @param array $tags An array of terms used in the tag cloud.
+ * @param array $args An array of wp_generate_tag_cloud() arguments.
</ins><span class="cx"> */
</span><span class="cx"> return apply_filters( 'wp_generate_tag_cloud', $return, $tags, $args );
</span><span class="cx"> }
</span></span></pre>
</div>
</div>
</body>
</html>