<!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>[32553] trunk: Introduced `$field` argument to `get_term_link()`.</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/32553">32553</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/32553","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-05-23 18:28:22 +0000 (Sat, 23 May 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'>Introduced `$field` argument to `get_term_link()`.
This new argument allows developers to specify which term field should be
matched by the value of the `$term` parameter (in particular, 'name' and
'term_taxonomy_id' are now supported).
Props sudar, mordauk.
Fixes <a href="https://core.trac.wordpress.org/ticket/14156">#14156</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludestaxonomyphp">trunk/src/wp-includes/taxonomy.php</a></li>
<li><a href="#trunktestsphpunitteststermgetTermLinkphp">trunk/tests/phpunit/tests/term/getTermLink.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludestaxonomyphp"></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.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/taxonomy.php 2015-05-23 18:12:27 UTC (rev 32552)
+++ trunk/src/wp-includes/taxonomy.php 2015-05-23 18:28:22 UTC (rev 32553)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4381,20 +4381,25 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Generate a permalink for a taxonomy term archive.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.5.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.3.0 Introduced `$field` argument.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param object|int|string $term The term object, ID, or slug whose link will be retrieved.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $taxonomy Optional. Taxonomy. Default empty.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $field Optional. The term field that should be matched by the `$term` argument. Accepts
+ * any `$field` values accepted by `get_term_by()`: 'slug', 'name',
+ * 'term_taxonomy_id', or 'id'. Default is 'slug', unless `$term` is an integer, in
+ * which case it's asssumed to be an ID.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string|WP_Error HTML link to taxonomy term archive on success, WP_Error if term does not exist.
</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_link( $term, $taxonomy = '' ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function get_term_link( $term, $taxonomy = '', $field = null ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> global $wp_rewrite;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( !is_object($term) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( is_int($term) ) {
- $term = get_term($term, $taxonomy);
- } else {
- $term = get_term_by('slug', $term, $taxonomy);
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( is_null( $field ) ) {
+ $field = is_int( $term ) ? 'id' : 'slug';
</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 = get_term_by( $field, $term, $taxonomy );
</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"> if ( !is_object($term) )
</span></span></pre></div>
<a id="trunktestsphpunitteststermgetTermLinkphp"></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/getTermLink.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/term/getTermLink.php 2015-05-23 18:12:27 UTC (rev 32552)
+++ trunk/tests/phpunit/tests/term/getTermLink.php 2015-05-23 18:28:22 UTC (rev 32553)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -54,6 +54,53 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $term = (string) $t1;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $actual = get_term_link( $term, 'wptests_tax', 'id' );
+ $this->assertContains( 'wptests_tax=foo', $actual );
+ }
+
+ /**
+ * @ticket 14156
+ */
+ public function test_should_match_field_by_name() {
+ $t = $this->factory->term->create( array(
+ 'taxonomy' => 'wptests_tax',
+ 'slug' => 'foo',
+ 'name' => 'Bar Term',
+ ) );
+
+ $actual = get_term_link( 'Bar Term', 'wptests_tax', 'name' );
+ $this->assertContains( 'wptests_tax=foo', $actual );
+ }
+
+ /**
+ * @ticket 14156
+ */
+ public function test_should_match_field_by_tt_id() {
+ $t = $this->factory->term->create( array(
+ 'taxonomy' => 'wptests_tax',
+ 'slug' => 'foo',
+ 'name' => 'Bar Term',
+ ) );
+
+ $actual = get_term_link( 'Bar Term', 'wptests_tax', 'name' );
+ $this->assertContains( 'wptests_tax=foo', $actual );
+ }
+
+ /**
+ * @ticket 14156
+ */
+ public function test_numeric_string_should_be_interpreted_as_term_id_if_id_field_is_specified() {
+ $t1 = $this->factory->term->create( array(
+ 'taxonomy' => 'wptests_tax',
+ 'name' => 'foo',
+ ) );
+ $t2 = $this->factory->term->create( array(
+ 'taxonomy' => 'wptests_tax',
+ 'slug' => $t1,
+ ) );
+
+ $term = (string) $t1;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $actual = get_term_link( $term, 'wptests_tax' );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertContains( 'wptests_tax=' . $term, $actual );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>