[WordPress]ユーザ一覧の表示制御

Question

Wordpressのユーザ一覧を表示する際に、
ユーザ名で制限をかけたユーザ一覧を表示させたいと思っています。

①ユーザ一覧表示時にユーザIDが「ABC_」で始まるもののみ表示する(フィルタリングする)
ようなプラグインを作成する際にどのような処理を記述すればいいのでしょうか。

アドバイス頂けたら幸いです。

Comments

[kei344]

今回＆前回の質問について、まだ質問が「受付中」になっていますが、どのように解決したのかを回答文に書き、「解決済」にされてはいかがでしょうか。

[yu2525]

申し訳ありません。不慣れでして。。。
そのように対応します。
ありがとうございます。

Answer 1

以下の様な対応で解決しました。

function filter_users_list_table_query_args($args) {

    //権限などの確認処理
    $args['search'] = "ABC_*";
    $args['search_columns'] = array('user_login');
    return $args;
}
add_filter( 'users_list_table_query_args', 'filter_users_list_table_query_args', 10, 1 );

Answer 2

「ユーザ一覧表示」が管理画面かそうでないかはわかりませんが、多分こういう感じで実装。

function my_pre_user_query( $q ) {
	if ( is_admin() || ! $query->is_main_query() ){ return; } // 管理画面及びメインクエリ以外（ ≒ autherアーカイブ）を除外（したい実装による）
	
	// ここで閲覧中ユーザーのロールやらなんやらで処理するかを判断
	
	$q->set( 'search', 'ABC_*' );
	$q->set( 'search_columns', array( 'user_login' ) ); // login かも
} // 未テスト
add_action( 'pre_user_query', my_pre_user_query );

【pre_user_query | Hook | WordPress Developer Resources】
https://developer.wordpress.org/reference/hooks/pre_user_query/

【WP_User_Query | Class | WordPress Developer Resources】
https://developer.wordpress.org/reference/classes/wp_user_query/

【WP_User_Query::prepare_query() | Method | WordPress Developer Resources】
https://developer.wordpress.org/reference/classes/wp_user_query/prepare_query/

---

以下 WP_User_Query を使う例。

【WordPressでWP_User_Queryを使ってuser検索する - Daily GLOCALISM】
http://daily.glocalism.jp/memo/using-wp_user_query-extensively/

【users - How to use search_columns in WP_User_Query? - WordPress Development Stack Exchange】
http://wordpress.stackexchange.com/questions/69543/how-to-use-search-columns-in-wp-user-query

【How can I search for a worpress user by display name or a part of it? - WordPress Development Stack Exchange】
http://wordpress.stackexchange.com/questions/105168/how-can-i-search-for-a-worpress-user-by-display-name-or-a-part-of-it

Comments

[yu2525]

ご回答いただきありがとうございます。
とてもわかりやすいです。

今回は管理画面でのユーザ一覧表示時に、ある特定の権限グループに属している場合、フィルタリングをかけたいと考えています。

ご教示いただいた内容を試してみたのですが、うまく行かず・・・
「if ( is_admin() || ! $query->is_main_query() ){ return; } // 管理画面及びメインクエリ以外（ ≒ autherアーカイブ）を除外（したい実装による）」は除外しました。

また、他に「users_list_table_query_args」というものを見つけました。
---------------------------------------------------
function filter_users_list_table_query_args($args) {

//権限処理など

$args['search'] = '123*';
$args['search_columns'] = array('user_login');

return $args;
}
add_filter( 'users_list_table_query_args', 'filter_users_list_table_query_args', 10, 1 );
---------------------------------------------------

一応フィルタリング？はできたようでしたが、今回実施したいプラグインとして、これを利用するのは相応しいのでしょうか。
申し訳ありませんが、アドバイス頂けるとありがたいです。

[kei344]

管理画面内であれば、下記のほうが問題が出にくいです。is_main_queryに絞らないと、ユーザーを呼び出す全ての動作に影響が出る恐れがあります。（動作をすべて確認して問題なければ別にis_main_queryでも良い）
if ( !is_admin() || ! $query->is_main_query() ){ return; }

> 今回実施したいプラグインとして、これを利用するのは相応しいのでしょうか。

あなたがどういう目的で処理を行いたいのかが私にはわかりませんし、それがふさわしいかの判断が出来る十分な情報を持っているわけではありません。何をアドバイスして欲しいと言うのでしょうか？

[yu2525]

変な質問になっていました。。。申し訳ありません。
「users_list_table_query_args」のところは無視でお願いします。

以下の教えていただいたコードではフィルタリングができなかったため、再度質問させていただきました。
-----------------------------------
function my_pre_user_query( $q ) {
if (! is_admin() || ! $query->is_main_query() ){ return; } // 管理画面及びメインクエリ以外（ ≒ autherアーカイブ）を除外（したい実装による）

// ここで閲覧中ユーザーのロールやらなんやらで処理するかを判断

$q->set( 'search', 'ABC_*' );
$q->set( 'search_columns', array( 'user_login' ) ); // login かも
} // 未テスト
add_action( 'pre_user_query', my_pre_user_query );
-----------------------------------

[kei344]

> 「users_list_table_query_args」のところは無視でお願いします。
私のコードは未テストです。なので、動くコードを使われたほうが良いと思いますよ。

users_list_table_query_args を調べてみましたが、わざわざis_adminを確認しなくても、管理画面以外で呼び出すことが内容なので、私の書いた内容は無視してください。

[yu2525]

動くコードで動作確認をして利用したいと思います。

今回もご丁寧にご回答いただきありがとうございました。
大変助かりました。