カスタム投稿タイプの投稿保存には専用アクションを使おう

説明

カスタム投稿タイプを登録して、専用ウィジェット（meta_box）を使って拡張情報を入力させ、それらの情報をsave_postアクションで保存する。これまではこんな感じだったのだが、久しぶりにカスタム投稿タイプを使ったら、save_postアクションの前にsave_postに投稿タイプ名がくっついたアクションが追加されていた。

あらゆる投稿情報の保存は、 wp_insert_post関数で行われる。これはカスタム投稿タイプであっても例外ではなく、その中のアクションを利用することで独自に拡張した情報を保存することができる。それに対応できるアクションはいくつかあり、従来はsave_postアクションを利用することが多かったと思う。

do_action( 'save_post', $post_ID, $post, $update );

上記は3.9.1のコードになるが、よく見ると$updateパラメータが追加されており、アクション関数内で新規か更新かを判別できるようになっている。過去のバージョンのソースコードを見てみると、この変更は3.7.0からのようだ。そしてこのsave_postアクションの直前には、次のようなsave_postに投稿タイプ名が付いたアクションが記述されていた。

do_action( "save_post_{$post->post_type}", $post_ID, $post, $update );

アクション名が投稿タイプ別になることから、このアクションを使用すればアクション関数内で投稿タイプの判定をする必要はなり、コードはすっきりするだろう。具体的な使い方だが、例えばカスタム投稿タイプ名が'tool'なら、次のように記述すればいい。

add_action( 'admin_init' , 'my_admin_init' );

function my_admin_init() {
	add_action( 'save_post_tool', 'my_save_post_tool', 10, 3 );
}

function my_save_post_tool( $post_ID, $post, $update ) {
	// カスタム投稿タイプ専用の入力項目名が"tool[○○○○]"の場合
	if ( isset( $_POST['tool'] ) ) {
		$tool_params = stripslashes_deep( $_POST['tool'] );
		// 以下に保存用の処理を記述

	}
}

このような記述は3.7.0より前のバージョンでは無効なので、汎用のテーマやプラグインで使用する場合はバージョン制限を意識する必要がある。また、このアクションは wp_publish_post関数でも呼び出されるので、フォーム（ウィジェット）から送信されるデータの有無も注意しよう。