register_widget

(2.8.0以降)
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

お勧めコンテンツ

初期状態で「抜粋」ウィジェットを表示する(2014年1月7日 登録)

投稿編集ページのウィジェットは標準で表示されるものとされないものがある。フォーラムに『投稿の編集画面にデフォルトで抜粋を表示させたい』という投稿があったので、ちょっと調べてみた。

メディア(attachment)を拡張してより便利に活用する(2014年5月22日 登録)

「メディア(attachment)」は、標準ではカテゴリもタグもカスタムフィールドもない。投稿と親子関係を作って利用することが前提だからともいえるが、メディアをもっと便利に活用するために、それらの付加情報を絞り込みの材料として利用できないか調べてみた。

子カテゴリのアーカイブページを親カテゴリ用のテンプレートファイルで表示しよう(2011年12月8日 登録)

少し前に投稿した「適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす」で説明した通り、特定のカテゴリ専用のテンプレートとしてcategory-○○.phpを用意することで、category.phpやarchive.php内で振り分けを行う必要がなくなる。ただ、すべてのカテゴリ分を用意するのは効率的ではないし、特に子カテゴリについては親カテゴリと共通内容になるケースが多いのではないだろうか。ここでは、子カテゴリの個別テンプレートファイルを作らず、親カテゴリのテンプレートを利用する方法を紹介する。

ページを表示する直前の前処理にtemplate_redirectアクションを(2013年4月13日 登録)

リクエストに応じてページを表示する直前の準備として何かしらの処理を行っておきたいケースがある。そんな時、テーマの各テンプレートファイルの先頭部分に処理内容をずらずらと記述していませんか。

新「WordPress Events and News」ウィジェットが興味深い(2017年5月26日 登録)

4.8のベータ版ですぐに新機能とわかるのが管理者ダッシュボードの新「WordPress Events and News」ウィジェット。ユーザーが指定した地域近隣で開催されるイベント情報を表示してくれるウィジェットで、この中のフォームがちょっと興味深かった。なおこの記事はWordPress 4.8 beta-2をもとにしており、以降のバージョンで変更される可能性があることをあらかじめ断っておく。

最終更新日時 : 2013-01-28 12:14