register_widget

説明

void register_widget( string $widget_class )
ウィジェットを登録する。

パラメータ

  • $widget_class
    ウィジェットのクラス名を指定。

返り値

返り値はありません。

注意

独自のウィジェットはWP_Widgetクラスを継承したクラスを定義し、そのクラス名をこのregister_widget関数で指定して登録する。register_widget関数を呼ぶタイミングは、テーマであればfunctions.phpにてwidgets_initアクションの処理内で行うのが望ましいようだ。

使用例

  • ウィジェットを登録する。
    <?php register_widget( 'Mytheme_Text_Widget' );
    
    class Mytheme_Text_Widget extends WP_Widget {
    	function __construct() {
    		// ここにウィジェットの初期化処理を記述
    	}
    	function widget( $args, $instance ) {
    		// ウィジェットによる表示(出力)処理を記述
    	}
    	function flush_widget_cache() {
    		// wp_cache_delete関数でウィジェットのキャッシュを削除
    	}
    	function update( $new_instance, $old_instance ) {
    		// ウィジェットのプロパティ更新処理を記述
    	}
    	function form( $instance ) {
    		// ウィジェットのプロパティフォームを記述
    	}
    }
    ?>

フィルター

実行するフィルターはありません。

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/widgets.php

最終更新 : 2013年01月28日 12:14


お勧め

WP_Postオブジェクトで投稿情報を直感的に使う(2012年10月4日 更新)

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。

さくらのVPSでKUSANAGI#2(2018年5月27日 更新)

今回は「前回」の続き。さくらのVPS(メモリー2GB SSDプラン)でパフォーマンスをApacheのabコマンドで確認してみた。はてさて、うたい文句通りのパフォーマンスは発揮するのだろうか。

タイトルのみをキーワード検索する(2014年4月3日 更新)

WordPressのキーワード検索は、投稿タイトルと本文のどちらかに指定したキーワードが含まれているかを調べるわけだが、時々タイトルだけとか、逆に本文だけ検索したいケースがある。

Login rebuilder 2.6.0の新機能紹介(2019年4月22日 更新)

今回追加したものは、REST API / Usersの使用をログイン時のみ使用できるように制限する機能である。この機能を有効にすることで、管理者情報が漏洩するリスクを低減させる効果が期待できる。

Blacklist keys manager:プラグイン作ってみました(2015年5月22日 更新)

少し前から明らかにスパムと思われるコメントが投稿され、そのモデレーションメールを受け取る回数が増えてきた。あまりにもあからさまなコメントばかりなので、何らかの対策ができないか考えてみました。