- 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細)
「テンプレートタグ/the widget」の版間の差分
提供: WordPress Codex 日本語版
< テンプレートタグ
(2.8: 新規テンプレートタグ。テンプレートのどこにでもウィジェットを出力できる) |
細 (→参考: Template:BrowseSource 引数変更に伴い修正。) |
||
276行目: | 276行目: | ||
== 参考 == | == 参考 == | ||
* ソースコード: | * ソースコード: | ||
− | ** {{BrowseSource|wp-includes/widgets.php | + | ** {{BrowseSource|wp-includes/widgets.php}} |
− | ** {{BrowseSource|wp-includes/default-widgets.php | + | ** {{BrowseSource|wp-includes/default-widgets.php}} |
* [https://core.trac.wordpress.org/ticket/9701 Ticket 9701 (Add a the_widget() function to output a generic widget anywhere in a template)] | * [https://core.trac.wordpress.org/ticket/9701 Ticket 9701 (Add a the_widget() function to output a generic widget anywhere in a template)] | ||
2009年11月8日 (日) 01:01時点における版
目次
説明
テンプレートタグ the_widget() は、任意のウィジェットを出力します。テンプレートのどこでも使えます。
使い方
<?php the_widget($widget, $instance, $args); ?>
パラメータ
- widget
- (文字列) ウィジェットの PHP クラス名
- WP_Widget_Archives -- アーカイブ
- WP_Widget_Calendar -- カレンダー
- WP_Widget_Categories -- カテゴリー
- WP_Widget_Links -- リンク
- WP_Widget_Meta -- メタ (ログイン/アウト、RSS フィードリンク等)
- WP_Widget_Pages -- ページ
- WP_Widget_Recent_Comments -- 最近のコメント
- WP_Widget_Recent_Posts -- 最近の投稿
- WP_Widget_RSS -- RSS
- WP_Widget_Search -- 検索 (検索フォーム)
- WP_Widget_Tag_Cloud -- タグクラウド
- WP_Widget_Text -- テキスト
- instance
- (配列またはクエリ文字列型) ウィジェットのインスタンス設定(下記の各ウィジェットを参照)
- args
- (配列またはクエリ文字列型) ウィジェットのサイドバー引数
- before_widget
- (文字列) ウィジェットの前に出力するテキストまたは HTML
- 初期値: <div class="widget ウィジェットのクラス名">
- after_widget
- (文字列) ウィジェットの後ろに出力するテキストまたは HTML
- 初期値: </div>
- before_title
- (文字列) 見出しの前に出力するテキストまたは HTML
- 初期値: <h2 class="widgettitle">
- after_title
- (文字列) 見出しの後ろに出力するテキストまたは HTML
- 初期値: </h2>
- 例:
<?php the_widget('WP_Widget_Pages', '', 'before_title=<h3>&after_title=</h3>'); ?>
アーカイブ・ウィジェット
月別アーカイブリストを出力します。
<?php the_widget('WP_Widget_Archives', $instance, $args); ?>
- ウィジェットのクラス名:
widget_archive
- instance:
- title
- アーカイブリストの見出し。初期値は
__('Archives')
- count
- 投稿数を表示するか。wp_get_archives の show_post_count パラメータ。初期値は 0(表示しない)
- dropdown
- ドロップダウンメニューで出力するか。初期値は 0(箇条書きリスト)。
用例
初期設定のまま使用:
<?php the_widget('WP_Widget_Archives'); ?>
ドロップダウン形式で月別アーカイブリストを出力:
<?php the_widget('WP_Widget_Archives', 'dropdown=1'); ?>
カレンダー・ウィジェット
カレンダーを出力します。
<?php the_widget('WP_Widget_Calendar', $instance, $args); ?>
- ウィジェットのクラス名:
widget_calendar
- instance:
- title
- カレンダーの見出し。初期値は
' '
用例
初期設定のまま使用:
<?php the_widget('WP_Widget_Calendar'); ?>
カテゴリー・ウィジェット
カテゴリーリストを出力します。
<?php the_widget('WP_Widget_Categories', $instance, $args); ?>
- ウィジェットのクラス名:
widget_categories
- instance:
- title
- カテゴリーリストの見出し。初期値は
__( 'Categories' )
- count
- 各カテゴリの投稿数を表示する(1)か。wp_dropdown_categories または wp_list_categories の show_count パラメータ。初期値は 0(表示しない)
- hierarchical
- カテゴリの親子を入れ子(ツリー)表示にする(1)か。初期値は 0(親子同レベルに表示)
- dropdown
- リストをドロップダウンメニューで表示する(1)か。初期値は 0(箇条書きリスト)
用例
初期設定のまま使用:
<?php the_widget('WP_Widget_Categories'); ?>
ドロップダウンリストで、投稿数も表示する:
<?php the_widget('WP_Widget_Categories', 'dropdown=1&count=1'); ?>
リンク・ウィジェット
リンクリストを出力します。
<?php the_widget('WP_Widget_Links', $instance, $args); ?>
- ウィジェットのクラス名:
- instance:
- title
- リンクリストの見出し。
- category
- 出力するリンクカテゴリID。複数のときはカンマ区切り(,)で指定。同 category パラメータ。初期値は false(全カテゴリを出力)
- description
- 各リンクの説明を表示する(1)か。wp_list_bookmarks の show_description パラメータ。初期値は false(表示しない)
- rating
- 評価を表示する(1)か。同 show_rating パラメータ。初期値は false(表示しない)
- images
- 画像を表示する(1)か。同 show_images パラメータ。初期値は true(表示する)
- name
- 画像を表示する場合に alt 属性にリンク名を出力する(1)か。同 show_name パラメータ。初期値は false(出力しない)
用例
初期設定のまま使用:
<?php the_widget('WP_Widget_Links'); ?>
リンクカテゴリID 2, 3 のみを出力:
<?php the_widget('WP_Widget_Links', 'category=2,3'); ?>
メタ・ウィジェット
サイトのメタ情報(ログイン/アウト、フィードリンク、wordpress.org へのリンク)を出力します。
<?php the_widget('WP_Widget_Meta', $instance, $args); ?>
- ウィジェットのクラス名:
widget_meta
- instance:
- title
- メタ情報の見出し。初期値は
__('Meta')
用例
初期設定のまま使用:
<?php the_widget('WP_Widget_Meta'); ?>
ページ・ウィジェット
ページリストを表示します。
<?php the_widget('WP_Widget_Pages', $instance, $args); ?>
- ウィジェットのクラス名:
widget_pages
- instance:
- title
- ページリストの見出し。初期値は
__( 'Pages' )
- sortby
- 何の順に表示するか。wp_list_pages の sort_column パラメータ。初期値は
menu_order
(ページの「表示順」) - exclude
- 除外するページID。複数のときはカンマ区切り(,)で指定。初期値なし(全ページを表示)
用例
初期設定のまま使用:
<?php the_widget('WP_Widget_Pages'); ?>
見出しを <h3>コンテンツ</h3> に変更し、更新順に表示:
<?php the_widget('WP_Widget_Pages', 'title=コンテンツ&sortby=post_modified', 'before_title=<h3>&after_title=</h3>'); ?>
最近のコメント・ウィジェット
<?php the_widget('WP_Widget_Recent_Comments', $instance, $args); ?>
- ウィジェットのクラス名:
widget_recent_comments
- instance:
- title : 出力するコメントリストの見出し。
__('Recent Comments')
- number : 表示するコメント数。最大 15件。初期値は 5
- title : 出力するコメントリストの見出し。
用例
初期設定のまま使用:
<?php the_widget('WP_Widget_Recent_Comments'); ?>
最近の投稿・ウィジェット
<?php the_widget('WP_Widget_Recent_Posts', $instance, $args); ?>
- ウィジェットのクラス名:
widget_recent_entries
- instance:
- title : 出力する投稿リストの見出し。初期値は
__('Recent Posts')
- number : 表示する投稿数。最大 15件。
- title : 出力する投稿リストの見出し。初期値は
用例
初期設定のまま使用:
<?php the_widget('WP_Widget_Recent_Posts'); ?>
RSS ウィジェット
<?php the_widget('WP_Widget_RSS', $instance, $args); ?>
- ウィジェットのクラス名:
- instance:
- title
- url
- items
- show_summary
- show_author
- show_date
- number
用例
初期設定のまま使用:
<?php the_widget('WP_Widget_RSS'); ?>
検索ウィジェット
<?php the_widget('WP_Widget_Search', $instance, $args); ?>
- ウィジェットのクラス名:
widget_search
- instance:
- title : 初期値なし
用例
初期設定のまま使用:
<?php the_widget('WP_Widget_Search'); ?>
タグクラウド・ウィジェット
<?php the_widget( 'WP_Widget_Tag_Cloud', $instance, $args); ?>
- ウィジェットのクラス名:
- instance:
- title : 出力するタグクラウドの見出し。初期値は
__('Tags')
- title : 出力するタグクラウドの見出し。初期値は
用例
初期設定のまま使用:
<?php the_widget( 'WP_Widget_Tag_Cloud'); ?>
テキスト・ウィジェット
<?php the_widget('WP_Widget_Text', $instance, $args); ?>
- ウィジェットのクラス名:
widget_text
- instance:
- title : 出力するテキストの見出し。初期値なし
- text :
- filter
用例
初期設定のまま使用:
<?php the_widget('WP_Widget_Text'); ?>
変更履歴
- 2.8 : 新規テンプレートタグ