この記事は最後に更新してから1年以上経過しています。

メタボックスをクラシックエディターのみで表示する

説明

投稿画面向けにメタボックスを使ったプラグインがあり、それがブロックエディターで意図した通りに機能しなかった。この対処方法を考える過程でエディタータイプに応じてメタボックスを出し分けできる方法が見つかったので紹介したい。

add_meta_box関数の第7パラメータ

投稿画面のメタボックス(ウィジェット)にはブロックエディターではうまく機能しないものや不要なものがある。メタボックスは従来通りの指定では両エディターで表示されるが、エディタータイプに応じて表示が切り替え可能になっていた(「Meta Box Compatibility Flags」)。

メタボックスは add_meta_box関数で表示する。まずは関数の定義部分をおさらい。

void add_meta_box( string $id, string $title, string $callback, string $page [, string $context = 'advanced' [, string $priority = 'default' [, array $callback_args = null ] ] ] )

ポイントとなるのは第7パラメータ$callback_argsで、ここに次に示す連想配列を指定することでクラシックエディターのみで表示させることができる。

add_meta_box( 'meta_box_test', 'meta box test', 'meta_box_test_callback',
	 'post', 'side', 'default',
	array(
//		'__block_editor_compatible_meta_box'	=> false,
		'__back_compat_meta_box' 				=> true,
	) );

キー'__back_compat_meta_box'の値にtrueを指定することで、メタボックスはクラシックエディターのみで表示される。コメント化しているキー'__block_editor_compatible_meta_box'はメタボックスがブロックエディターに対応しているかどうかを示すもの。現在のバージョン5.0.3ではここをコメント化してもクラッシックエディターのみで表示できた。

なお、試した限りではブロックエディターのみで表示する指定は見つからなかった。このパラメータについては将来のバージョンで変更される可能性が示唆されているので、リクエストしだいでは仕様が変更されるかもしれない。


最終更新 : 2019年01月15日 11:21


お勧め

get_post_time(2018年5月27日 更新)

mixed get_post_time( [ string $d = 'U' [ , bool $gmt = false [ , mixed $post = null [ , bool $translate = false ] ] ] ] )
パラメータ$dで指定されたフォーマットに従って投稿データの投稿時刻を取得する。

has_tag(2012年1月17日 更新)

bool has_tag( [ mixed $tag = '' [ , mixed $post = null ] ] )
投稿記事に投稿タグが付属しているか調べる。

delete_term_meta(2018年5月27日 更新)

bool delete_term_meta( int $term_id, string $meta_key [ , mixed $meta_value = '' ] )
タームのメタ情報を削除する。

wp_save_post_revision(2023年4月3日 更新)

int | WP_Error | void wp_save_post_revision( int $post_id )
現状の投稿のリビジョンを作成する。

safecss_filter_attr(2023年3月31日 更新)

string safecss_filter_attr( string $css [ , string $deprecated = '' ] )
インラインスタイルをサニタイズする。