2022年04月25日

WP関数：unregister_widget()

この関数の説明

WP関数の unregister_widget() は、管理画面の「外観→ウィジェット」に表示されているウェジット部品を削除する関数です。

<表示されたウィジェットの例>

関数

unregister_widget( $widget_class )

パラメータ

$widget_class (文字列)

非表示にしたいウイジェットのクラス名を指定します。

戻り値

ありません

解説

デフォルトで表示されているウィジェット部品は下記になります。

ウィジェット表示名	クラス名	説明
RSS	'WP_Widget_RSS'	RSS フィードの URLを追加
アーカイブ	'WP_Widget_Archives'	月別アーカイブ
カスタムHTML	'WP_Widget_Custom_HTML'	HTML コードの追加
カテゴリー	'WP_Widget_Categories'	カテゴリーリストの表示
カレンダ	'WP_Widget_Calendar'	カレンダーの表示
ギャラリー	'WP_Widget_Media_Gallery'	メディアの画像を表示しますコメント：16番の画像の方がより汎用性が高い
タグクラウド	'WP_Widget_Tag_Cloud'	タグの表示
テキスト	'WP_Widget_Text'	テキストの追加
ナビゲーションメニュー	'WP_Nav_Menu_Widget'	メニュの表示
メタ情報	'WP_Widget_Meta'	メタ情報の表示
動画	'WP_Widget_Media_Video'	動画(メディア動画またはURL)を追加
固定ページ	'WP_Widget_Pages'	固定ページを表示する
最近のコメント	'WP_Widget_Recent_Comments'	最近のコメントを表示する
最近の投稿	'WP_Widget_Recent_Posts'	最近の投稿を表示する
検索	'WP_Widget_Search'	検索BOXを表示する
画像	'WP_Widget_Media_Image'	メディアの画像、またはURL画像を表示する
音声	'WP_Widget_Media_Audio'	メディアの音声、またはURL音声を追加する

上記のウィジェットが総て表示されていると使いづらい事があります。

下記の様にすると「外観→ウィジェット」の画面が少し簡素化します。

function set_widgets() {
   unregister_widget('WP_Widget_RSS'); 
   unregister_widget('WP_Widget_Archives'); 
   unregister_widget('WP_Widget_Calendar');
   unregister_widget('WP_Widget_Media_Gallery');//画像と重複するので要らない
   unregister_widget('WP_Widget_Tag_Cloud'); 
   unregister_widget('WP_Widget_Meta'); 
   unregister_widget('WP_Widget_Recent_Comments'); 
   unregister_widget('WP_Widget_Search'); 
   unregister_widget('WP_Widget_Media_Audio');
}
add_action('widgets_init', 'set_widgets');