WP_Widget クラスの使い方説明・引数・注意点
WP_Widget は、独自のウィジェットを作るための基底クラスです。継承して、widget()、form()、update() を実装します。
説明
WP_Widget は、独自のウィジェットを作るための基底クラスです。継承して、widget()、form()、update() を実装します。
基本構文
class My_Widget extends WP_Widget
引数
widget( $args, $instance ):画面への出力form( $instance ):管理画面の設定フォームupdate( $new, $old ):保存時の処理
戻り値
register_widget() で登録して使います。
使い方(サンプル)
class My_Widget extends WP_Widget {
public function __construct() {
parent::__construct( 'my_widget', 'マイウィジェット' );
}
public function widget( $args, $instance ) {
echo $args['before_widget'] . 'Hello' . $args['after_widget'];
}
}
add_action( 'widgets_init', function() {
register_widget( 'My_Widget' );
} );
注意点
- 出力値は必ずエスケープします。
update()では、受け取った値をサニタイズして返します。- ブロックウィジェット画面では、旧ウィジェットが「レガシーウィジェット」ブロックとして扱われます。
実務での使いどころ
- 独自のウィジェットを、作るとき(
WP_Widgetを継承して、widget()・form()・update()を実装する)。
よくあるミスと対策
- クラスを作っただけで、
register_widget()で、登録していない。 widget()の中で、$args['before_widget']と$args['after_widget']を、出力していない。サイドバーの設定した、HTMLが、反映されない。update()の中で、入力値を、サニタイズしていない。widget()の中で、値を、エスケープせずに、出力している。
NG例
public function widget( $args, $instance ) {
echo $instance['title']; // エスケープがなく、前後の HTML もない
}
OK例
public function widget( $args, $instance ) {
echo $args['before_widget'];
echo esc_html( $instance['title'] );
echo $args['after_widget'];
}
public function update( $new, $old ) {
return array( 'title' => sanitize_text_field( $new['title'] ) );
}
使い分け早見表
| やりたいこと | 使うもの |
|---|---|
| ウィジェットを作る | WP_Widget を継承する |
| ウィジェットを登録する | register_widget() |
| ウィジェット領域を登録する | register_sidebar() |
PR エックスサーバー
WordPressを、速く・止まらずに運営したい方へ
サーバー選びを間違えると、表示が遅い・サイトが止まるリスクがあります
こんなお悩みはありませんか?
- どのレンタルサーバーを選べばよいか分からない
- 表示が遅い・サイトが落ちるのが心配
- WordPressの設定やセキュリティに自信がない
サーバーは、あとから乗り換えると、データの移行やドメインの設定に手間がかかります。表示が遅い、突然止まるといったトラブルは、訪問者が離れる原因にもなります。最初に、稼働率の保証や実績を確認して選ぶのが安全です。
エックスサーバーなら、WordPressの運営に強いレンタルサーバーを、迷わず選べます。国内でWordPressを利用して運用されているサイトの集計(Dataprovider.com調べ、2025年6月)で、国内シェアNo.1と公式サイトに記載されています。
No.1WordPressサイトの国内シェア(Dataprovider.com調べ・2025年6月)
99.99%以上サーバー月間稼働率を保証
99%以上WordPressへの攻撃を未然に防ぐ(2024年9月15日〜11月15日の当社調べ)
選ばれるポイント
- WordPressサイトの国内シェアNo.1。実績で選びたいときの安心材料(Dataprovider.com調べ、2025年6月)
- サイトが止まりにくい。月間稼働率99.99%以上を保証し、下回ると月額費用の一部を返金
- 攻撃に強い。WordPressを狙った攻撃の99%以上を未然に防ぐ機能(2024年9月15日〜11月15日の当社調べ)
- ドメイン代を節約できる。独自ドメインが永久無料(対象ドメイン・契約期間などの条件あり)
- テーマ選びも安心。人気テーマ「Cocoon」の開発・提供元が運営
- 10日間の無料お試しで、契約前に操作や表示の速さを確かめられる
10日間の無料お試しで、契約前に試せます
10日間無料でお試し
広告(アフィリエイト)を含みます。特長は2026年11月8日時点の公式サイトの記載で、数値・順位は各調査・調べの時点のものです。料金・条件は公式サイトでご確認ください。
関連項目
本記事は情報提供を目的としています。WordPress本体やテーマ・プラグインのバージョンによって動作が異なる場合があるため、本番環境に反映する前に、必ずテスト環境で動作を確認してください。
PR当サイトはアフィリエイト広告を利用しています。掲載内容は広告主から依頼・指示を受けたものではなく、筆者の調査・体験にもとづきます。