ショートコードを含んだページを表示する前に何か処理する

説明

固定ページまたは投稿ページに独自のフォームを埋め込む。入力→登録の2段階のフォームなら著名なプラグイン「Contact Form 7」を利用すればいいのだが、クライアントの依頼は入力→確認→登録の3段階で組み込む要素が特化していたので、独自の実装方法を考えることになった。

ショートコードによるフォームの実装で悩ましいのが、確認ページと登録ページでの処理のタイミング。特に確認ページにおいて入力ページから受け取ったパラメータのチェックし、必須項目が未入力だった場合に登録ページに戻すといった処理を実装することである。テーマ内のテンプレートファイルなどで行えば簡単なのだが、テンプレートファイルが煩雑になるのは避けたい。

というわけで思いいたったのが、template_redirectアクションを利用する方法である。このtemplate_redirectアクションは、リクエストパラメータに応じた投稿情報の取得後、現在のテーマで適切なテンプレートファイルを捜してロードする前に呼び出されるアクションである（/wp-includes/template-loader.php参照）。

実装するコードは次の通り。

add_action( 'template_redirect', 'extend_template_redirect' );

function extend_template_redirect() {
	if ( is_singular() ) {	// 投稿・固定ページのみ
		global $post;
		if ( false !== strpos( $post->post_content, '[' ) ) {
			$pattern = get_shortcode_regex();
			preg_replace_callback( "/$pattern/s", 'pre_shortcode_tag_callback', $post->post_content );
		}
	}
}

function pre_shortcode_tag_callback( $m ) {
	if ( ( $m[1] == '[' && $m[6] == ']' ) )
		return;

	$tag = $m[2];
	$attr = shortcode_parse_atts( $m[3] );
	$content = '';
	if ( isset( $m[5] ) ) $content = $m[5];
	do_action( 'pre_shortcode_'.$tag, $attr, $content );
}

これでショートコードが組み込まれたページを表示する前に、'pre_shortcode_ショートコード名'という名前のアクションが実行されることになる。独自のアクションは add_action関数を使って必要なショートコードのアクション関数を登録しておけばいい。ショートコード名が'test'の場合は次のような感じになる。

add_action( 'pre_shortcode_test', 'my_pre_shortcode_test', 10, 2 );

function my_pre_shortcode_test( $attr, $content='' ) {
	// ここに前処理を記述
}

以前、前処理をテンプレートファイルに記述して実装したことがあったが、こちらの方がテンプレートファイルがすっきりする。独自フォームの埋め込みについては、ショートコードを使用せずにカスタムフィールドを使う方法もありそう。まあ、カスタムフィールドの場合でも同じようなことはできそうである。とりあえず自分用メモってことで。