register_widget

パラメータ

• $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