WP_Query関数のno_found_rowsパラメータ

WordPress Posted Display version 2.0.1をリリースしました。
今回の更新は軽微な不具合修正を行いました。その中で修正を加えたWP_Query()に関する処理をあらためて見直したのでまとめておきます。

WP_Query関数

投稿やページのリクエストに対して様々な条件を設定してデータを取得できる関数としておなじみですが、たくさんの条件が設定できるがために知らなかった仕組みがあったので、その改修（チェーニング）を行いました。
WordPress Posted Displayでは、ウィジェットやショートコードで投稿などを出力する際に以下のようなコードを書いています。

$args = array(
	"post_status"         => "publish",
	"no_found_rows"       => true,
	"posts_per_page"      => esc_html( $instance['posts'] ),
	"ignore_sticky_posts" => true
);
$query = new WP_Query( $args );

実際は$argsにさらに、表示するタイプごとにpost__inやcategory__inなどが追加されるのですが、基本のパラメータは上記コード内の配列の値4つです。今回のバージョンアップで'no_found_rows' => true（デフォルトはfalse）を追加しました。

no_found_rows

このパラメータのデフォルト値falseで行われる動作としては、実行するSQLクエリにSQL_CALC_FOUND_ROWSオプションを設定するようになります。これ知らなかった……。まずはこのSQLクエリを理解することからはじめました。

SELECT SQL_CALC_FOUND_ROWS * FROM wp_posts;
SELECT FOUND_ROWS();

何のための処理？

どうやらページ分割を前提にしているようです。全体で何記事あって1画面に何記事ずつ表示するか？という処理を行えるようにするためにあるパラメータのようで、ページングを行う必要がなければ動作させる必要がない＝無駄な処理が減らせるということになるかなと思います。実際にWP_Queryクラスでどのような実装がされているか探ってみました。

WP_Queryクラス内での実装

WP_Queryクラス内に以下のコードが書いてあります。

// If true, forcibly turns off SQL_CALC_FOUND_ROWS even when limits are present.
if ( isset($q['no_found_rows']) )
    $q['no_found_rows'] = (bool) $q['no_found_rows'];
else
    $q['no_found_rows'] = false;

isset()で値がセットされていれば、bool型にキャストしています。"no_found_rows" => 1という設定を見かけます。個人的には最初からtrueをセットすればいいのになと思ったり。
この判定でtrue/falseがセットされます。その判定をもって、SQLクエリを作成しています。以下、WP_Queryクラス内の抜粋です。

if ( !$q['no_found_rows'] && !empty($limits) )
    $found_rows = 'SQL_CALC_FOUND_ROWS';

$this->request = $old_request = "SELECT $found_rows $distinct $fields FROM {$wpdb->posts} $join WHERE 1=1 $where $groupby $orderby $limits";

上記の条件を見ての通り、no_found_rows => falseでかつ、$limitが空でない場合にSQL_CALC_FOUND_ROWSオプションがセットされます。
ここでの$limitの値は、WP_Queryの引数として渡す配列パラメータのposts_per_pageの値がセットされます。この値に「-1」（全件取得）がセットされている場合は、$limitの値はセットされません。何もセットしていない場合は、管理画面の「表示設定」の「1ページに表示する最大投稿数」の数が初期値になります。

if ( $q['no_found_rows'] || ( is_array( $this->posts ) && ! $this->posts ) )
    return;

if ( ! empty( $limits ) ) {
    $this->found_posts = $wpdb->get_var( apply_filters_ref_array( 'found_posts_query', array( 'SELECT FOUND_ROWS()', &$this ) ) );
} else {
    $this->found_posts = count( $this->posts );
}

そして最後にFOUND_ROWS()関数の実装コードです。no_found_rows => trueであればreturn; で返します。しかし、no_found_rows => falseであれば、$limitが空でない場合にSELECTステートメントが実行されてしまうので、SQLが最初の投稿データ取得とあわせると2回動作することになります。これは削りたい。

まとめ

最後にまとめ。no_found_rows => trueをセットする場面は、ページングが必要ない実装でWP_Query関数を実行する場合であるということ。SELECTステートメントの実行回数を減らすことができる。

• WordPress Posted Display
• Author : Kazuya Takami
• Version : 2.5.0
• Downloads : 6,263 ( Active Install: 100 )
• Downloads Site: https://wordpress.org/plugins/wp-posted-display
• プラグイン掲示ウィジェット& ショートコード追加。ブラウザの表示履歴を Cookie に保存して表示することもできます。