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

お勧めコンテンツ

4.2の「アクティビティ」ウィジェットに投稿以外の情報も表示する(2015年5月13日 登録)

ダッシュボードの「アクティビティ」ウィジェットは「投稿(post)」の状況を表示し、固定ページ(page)やカスタム投稿タイプの投稿記事の状況については標準では表示されない。このことに対して以前『3.8の「アクティビティ」ウィジェットに投稿以外の情報も表示する』を紹介したのだが、4.2では新しいフィルターが追加され、カスタマイズが少し容易になった。

4.2で始まるiOSの絵文字ケア(2015年3月22日 登録)

WordPress 4.2のベータ1、ベータ2が立て続けにリリースされ、4.2の正式版リリースが近づいています。4.2のポイントの1つは絵文字のクロスブラウザ対応です。ここでの絵文字とは、UTF-8で4バイトのコードが割り当てられている(基本的にはiOSの)絵文字を指します。この絵文字を含んだ投稿が正しく保存できなかったり、iOS以外の環境で意図した通りに表示できないといった問題があり、4.2ではそのような問題を対処をコードが組み込まれています。

投稿内容のid属性などを保存するための対策(2012年6月15日 登録)

WordPress 3.4にアップデートしたとある環境で投稿記事を保存すると、divタグなどのid属性がクリアされて保存するようになった(id属性が保存できなくなった)。ここでは、その対策方法の1つを紹介しておく。

プラグインで注意が必要な関数(2013年11月27日 登録)

先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。

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

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

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