register_widget() の使い方｜説明・引数・注意点

説明

基本構文

register_widget( string|WP_Widget $widget ): void

引数

• $widget：WP_Widget を継承したクラス名

戻り値

戻り値はありません。

使い方（サンプル）

add_action( 'widgets_init', function() {
	register_widget( 'My_Widget' );
} );

注意点

• widgets_init フックで呼びます。
• WP_Widget を継承したクラスを別途定義しておく必要があります。

実務での使いどころ

• 独自のウィジェット（WP_Widget を継承したクラス）を、使えるようにするとき。

よくあるミスと対処

• widgets_init フックの外で呼んでいる。
• クラスを、WP_Widget から継承していない。
• ウィジェットの出力で、値を、エスケープしていない。

NG例

register_widget( 'My_Widget' ); // widgets_init の外で呼んでいる

OK例

add_action( 'widgets_init', function () {
	register_widget( 'My_Widget' );
} );

使い分け早見表

関連項目

register_sidebar()、dynamic_sidebar()

公式リファレンス：register_widget() | Function | WordPress Developer Resources