“is_main_query()”は$wp_queryのメソッドなのか？

Question

Wordpressの記事内検索で固定ページを排除する実装方法を検索している際に、以のコードを見つけました。

$wp_query->is_main_query()

is_main_query()は$wp_queryのメソッドであるということが読み取れるのですが、
$wp_queryをvar_dumpでデバッグしたところ、is_main_query()は存在しませんでした(is_search()等は存在しました。)

上記の内容を踏まえ、質問なのですが、どうして$wp_query->is_main_query() という記述ができるのでしょうか。

function my_posts_search( $search, $wp_query ){

 if ( $wp_query->is_search() && $wp_query->is_main_query() && !is_admin() ){

   $search .= " AND post_type = 'post' ";

   return $search;

 }

 return $search;

}

$wp_queryをデバッグした中身(is_main_query()は存在しませんでした)

 ["is_single"]=>bool(false)
 ["is_preview"]=>bool(false)
 ["is_page"]=>bool(false)
  .
  .
  .
 ["is_posts_page"]=>bool(false)
 ["is_post_type_archive"]=>bool(false)

Answer 1

メソッドはvar_dump()では確認できません。
var_dump()で確認できるのはその変数が保持している「データ」だけです。

<?php
class hoge{
    private $c1;
    public $c2;
    protected $c3;
    static $c4;

    private function m1(){}
    public function m2(){}
    protected function m3(){}
    static function m4(){}

}

$c = new hoge();
var_dump($c);

/**
object(hoge)#1 (3) {
  ["c1":"hoge":private]=>
  NULL
  ["c2"]=>
  NULL
  ["c3":protected]=>
  NULL
}
**/

get_class_methods()なりmethod_exists()なりで確認してください。

あとはドキュメントで仕様を確認することでしょうか。

関数リファレンス/is_main_query

この関数は WP_Query::is_main_query() メソッドのエイリアスです。例えば pre_get_posts のような、WP_Query オブジェクトを引き渡すフィルターまたはアクションフックのコールバック内でこの関数を呼び出すのは、回りくどくなります。代わりに、渡されたオブジェクトのメソッドを直接呼び出しましょう。例えば、フィルターコールバックが受け取った WP_Query オブジェクトを $query に割り当てていた場合には、以下のような方法でメソッドを呼び出します。

ということで、WP_Queryオブジェクトに存在しているであろうことが分かります。

Comments

[kazu25]

var_dump()での確認には限界があるんですね。ありがとうございます

[m.ts10806]

いえ、「仕様」の話です。
メソッドは実行しないと結果が分からないものです。
プロパティは実行しなくても保持しているデータは参照できます。
だからvar_dump()から確認できるのです。

PHPマニュアルを確認してください。
https://www.php.net/manual/ja/function.var-dump.php
> この関数は、指定した式に関してその型や値を含む構造化された情報を 返します。配列の場合、その構造を表示するために各値について再帰的に 探索されます。
オブジェクトのすべての public、private および protected な"""プロパティが"""出力されます。ただし、そのオブジェクトが __debugInfo() メソッド (PHP 5.6.0 で追加されました) を実装している場合は、その限りではありません。

私が提示したサンプルコードでstaticになったプロパティが出力されていないのも仕様です。

Answer 2

“is_main_query()”は$wp_queryのメソッドなのか？

そうです。ちなみに同名の関数もあります。（しいて使う必要はないけど）
WordPressのクラス/関数群は構成ファイルから直接記述を探すことをお勧めします。（経験として、そのほうが早いことが多いです）

【class-wp-query.php in tags/5.3/src/wp-includes – WordPress Trac】
https://core.trac.wordpress.org/browser/tags/5.3/src/wp-includes/class-wp-query.php#L18

Comments

[kei344]

他の回答を見るに、「$wp_queryのメソッド」は厳密にはちがうか。

[kazu25]

構成ファイルから直接記述を探すというのは今後かなり役立ちそうです。良いアドバイスありがとうございます。

Answer 3

いえ、is_main_query()はWP_Queryのメソッドです。
関数リファレンス/is main query

["is_page"]=>bool(false)はプロパティです。

以下がtrueになるのを確認してみて下さい。

global $wp_query;
var_dump( method_exists($wp_query, 'is_main_query') );

Comments

[kazu25]

method_exists()で確認できるんですね。ありがとうございます。