クエリー

この章では2つの種類のクエリーについて説明します。ポストクエリー、タクソノミークエリー、コメントクエリー、ユーザークエリー、そして通常のSQLクエリーです。

ポストクエリー

メインループ

WordPressによって表示されるすべてのページにはメインクエリーがあります。このクエリーはデータベースから投稿を取得し、どのテンプレートが読み込まれるべきなのかを決定するのにも使われます。

テンプレートが読み込まれるとメインループが開始され、メインクエリーによって見つけられた投稿をテーマが表示します。

if ( have_posts() ) {
    while ( have_posts() ) {
        the_post();
        // display post
    }
} else {
    // no posts were found
}

メインクエリーとクエリー変数

メインクエリーはURLがを使って生成され、WP_Queryオブジェクトによって表示されます。

このオブジェクトはクエリー変数を使って何を取得するのかを命令されます。これらの変数は最初にクエリーオブジェクトに渡され、有効なクエリー変数の一部となります。

例えば、クエリー変数 ‘p’ は特定の投稿タイプを取得するのに次ように使われます:

$posts = get_posts( 'p=12' );

これはID12の投稿を取得します。完全なオプションの一覧はCodexのWP_Queryのエントリーで参照できます。

クエリー発行

データベースから投稿を取得するには投稿クエリーを作成する必要があります。投稿取得のすべてのメソッドはWP_Queryオブジェクトの上に層になっています。

これを行うには3つの方法があります:

• WP_Query
• get_posts
• query_posts

このダイアグラムは各メソッドで何が行われているのかを説明しています:

WP_Query

$query = new WP_Query( $arguments );

すべての投稿クエリーはWP_Queryオブジェクトのラッパーです。WP_Queryオブジェクトはクエリー(例えばメインクエリー)を表していて、次のような便利なメソッドを持っています:

$query->have_posts();
$query->the_post();

たいていのテーマにみられる関数のhave_posts();とthe_post();はメインクエリーオブジェクトのラッパーです:

function have_posts() {
    global $wp_query;
    return $wp_query->have_posts();
}

get_posts

$posts = get_posts( $arguments );

get_postsはWP_Queryと似ていて同じ引き数を取りますが、リクエストされた投稿のすべてを含んだ配列を返します。投稿ループの作成を意図していないのであればget_postsは使うべきはありません。

query_postsは使わない

query_postsは極端に単純化されていて、ページのメインクエリーを変更する方法としては、クエリーの新しいインスタンスでそれを置き換えるので問題のある方法です。

これは非効率(SQLクエリーを再度走らせます)で、特定の状況(特にページングを扱うときに)で完全に動作しなくなります。この用途ではpre_get_postsフックの利用など、モダンなWordPressのコードにはより信頼性のあるメソッドを使うべきです。query_posts()を使ってはいけません。

クエリー発行後の後始末

wp_reset_postdata

WP_Queryもしくはget_postsを使うとき、the_postもしくはsetup_postdataを使ってカレントの投稿オブジェクトをセットできます。これを行ったら、ループが終わった時点で後始末をする必要があります。wp_reset_postdataを呼び出すことでこれを行います。

wp_reset_query

query_postsを呼び出した時、その動作が終わったらメインクエリーを戻す必要があります。これはwp_reset_queryで行えます。

pre_get_posts フィルター

メインクエリーを変更して、そのページに何か別のものを表示させる必要がある場合にはpre_get_postsを使うといいでしょう。

アーカイブから投稿を取り除いたり、検索時の投稿タイプを変更したり、カテゴリーを除外したりなどなどのためにこれはよく利用されます。

以下は投稿のみを検索対象にするためのCodexに記載されているサンプルです:

function search_filter($query) {
    if ( !is_admin() && $query->is_main_query() ) {
        if ($query->is_search) {
            $query->set('post_type', 'post');
        }
    }
}
add_action( 'pre_get_posts', 'search_filter' );

このフィルターはテーマのfunctions.phpもしくはプラグイン内で使えます。

タクソノミークエリー

タクソノミー(投稿のカテゴリーやタグも含む)を扱うときは古いヘルパーAPIよりも包括的な以下の様なAPIに頼るほうが安全です:

• get_taxonomies
• get_terms
• get_term_by
• get_taxonomy
• wp_get_object_terms
• wp_set_object_terms

APIのひとセットを学ぶほうがより簡単ですし、カテゴリーとタグは単なるタクソノミーの一種として考え、get_categoryなどの古い関数の組み合わせとマッチングとは考えないほうがいいでしょう。

コメントクエリー

$args = array(
   // args here
);
// The Query
$comments_query = new WP_Comment_Query;
$comments = $comments_query->query( $args );
// Comment Loop
if ( $comments ) {
    foreach ( $comments as $comment ) {
        echo '<p>' . $comment->comment_content . '</p>';
    }
} else {
    echo 'No comments found.';
}

ユーザークエリー

$args = array(
    //
);
// The Query
$user_query = new WP_User_Query( $args );
// User Loop
if ( ! empty( $user_query->results ) ) {
    foreach ( $user_query->results as $user ) {
        echo '<p>' . $user->display_name . '</p>';
    }
} else {
    echo 'No users found.';
}

SQL

WPDB

よく知らない方は、投稿記事を取得するために生のSQLクエリーに頼ろうとする誘惑に駆られることでしょう。しかし、それは最後の手段です。

SQLクエリーを作る必要のある場合はWPDbオブジェクトを使いましょう。

dbDelta とテーブル作成

dbDelta関数は現行のテーブル構造を調べ、望ましいテーブル構造を比較し、必要に応じてテーブルを追加もしくは変更します。そのため、アップデートにはとても便利な時があります。

dbDelta関数は好き嫌いがあるかもしれません。例えば:

• 各フィールドはSQLステートメント内の各行に置く必要があります。
• PRIMARY KEYとプライマリーキーの定義の間には半角スペースを2つ入れる必要があります。
• 同義語のINDEXではなくキーワードのKEYを使う必要があり、最低でも一つのキーを含める必要があります。
• フィールド名の周りではアポストロフィとバッククォートは使えません。
• CREATE TABLEは大文字にする必要があります。

こうした注意事項を念頭に置いて、実際にテーブルを作成もしくは更新する関数を作ります。$sql変数内で独自のテーブル構造を置き換える必要がでてくるでしょう。

さらに詳しくは

• You don’t know query, a talk by Andrew Nacin
• When you should use WP_Query vs query_posts, Andrei Savchenko/Rarst
• Creating Tables With Plugins - Codex
• pre_get_posts - Codex