<!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>[32996] trunk: Introduce 'wp_generate_tag_cloud_data' filter.</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/32996">32996</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/32996","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-06-29 14:15:59 +0000 (Mon, 29 Jun 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'>Introduce 'wp_generate_tag_cloud_data' filter.
This filter allows developers to modify the data that is used to create tag
clouds, without having to manipulate the tag cloud markup directly.
As part of the refactor, this changeset also adds a few unit tests for the way
`wp_generate_tag_cloud()` generates the 'title' attribute, as well as
improvements to output escaping.
Props flixos90, ysalame.
Fixes <a href="https://core.trac.wordpress.org/ticket/24656">#24656</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescategorytemplatephp">trunk/src/wp-includes/category-template.php</a></li>
<li><a href="#trunktestsphpunitteststermwpGenerateTagCloudphp">trunk/tests/phpunit/tests/term/wpGenerateTagCloud.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludescategorytemplatephp"></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/category-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/category-template.php 2015-06-29 13:18:48 UTC (rev 32995)
+++ trunk/src/wp-includes/category-template.php 2015-06-29 14:15:59 UTC (rev 32996)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -808,26 +808,48 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $font_spread = 1;
</span><span class="cx" style="display: block; padding: 0 10px"> $font_step = $font_spread / $spread;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $a = array();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Assemble the data that will be used to generate the tag cloud markup.
+ $tags_data = array();
+ foreach ( $tags as $key => $tag ) {
+ $tag_id = isset( $tag->id ) ? $tag->id : $key;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( $tags as $key => $tag ) {
</del><span class="cx" style="display: block; padding: 0 10px"> $count = $counts[ $key ];
</span><span class="cx" style="display: block; padding: 0 10px"> $real_count = $real_counts[ $key ];
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $tag_link = '#' != $tag->link ? esc_url( $tag->link ) : '#';
- $tag_id = isset($tags[ $key ]->id) ? $tags[ $key ]->id : $key;
- $tag_name = $tags[ $key ]->name;
</del><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $translate_nooped_plural ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $title_attribute = sprintf( translate_nooped_plural( $translate_nooped_plural, $real_count ), number_format_i18n( $real_count ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $title = sprintf( translate_nooped_plural( $translate_nooped_plural, $real_count ), number_format_i18n( $real_count ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $title_attribute = call_user_func( $args['topic_count_text_callback'], $real_count, $tag, $args );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $title = call_user_func( $args['topic_count_text_callback'], $real_count, $tag, $args );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $a[] = "<a href='$tag_link' class='tag-link-$tag_id' title='" . esc_attr( $title_attribute ) . "' style='font-size: " .
- str_replace( ',', '.', ( $args['smallest'] + ( ( $count - $min_count ) * $font_step ) ) )
- . $args['unit'] . ";'>$tag_name</a>";
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $tags_data[] = array(
+ 'id' => $tag_id,
+ 'url' => '#' != $tag->link ? $tag->link : '#',
+ 'name' => $tag->name,
+ 'title' => $title,
+ 'slug' => $tag->slug,
+ 'real_count' => $real_count,
+ 'class' => 'tag-link-' . $tag_id,
+ 'font_size' => $args['smallest'] + ( $count - $min_count ) * $font_step,
+ );
</ins><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">+ /**
+ * Filter the data used to generate the tag cloud.
+ *
+ * @since 4.3.0
+ *
+ * @param array $tags_data An array of term data for term used to generate the tag cloud.
+ */
+ $tags_data = apply_filters( 'wp_generate_tag_cloud_data', $tags_data );
+
+ $a = array();
+
+ // generate the output links array
+ foreach ( $tags_data as $key => $tag_data ) {
+ $a[] = "<a href='" . esc_url( $tag_data['url'] ) . "' class='" . esc_attr( $tag_data['class'] ) . "' title='" . esc_attr( $tag_data['title'] ) . "' style='font-size: " . esc_attr( str_replace( ',', '.', $tag_data['font_size'] ) . $args['unit'] ) . ";'>" . esc_html( $tag_data['name'] ) . "</a>";
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> switch ( $args['format'] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> case 'array' :
</span><span class="cx" style="display: block; padding: 0 10px"> $return =& $a;
</span></span></pre></div>
<a id="trunktestsphpunitteststermwpGenerateTagCloudphp"></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/term/wpGenerateTagCloud.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/term/wpGenerateTagCloud.php 2015-06-29 13:18:48 UTC (rev 32995)
+++ trunk/tests/phpunit/tests/term/wpGenerateTagCloud.php 2015-06-29 14:15:59 UTC (rev 32996)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -164,8 +164,53 @@
</span><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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_topic_count_text() {
+ register_taxonomy( 'wptests_tax', 'post' );
+ $terms = $this->factory->term->create_many( 2, array( 'taxonomy' => 'wptests_tax' ) );
+ $posts = $this->factory->post->create_many( 2 );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_set_post_terms( $posts[0], $terms, 'wptests_tax' );
+ wp_set_post_terms( $posts[1], array( $terms[1] ), 'wptests_tax' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $term_objects = $this->retrieve_terms( array(
+ 'include' => $terms,
+ ), 'wptests_tax' );
+
+ $actual = wp_generate_tag_cloud( $term_objects, array(
+ 'format' => 'array',
+ 'topic_count_text' => array(
+ 'singular' => 'Term has %s post',
+ 'plural' => 'Term has %s posts',
+ 'domain' => 'foo',
+ 'context' => 'bar',
+ ),
+ ) );
+
+ $this->assertContains( "title='Term has 1 post'", $actual[0] );
+ $this->assertContains( "title='Term has 2 posts'", $actual[1] );
+ }
+
+ public function test_topic_count_text_callback() {
+ register_taxonomy( 'wptests_tax', 'post' );
+ $terms = $this->factory->term->create_many( 2, array( 'taxonomy' => 'wptests_tax' ) );
+ $posts = $this->factory->post->create_many( 2 );
+
+ wp_set_post_terms( $posts[0], $terms, 'wptests_tax' );
+ wp_set_post_terms( $posts[1], array( $terms[1] ), 'wptests_tax' );
+
+ $term_objects = $this->retrieve_terms( array(
+ 'include' => $terms,
+ ), 'wptests_tax' );
+
+ $actual = wp_generate_tag_cloud( $term_objects, array(
+ 'format' => 'array',
+ 'topic_count_text_callback' => array( $this, 'topic_count_text_callback' ),
+ ) );
+
+ $this->assertContains( "title='1 foo'", $actual[0] );
+ $this->assertContains( "title='2 foo'", $actual[1] );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Helper method retrieve the created terms.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -175,10 +220,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- protected function retrieve_terms( $get_terms_args ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ protected function retrieve_terms( $get_terms_args, $taxonomy = 'post_tag' ) {
+ $terms = get_terms( array( $taxonomy ), $get_terms_args );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $terms = get_terms( array( 'post_tag' ), $get_terms_args );
-
</del><span class="cx" style="display: block; padding: 0 10px"> $tags = array();
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $terms as $term ) {
</span><span class="cx" style="display: block; padding: 0 10px"> //add the link
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -189,4 +233,8 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $tags;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ public function topic_count_text_callback( $real_count, $tag, $args ) {
+ return sprintf( '%s foo', $real_count );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>