<!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>[31271] trunk: Add classes for custom taxonomy terms in `get_post_class()`.</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/31271">31271</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/31271","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-01-23 15:40:31 +0000 (Fri, 23 Jan 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 classes for custom taxonomy terms in `get_post_class()`.
Props sillybean.
Fixes <a href="https://core.trac.wordpress.org/ticket/16223">#16223</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesposttemplatephp">trunk/src/wp-includes/post-template.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestspostgetPostClassphp">trunk/tests/phpunit/tests/post/getPostClass.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesposttemplatephp"></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/post-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/post-template.php 2015-01-23 14:56:04 UTC (rev 31270)
+++ trunk/src/wp-includes/post-template.php 2015-01-23 15:40:31 UTC (rev 31271)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -389,14 +389,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * The class names are many. If the post is a sticky, then the 'sticky'
</span><span class="cx" style="display: block; padding: 0 10px"> * class name. The class 'hentry' is always added to each post. If the post has a
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * post thumbnail, 'has-post-thumbnail' is added as a class. For each
- * category, the class will be added with 'category-' with category slug is
- * added. The tags are the same way as the categories with 'tag-' before the tag
- * slug. All classes are passed through the filter, 'post_class' with the list
- * of classes, followed by $class parameter value, with the post ID as the last
- * parameter.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * post thumbnail, 'has-post-thumbnail' is added as a class. For each taxonomy that
+ * the post belongs to, a class will be added of the format '{$taxonomy}-{$slug}' -
+ * eg 'category-foo' or 'my_custom_taxonomy-bar'. The 'post_tag' taxonomy is a special
+ * case; the class has the 'tag-' prefix instead of 'post_tag-'. All classes are
+ * passed through the filter, 'post_class' with the list of classes, followed by
+ * $class parameter value, with the post ID as the last parameter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.7.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.2.0 Custom taxonomy classes were added.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|array $class One or more classes to add to the class list.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int|WP_Post $post_id Optional. Post ID or post object.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -446,21 +447,22 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // hentry for hAtom compliance
</span><span class="cx" style="display: block; padding: 0 10px"> $classes[] = 'hentry';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Categories
- if ( is_object_in_taxonomy( $post->post_type, 'category' ) ) {
- foreach ( (array) get_the_category($post->ID) as $cat ) {
- if ( empty($cat->slug ) )
- continue;
- $classes[] = 'category-' . sanitize_html_class($cat->slug, $cat->term_id);
- }
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // All public taxonomies
+ $taxonomies = get_taxonomies( array( 'public' => true ) );
+ foreach ( (array) $taxonomies as $taxonomy ) {
+ if ( is_object_in_taxonomy( $post->post_type, $taxonomy ) ) {
+ foreach ( (array) get_the_terms( $post->ID, $taxonomy ) as $term ) {
+ if ( empty( $term->slug ) ) {
+ continue;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Tags
- if ( is_object_in_taxonomy( $post->post_type, 'post_tag' ) ) {
- foreach ( (array) get_the_tags($post->ID) as $tag ) {
- if ( empty($tag->slug ) )
- continue;
- $classes[] = 'tag-' . sanitize_html_class($tag->slug, $tag->term_id);
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // 'post_tag' uses the 'tag' prefix for backward compatibility.
+ if ( 'post_tag' == $taxonomy ) {
+ $classes[] = 'tag-' . sanitize_html_class( $term->slug, $term->term_id );
+ } else {
+ $classes[] = sanitize_html_class( $taxonomy . '-' . $term->slug, $taxonomy . '-' . $term->term_id );
+ }
+ }
</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="trunktestsphpunittestspostgetPostClassphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/post/getPostClass.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/post/getPostClass.php (rev 0)
+++ trunk/tests/phpunit/tests/post/getPostClass.php 2015-01-23 15:40:31 UTC (rev 31271)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,67 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * @group post
+ * @covers ::get_post_class
+ */
+class Tests_Post_GetPostClass extends WP_UnitTestCase {
+ protected $post_id;
+
+ public function setUp() {
+ parent::setUp();
+ $this->post_id = $this->factory->post->create();
+ }
+
+ public function test_with_tags() {
+ wp_set_post_terms( $this->post_id, array( 'foo', 'bar' ), 'post_tag' );
+
+ $found = get_post_class( '', $this->post_id );
+
+ $this->assertContains( 'tag-foo', $found );
+ $this->assertContains( 'tag-bar', $found );
+ }
+
+ public function test_with_categories() {
+ $cats = $this->factory->category->create_many( 2 );
+ wp_set_post_terms( $this->post_id, $cats, 'category' );
+
+ $cat0 = get_term( $cats[0], 'category' );
+ $cat1 = get_term( $cats[1], 'category' );
+
+ $found = get_post_class( '', $this->post_id );
+
+ $this->assertContains( 'category-' . $cat0->slug, $found );
+ $this->assertContains( 'category-' . $cat1->slug, $found );
+ }
+
+ public function test_with_custom_taxonomy() {
+ register_taxonomy( 'wptests_tax', 'post' );
+ wp_set_post_terms( $this->post_id, array( 'foo', 'bar' ), 'wptests_tax' );
+
+ $found = get_post_class( '', $this->post_id );
+
+ $this->assertContains( 'wptests_tax-foo', $found );
+ $this->assertContains( 'wptests_tax-bar', $found );
+ }
+
+ /**
+ * @group cache
+ */
+ public function test_taxonomy_classes_hit_cache() {
+ global $wpdb;
+
+ register_taxonomy( 'wptests_tax', 'post' );
+ wp_set_post_terms( $this->post_id, array( 'foo', 'bar' ), 'wptests_tax' );
+ wp_set_post_terms( $this->post_id, array( 'footag', 'bartag' ), 'post_tag' );
+
+ // Prime cache, including meta cache, which is used by get_post_class().
+ update_object_term_cache( $this->post_id, 'post' );
+ update_meta_cache( 'post', $this->post_id );
+
+ $num_queries = $wpdb->num_queries;
+
+ $found = get_post_class( '', $this->post_id );
+
+ $this->assertSame( $num_queries, $wpdb->num_queries );
+ }
+}
</ins></span></pre>
</div>
</div>
</body>
</html>