【上級者向け】ブロック初期値カスタマイズ機能（β）の使い方

yStandard Toolboxでは、yStandard関連プラグインで追加されるブロックの初期値をカスタマイズする機能があります。

いつも決まったブロックの設定をする場合に便利な機能です。

このページで紹介している機能では有料プラグイン「yStandard Toolbox」を使用しています。
プラグインの詳細は yStandard Toolbox ページをご覧ください。

※この機能は yStandard Toolbox v1.14.0から利用できます。

ブロック初期値カスタマイズ機能の概要
注意事項
カスタマイズサンプルコード
対応ブロック
- yStandard Blocks
- yStandard Toolbox

ブロック初期値カスタマイズ機能の概要

ブロック初期値カスタマイズ機能はカスタマイズのルールに沿ったPHPコードを追加することでブロックの初期値を上書きできる機能です。

子テーマやプラグインから、JavaScriptの知識が無くても簡単にカスタマイズできる機能になります。

注意事項

ブロック初期値カスタマイズ機能は万能な機能ではありません。

以下のような注意事項がありますので、注意事項をご確認の上、デメリット等を把握した上でカスタマイズを実施してください。

設定する初期値によっては「このブロックには、想定されていないか無効なコンテンツが含まれています。」エラーが発生しやすくなる恐れがあります。
「クリア」「リセット」ボタンがある設定の初期値を設定した場合、クリア・リセット後編集画面を開き直した場合に「このブロックには、想定されていないか無効なコンテンツが含まれています。」エラーが発生しやすくなります。

カスタマイズサンプルコード

サンプルコードは下記になります▼

// `ys_block_default_attributes` フィルターフックを使い、初期値を定義した配列を返す.
add_filter( 'ys_block_default_attributes', 'my_ys_block_defaults' );

function my_ys_block_defaults( $attributes ) {
	// ブロック名 => [ 設定名 => 設定値 ] の形式で配列を作成する。
	return [
		'ystdtb/box' => [
			'label'         => 'ボックスラベル初期値',
			'boxBorderSize' => '10px',
		],
	];
}

初期値の指定は ys_block_default_attributes フックを使い、初期値を定義した配列を返します。

初期値の定義は [ ブロック名 => [ 設定名 => 設定値 ] ] となり、設定名については各ブロックのマニュアルで確認できます。

上記コードを使った場合、下記のようにラベルと枠線サイズが予め設定された状態でボックスブロックが追加されます。