WP_List_Tableクラスの「一括操作」フォームを使ってみた

説明

今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」(Bulkアクション)フォーム対応に関するメモである。

「一括操作」フォームのプルダウンメニュー

「一括操作」フォームの対応はとてもシンプルで、get_bulk_actionsメソッドを定義し、その返り値に連想配列を指定するだけでよい。

class Gettext_Msg_List_Table extends WP_List_Table {

	:
	途中省略
	:

	/**
	 * 「一括操作」のプルダウンメニューを指定
	 *
	 * @return array
	 */
	protected function get_bulk_actions() {
		return array(
				'delete-selected' => __( 'Delete' )
				);
	}
}

上記の場合、実際に出力されるプルダウンメニューは次の内容となる。

<!-- 表の上部 -->
<select name="action" id="bulk-action-selector-top">
<option value="-1">一括操作</option>
<option value="delete-selected">削除</option>
</select>

<!-- 表の下部 -->
<select name="action2" id="bulk-action-selector-bottom">
<option value="-1">一括操作</option>
<option value="delete-selected">削除</option>
</select>

このようにselect要素のname属性とid属性は表示位置によって異なっており、get_bulk_actionsメソッドで指定した連想配列の内容がoption要素となっていることがわかる。

「適用」ボタンの後に何か追加する

プルダウンメニュー右横の「適用」ボタンの後に何らかの内容を出力したい場合はextra_tablenavメソッドを定義する。このメソッドには$whichパラメータがあり、表本体の上部の呼び出し時は'top'が、下部の呼び出し時には'bottom'が格納されてくるので、これによって出し分けできる。

	/**
	 * プルダウンメニューの後に出力する内容を指定
	 *
	 * @param string $which
	 */
	protected function extra_tablenav( $which ) {
?>
<div class="alignleft actions">
		if ( 'top' === $which ) {
			// 上部のプルダウンメニューの後に追加する内容を記述
		} else if ( 'bottom' === $which ) {
			// 下部のプルダウンメニューの後に追加する内容を記述
		}
</div>
<?php
		do_action( 'manage_msg_list_extra_tablenav', $which );
	}

「一括操作」フォームのサブミット

「一括操作」フォームのサブミット処理においてちょっと調べたのが、CSRF対策用のnonceパラメータで指定されたアクション名である。WP_List_Tableクラスのソースコード(/wp-admin/includes/class-wp-list-table.php)を見てみると、nonceパラメータの生成は次のように記述されている。

protected function display_tablenav( $which ) {
	if ( 'top' === $which ) {
		wp_nonce_field( 'bulk-' . $this->_args['plural'] );
	}

これによるとアクション名は'bulk-'.コンストラクタで指定する複数形時のデータ名ということがわかる。このことをもとにサブミット時の処理内容を記述すると、基本形は次のような感じになる。

$wp_list_table = new Gettext_Msg_List_Table();

// 途中省略

if ( isset( $_POST['checked'] ) && is_array( $_POST['checked'] ) ) {
	check_admin_referer( 'bulk-' . $wp_list_table->_args['plural'] );

	if ( 'delete-selected'  === $wp_list_table->current_action() ) {
		// ここに一括削除時の処理内容を記述
	}
}

チェックボックスがチェックされたデータ番号が格納されたcheckedパラメータの有無を確認し、check_admin_referer関数でnonceパラメータの妥当性を調べる。nonceパラメータが問題がなければ、プルダウンメニューの値をcurrent_actionメソッドで取得してそれに応じた処理を行う。current_actionメソッドを使用する理由は、プルダウンメニューが2箇所にあり、上部が'action'、下部が'action2'になっているためで、それらを個別に調べるよりもcurrent_actionメソッドを使う方が簡単だろう。


最終更新 : 2018年05月27日 10:43


お勧め

get_the_posts_navigation(2018年5月27日 更新)

string get_the_posts_navigation( [ array $args = array() ] )
アーカイブページ向けのナビゲーションを取得する。

is_child_theme(2011年9月28日 更新)

bool is_child_theme( )
現在のテーマが子テーマか調べる。

get_user_option(2012年9月16日 更新)

mixed get_user_option( string $option [ , int $user = 0 [ , mixed $deprecated = '' ] ] )
ユーザオプション(プロフィール)情報を取得する。

get_userdata(2018年5月27日 更新)

mixed get_userdata( int $user_id )
ユーザIDを指定し、マッチするユーザ情報を取得する。

wp_spam_comment(2013年9月6日 更新)

bool wp_spam_comment( $comment_id )
コメントをスパムにする。