<!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>[35028] trunk: Don't require a `$taxonomy` to be specified in `get_term_field()`.</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/35028">35028</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/35028","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-10-12 04:13:25 +0000 (Mon, 12 Oct 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'>Don't require a `$taxonomy` to be specified in `get_term_field()`.
After <a href="https://core.trac.wordpress.org/changeset/34997">[34997]</a>, the `$taxonomy` parameter of `get_term()` is optional. This
changeset brings `get_term_field()` in line with the new usage.
Adds unit tests for `get_term_field()`.
Props DrewAPicture.
See <a href="https://core.trac.wordpress.org/ticket/34245">#34245</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludestaxonomyfunctionsphp">trunk/src/wp-includes/taxonomy-functions.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunitteststermgetTermFieldphp">trunk/tests/phpunit/tests/term/getTermField.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludestaxonomyfunctionsphp"></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/taxonomy-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/taxonomy-functions.php 2015-10-12 03:38:11 UTC (rev 35027)
+++ trunk/src/wp-includes/taxonomy-functions.php 2015-10-12 04:13:25 UTC (rev 35028)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -920,20 +920,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Get sanitized Term field.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Does checks for $term, based on the $taxonomy. The function is for contextual
- * reasons and for simplicity of usage. See sanitize_term_field() for more
- * information.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The function is for contextual reasons and for simplicity of usage.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.3.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.4.0 The `$taxonomy` parameter was made optional. `$term` can also now accept a WP_Term object.
</ins><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 $field Term field to fetch.
- * @param int $term Term ID.
- * @param string $taxonomy Taxonomy Name.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @see sanitize_term_field()
+ *
+ * @param string $field Term field to fetch.
+ * @param int|WP_Term $term Term ID or object.
+ * @param string $taxonomy Optional. Taxonomy Name. Default empty.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $context Optional, default is display. Look at sanitize_term_field() for available options.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string|int|null|WP_Error Will return an empty string if $term is not an object or if $field is not set in $term.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function get_term_field( $field, $term, $taxonomy, $context = 'display' ) {
- $term = (int) $term;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function get_term_field( $field, $term, $taxonomy = '', $context = 'display' ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $term = get_term( $term, $taxonomy );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error($term) )
</span><span class="cx" style="display: block; padding: 0 10px"> return $term;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -944,7 +944,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( !isset($term->$field) )
</span><span class="cx" style="display: block; padding: 0 10px"> return '';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return sanitize_term_field($field, $term->$field, $term->term_id, $taxonomy, $context);
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return sanitize_term_field( $field, $term->$field, $term->term_id, $term->taxonomy, $context );
</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="trunktestsphpunitteststermgetTermFieldphp"></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/term/getTermField.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/term/getTermField.php (rev 0)
+++ trunk/tests/phpunit/tests/term/getTermField.php 2015-10-12 04:13:25 UTC (rev 35028)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,83 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * @group taxonomy
+ */
+class Tests_Term_getTermField extends WP_UnitTestCase {
+
+ public $taxonomy = 'wptests_tax';
+
+ function setUp() {
+ parent::setUp();
+
+ register_taxonomy( $this->taxonomy, 'post' );
+ }
+
+ /**
+ * @ticket 34245
+ */
+ public function test_get_term_field_should_not_return_error_for_empty_taxonomy() {
+ $term = $this->factory->term->create_and_get( array( 'taxonomy' => $this->taxonomy ) );
+
+ $found = get_term_field( 'taxonomy', $term->term_id, '' );
+ $this->assertNotWPError( $found );
+ $this->assertSame( $this->taxonomy, $found );
+ }
+
+ /**
+ * @ticket 34245
+ */
+ public function test_get_term_field_supplying_a_taxonomy() {
+ $term = $this->factory->term->create_and_get( array( 'taxonomy' => $this->taxonomy ) );
+
+ $found = get_term_field( 'taxonomy', $term->term_id, $term->taxonomy );
+ $this->assertSame( $this->taxonomy, $found );
+ }
+
+ /**
+ * @ticket 34245
+ */
+ public function test_get_term_field_supplying_no_taxonomy() {
+ $term = $this->factory->term->create_and_get( array( 'taxonomy' => $this->taxonomy ) );
+
+ $found = get_term_field( 'taxonomy', $term->term_id );
+ $this->assertSame( $this->taxonomy, $found );
+ }
+
+ /**
+ * @ticket 34245
+ */
+ public function test_get_term_field_should_accept_a_WP_Term_object_or_a_term_id() {
+ $term = $this->factory->term->create_and_get( array( 'taxonomy' => $this->taxonomy ) );
+
+ $this->assertInstanceOf( 'WP_Term', $term );
+ $this->assertSame( $term->term_id, get_term_field( 'term_id', $term ) );
+ $this->assertSame( $term->term_id, get_term_field( 'term_id', $term->term_id ) );
+ }
+
+ /**
+ * @ticket 34245
+ */
+ public function test_get_term_field_invalid_taxonomy_should_return_WP_Error() {
+ $term = $this->factory->term->create_and_get( array( 'taxonomy' => $this->taxonomy ) );
+
+ $found = get_term_field( 'taxonomy', $term, 'foo-taxonomy' );
+ $this->assertWPError( $found );
+ $this->assertSame( 'invalid_taxonomy', $found->get_error_code() );
+ }
+
+ /**
+ * @ticket 34245
+ */
+ public function test_get_term_field_invalid_term_should_return_WP_Error() {
+ $found = get_term_field( 'taxonomy', 0, $this->taxonomy );
+
+ $this->assertWPError( $found );
+ $this->assertSame( 'invalid_term', $found->get_error_code() );
+
+ $_found = get_term_field( 'taxonomy', 0 );
+
+ $this->assertWPError( $_found );
+ $this->assertSame( 'invalid_term', $_found->get_error_code() );
+ }
+}
</ins></span></pre>
</div>
</div>
</body>
</html>