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_titleからwp_get_document_titleへ(2015年11月15日 更新)

先週、WordPress 4.4 beta1(以降4.4 beta1)が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。

Paste JSON text:プラグイン作ってみました(2014年1月6日 更新)

動作検証用のサーバーと本番サーバーで投稿データの同期作業(コピー&ペースト)を支援するプラグインです。動作検証用のサーバーで投稿記事をJSONテキストに変換してクリップボードにコピー。本番サーバーの新規投稿ページでクリップボードにコピーしたJSONテキストをペーストして、投稿記事のコピー&ペーストを実現します。複数サーバー間で投稿記事の同期を行っている方は、お試しあれ。

「投稿に挿入」時のタグをちょっとカスタマイズ(2011年7月29日 更新)

投稿画面において、画像をアップロードし投稿に挿入するすると、imgタグをaタグで囲んだものが挿入される(キャプションを指定した場合はタグも)。それらの画像をLightBox(JavaScriptライブラリ)で表示する場合、aタグにrel属性を追加するのだが、その作業を毎回投稿に挿入した後で行うのがちょっと面倒。というわけで、自動的にrel属性を追加するようにしてみました。

投稿情報を連想配列で参照する(2014年11月17日 更新)

投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。

oEmbed対応サイトを整理した(2017年11月18日 更新)

投稿記事にTwitterやYouTubeのURL(アドレス)を記述したとき、表示されるページにはリンクとしてではなく、埋め込んだURLの内容が表示される。この仕組み(機能)はoEmbedというもので、対応サイトは随時バージョンアップしている。