<!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" /><style type="text/css"><!--
#msg dl { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer { 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 #fc0 solid; padding: 6px; }
#msg ul, pre { overflow: auto; }
#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>
<title>[16854] trunk/wp-includes: Inline docs for WP_Tax_Query.</title>
</head>
<body>
<div id="msg">
<dl>
<dt>Revision</dt> <dd><a href="http://trac.wordpress.org/changeset/16854">16854</a></dd>
<dt>Author</dt> <dd>scribu</dd>
<dt>Date</dt> <dd>2010-12-10 08:20:46 +0000 (Fri, 10 Dec 2010)</dd>
</dl>
<h3>Log Message</h3>
<pre>Inline docs for WP_Tax_Query. See <a href="http://trac.wordpress.org/ticket/15752">#15752</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpincludesqueryphp">trunk/wp-includes/query.php</a></li>
<li><a href="#trunkwpincludestaxonomyphp">trunk/wp-includes/taxonomy.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwpincludesqueryphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/query.php (16853 => 16854)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/query.php 2010-12-10 07:51:04 UTC (rev 16853)
+++ trunk/wp-includes/query.php 2010-12-10 08:20:46 UTC (rev 16854)
</span><span class="lines">@@ -1471,13 +1471,13 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /*
</span><del>- * Parses various taxonomy related query vars and sets the appropriate query flags
</del><ins>+ * Parses various taxonomy related query vars and sets the appropriate query flags.
</ins><span class="cx"> *
</span><span class="cx"> * @access protected
</span><span class="cx"> * @since 3.1.0
</span><span class="cx"> *
</span><span class="cx"> * @param array &$q The query variables
</span><del>- * @return array tax query
</del><ins>+ * @return WP_Tax_Query
</ins><span class="cx"> */
</span><span class="cx"> function parse_tax_query( &$q ) {
</span><span class="cx"> if ( ! empty( $q['tax_query'] ) && is_array( $q['tax_query'] ) ) {
</span></span></pre></div>
<a id="trunkwpincludestaxonomyphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/taxonomy.php (16853 => 16854)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/taxonomy.php 2010-12-10 07:51:04 UTC (rev 16853)
+++ trunk/wp-includes/taxonomy.php 2010-12-10 08:20:46 UTC (rev 16854)
</span><span class="lines">@@ -506,22 +506,13 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /*
</span><del>- * Given a taxonomy query, generates SQL to be appended to a main query
</del><ins>+ * Given a taxonomy query, generates SQL to be appended to a main query.
</ins><span class="cx"> *
</span><span class="cx"> * @since 3.1.0
</span><span class="cx"> *
</span><del>- * @param array $tax_query List of taxonomy queries. A single taxonomy query is an associative array:
- * - 'taxonomy' string The taxonomy being queried
- * - 'terms' string|array The list of terms
- * - 'field' string (optional) Which term field is being used.
- * Possible values: 'term_id', 'slug' or 'name'
- * Default: 'term_id'
- * - 'operator' string (optional)
- * Possible values: 'IN' and 'NOT IN'.
- * Default: 'IN'
- * - 'include_children' bool (optional) Whether to include child terms.
- * Default: true
</del><ins>+ * @see WP_Tax_Query
</ins><span class="cx"> *
</span><ins>+ * @param array $tax_query A compact tax query
</ins><span class="cx"> * @param string $primary_table
</span><span class="cx"> * @param string $primary_id_column
</span><span class="cx"> * @return array
</span><span class="lines">@@ -531,11 +522,67 @@
</span><span class="cx"> return $tax_query_obj->get_sql( $primary_table, $primary_id_column );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+/**
+ * Container class for a multiple taxonomy query.
+ *
+ * @since 3.1.0
+ */
</ins><span class="cx"> class WP_Tax_Query {
</span><del>- var $relation = '';
</del><ins>+
+ /**
+ * List of taxonomy queries. A single taxonomy query is an associative array:
+ * - 'taxonomy' string The taxonomy being queried
+ * - 'terms' string|array The list of terms
+ * - 'field' string (optional) Which term field is being used.
+ * Possible values: 'term_id', 'slug' or 'name'
+ * Default: 'term_id'
+ * - 'operator' string (optional)
+ * Possible values: 'IN' and 'NOT IN'.
+ * Default: 'IN'
+ * - 'include_children' bool (optional) Whether to include child terms.
+ * Default: true
+ *
+ * @since 3.1.0
+ * @access public
+ * @var array
+ */
</ins><span class="cx"> var $queries = array();
</span><span class="cx">
</span><del>- function WP_Tax_Query( &$tax_query ) {
</del><ins>+ /**
+ * The relation between the queries. Can be one of 'AND' or 'OR'.
+ *
+ * @since 3.1.0
+ * @access public
+ * @var string
+ */
+ var $relation;
+
+ /**
+ * PHP4 type constructor.
+ *
+ * Parses a compact tax query and sets defaults.
+ *
+ * @since 3.1.0
+ * @access public
+ *
+ * @param array $tax_query A compact tax query:
+ * array(
+ * 'relation' => 'OR',
+ * array(
+ * 'taxonomy' => 'tax1',
+ * 'terms' => array( 'term1', 'term2' ),
+ * 'field' => 'slug',
+ * ),
+ * array(
+ * 'taxonomy' => 'tax2',
+ * 'terms' => array( 'term-a', 'term-b' ),
+ * 'field' => 'slug',
+ * ),
+ * )
+ *
+ * @return WP_Tax_Query
+ */
+ function WP_Tax_Query( $tax_query ) {
</ins><span class="cx"> if ( isset( $tax_query['relation'] ) && strtoupper( $tax_query['relation'] ) == 'OR' ) {
</span><span class="cx"> $this->relation = 'OR';
</span><span class="cx"> } else {
</span><span class="lines">@@ -562,6 +609,16 @@
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Generates SQL clauses to be appended to a main query.
+ *
+ * @since 3.1.0
+ * @access public
+ *
+ * @param string $primary_table
+ * @param string $primary_id_column
+ * @return array
+ */
</ins><span class="cx"> function get_sql( $primary_table, $primary_id_column ) {
</span><span class="cx"> global $wpdb;
</span><span class="cx">
</span><span class="lines">@@ -640,6 +697,17 @@
</span><span class="cx"> return compact( 'join', 'where' );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Transforms a list of terms, from one field to another.
+ *
+ * @since 3.1.0
+ * @access private
+ *
+ * @param array &$terms The list of terms
+ * @param string $taxonomy The taxonomy of the terms
+ * @param string $field The initial field
+ * @param string $resulting_field The resulting field
+ */
</ins><span class="cx"> function _transform_terms( &$terms, $taxonomy, $field, $resulting_field ) {
</span><span class="cx"> global $wpdb;
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>