register_block_core_legacy_widget()


WordPressのregister_block_core_legacy_widget()関数は、レガシーウィジェットをブロックエディタで使用できるように登録するための関数です。この関数は、従来のウィジェットをGutenbergブロックとして利用する際に役立ちます。

構文

register_block_core_legacy_widget( string $widget_id, array $args = array() );

引数の説明:

  • $widget_id(string) — 登録するウィジェットのIDを指定します。
  • $args(array) — ウィジェットの追加設定を配列で指定します。

例1: 基本的なレガシーウィジェットの登録

この例では、基本的なレガシーウィジェットをブロックとして登録します。

register_block_core_legacy_widget( 'my_custom_widget' );

例2: カスタム設定を追加してレガシーウィジェットを登録

この例では、カスタム設定を追加してレガシーウィジェットを登録します。

register_block_core_legacy_widget( 'my_custom_widget', array( 'title' => 'カスタムタイトル' ) );

例3: 複数のレガシーウィジェットを一度に登録

この例では、複数のレガシーウィジェットを一度に登録します。

register_block_core_legacy_widget( 'widget_one' ); register_block_core_legacy_widget( 'widget_two' );

例4: ウィジェットのタイトルを動的に設定

この例では、ウィジェットのタイトルを動的に設定します。

register_block_core_legacy_widget( 'my_custom_widget', array( 'title' => get_the_title() ) );

例5: ウィジェットのクラス名をカスタマイズ

この例では、ウィジェットのクラス名をカスタマイズします。

register_block_core_legacy_widget( 'my_custom_widget', array( 'class' => 'custom-widget-class' ) );

例6: ウィジェットの説明を追加

この例では、ウィジェットの説明を追加します。

register_block_core_legacy_widget( 'my_custom_widget', array( 'description' => 'これはカスタムウィジェットです。' ) );

例7: ウィジェットのアイコンを設定

この例では、ウィジェットのアイコンを設定します。

register_block_core_legacy_widget( 'my_custom_widget', array( 'icon' => 'wordpress' ) );

注意点

  • レガシーウィジェットを登録する際は、既存のウィジェットIDが重複しないように注意してください。
  • ブロックエディタでの表示に問題が生じる場合、ウィジェットの設定を確認してください。

関連機能：