<!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>[27206] trunk/src/wp-includes/query.php: Inline documentation for various SQL clause hooks in wp-includes/query.php.</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">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/27206">27206</a></dd>
<dt>Author</dt> <dd>DrewAPicture</dd>
<dt>Date</dt> <dd>2014-02-20 17:33:16 +0000 (Thu, 20 Feb 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Inline documentation for various SQL clause hooks in wp-includes/query.php.
Covers documentation for general SQL clause hooks, including:
* `posts_where`
* `posts_join`
* `posts_where_paged`
* `posts_groupby`
* `posts_join_paged`
* `posts_orderby`
* `posts_distinct`
* `post_limits`
* `posts_fields`
* `posts_clauses`
Props dougwollison, DrewAPicture.
See <a href="http://core.trac.wordpress.org/ticket/25514">#25514</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesqueryphp">trunk/src/wp-includes/query.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesqueryphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/query.php (27205 => 27206)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/query.php 2014-02-20 16:41:50 UTC (rev 27205)
+++ trunk/src/wp-includes/query.php 2014-02-20 17:33:16 UTC (rev 27206)
</span><span class="lines">@@ -2759,7 +2759,7 @@
</span><span class="cx"> $where_status = implode( ' OR ', $statuswheres );
</span><span class="cx"> if ( ! empty( $where_status ) ) {
</span><span class="cx"> $where .= " AND ($where_status)";
</span><del>- }
</del><ins>+ }
</ins><span class="cx"> } elseif ( !$this->is_singular ) {
</span><span class="cx"> $where .= " AND ($wpdb->posts.post_status = 'publish'";
</span><span class="cx">
</span><span class="lines">@@ -2794,11 +2794,30 @@
</span><span class="cx"> $where .= $clauses['where'];
</span><span class="cx"> }
</span><span class="cx">
</span><del>- // Apply filters on where and join prior to paging so that any
- // manipulations to them are reflected in the paging by day queries.
</del><ins>+ /*
+ * Apply filters on where and join prior to paging so that any
+ * manipulations to them are reflected in the paging by day queries.
+ */
</ins><span class="cx"> if ( !$q['suppress_filters'] ) {
</span><del>- $where = apply_filters_ref_array('posts_where', array( $where, &$this ) );
- $join = apply_filters_ref_array('posts_join', array( $join, &$this ) );
</del><ins>+ /**
+ * Filter the WHERE clause of the query.
+ *
+ * @since 1.5.0
+ *
+ * @param string $where The WHERE clause of the query.
+ * @param WP_Query &$this The WP_Query instance (passed by reference).
+ */
+ $where = apply_filters_ref_array( 'posts_where', array( $where, &$this ) );
+
+ /**
+ * Filter the JOIN clause of the query.
+ *
+ * @since 1.5.0
+ *
+ * @param string $where The JOIN clause of the query.
+ * @param WP_Query &$this The WP_Query instance (passed by reference).
+ */
+ $join = apply_filters_ref_array( 'posts_join', array( $join, &$this ) );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> // Paging
</span><span class="lines">@@ -2856,21 +2875,101 @@
</span><span class="cx">
</span><span class="cx"> $pieces = array( 'where', 'groupby', 'join', 'orderby', 'distinct', 'fields', 'limits' );
</span><span class="cx">
</span><del>- // Apply post-paging filters on where and join. Only plugins that
- // manipulate paging queries should use these hooks.
</del><ins>+ /*
+ * Apply post-paging filters on where and join. Only plugins that
+ * manipulate paging queries should use these hooks.
+ */
</ins><span class="cx"> if ( !$q['suppress_filters'] ) {
</span><ins>+ /**
+ * Filter the WHERE clause of the query.
+ *
+ * Specifically for manipulating paging queries.
+ *
+ * @since 1.5.0
+ *
+ * @param string $where The WHERE clause of the query.
+ * @param WP_Query &$this The WP_Query instance (passed by reference).
+ */
</ins><span class="cx"> $where = apply_filters_ref_array( 'posts_where_paged', array( $where, &$this ) );
</span><ins>+
+ /**
+ * Filter the GROUP BY clause of the query.
+ *
+ * @since 2.0.0
+ *
+ * @param string $groupby The GROUP BY clause of the query.
+ * @param WP_Query &$this The WP_Query instance (passed by reference).
+ */
</ins><span class="cx"> $groupby = apply_filters_ref_array( 'posts_groupby', array( $groupby, &$this ) );
</span><ins>+
+ /**
+ * Filter the JOIN clause of the query.
+ *
+ * Specifically for manipulating paging queries.
+ *
+ * @since 1.5.0
+ *
+ * @param string $join The JOIN clause of the query.
+ * @param WP_Query &$this The WP_Query instance (passed by reference).
+ */
</ins><span class="cx"> $join = apply_filters_ref_array( 'posts_join_paged', array( $join, &$this ) );
</span><ins>+
+ /**
+ * Filter the ORDER BY clause of the query.
+ *
+ * @since 1.5.1
+ *
+ * @param string $orderby The ORDER BY clause of the query.
+ * @param WP_Query &$this The WP_Query instance (passed by reference).
+ */
</ins><span class="cx"> $orderby = apply_filters_ref_array( 'posts_orderby', array( $orderby, &$this ) );
</span><ins>+
+ /**
+ * Filter the DISTINCT clause of the query.
+ *
+ * @since 2.1.0
+ *
+ * @param string $distinct The DISTINCT clause of the query.
+ * @param WP_Query &$this The WP_Query instance (passed by reference).
+ */
</ins><span class="cx"> $distinct = apply_filters_ref_array( 'posts_distinct', array( $distinct, &$this ) );
</span><ins>+
+ /**
+ * Filter the LIMIT clause of the query.
+ *
+ * @since 2.1.0
+ *
+ * @param string $limits The LIMIT clause of the query.
+ * @param WP_Query &$this The WP_Query instance (passed by reference).
+ */
</ins><span class="cx"> $limits = apply_filters_ref_array( 'post_limits', array( $limits, &$this ) );
</span><ins>+
+ /**
+ * Filter the SELECT clause of the query.
+ *
+ * @since 2.1.0
+ *
+ * @param string $fields The SELECT clause of the query.
+ * @param WP_Query &$this The WP_Query instance (passed by reference).
+ */
</ins><span class="cx"> $fields = apply_filters_ref_array( 'posts_fields', array( $fields, &$this ) );
</span><span class="cx">
</span><del>- // Filter all clauses at once, for convenience
</del><ins>+ /**
+ * Filter all query clauses at once, for convenience.
+ *
+ * Covers the WHERE, GROUP BY, JOIN, ORDER BY, DISTINCT,
+ * fields (SELECT), and LIMITS clauses.
+ *
+ * @since 3.1.0
+ *
+ * @param array $clauses The list of clauses for the query.
+ * @param WP_Query &$this The WP_Query instance (passed by reference).
+ */
</ins><span class="cx"> $clauses = (array) apply_filters_ref_array( 'posts_clauses', array( compact( $pieces ), &$this ) );
</span><del>- foreach ( $pieces as $piece )
</del><ins>+
+ foreach ( $pieces as $piece ) {
</ins><span class="cx"> $$piece = isset( $clauses[ $piece ] ) ? $clauses[ $piece ] : '';
</span><ins>+ }
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> // Announce current selection parameters. For use by caching plugins.
</span></span></pre>
</div>
</div>
</body>
</html>