WP: テンプレートタグ機能一覧
このページは 2007.4.8 をもって更新停止。今後は ps*wiki » テンプレートタグ で更新していきます。
WordPress を設置して、表示テーマを選んでみて、このテーマのここがなあ・・・などと思ったときに最初に触ることになるのが、テンプレートタグ1 でありましょう。2
テンプレートタグは、括弧内のパラメータ指定を変えるだけで簡単に表示を変えることが出来るので、私のような初心者にも扱いやすくて便利なもの。
ただ、Codex にテンプレートタグの一覧があるものの、分類別にテンプレートタグ名が並んでいるだけなので、それが何に使えるテンプレートタグで、どんな応用が利くのかは、個別ページを読んでみないと分からない。
そこで、この一覧に機能概要を書き添えていこうと思う。3 使ったこと・調べたことがあるタグから掲載。
WP 2.1 から非推奨となったタグ4 ・新規タグ5 が複数あるので、バージョンアップ前に原文をチェック & テーマ内を grep。
Author tags
Category tags
- the_category — 現在の記事の全カテゴリを、そのカテゴリアーカイブへのリンク付きで表示。ループ中で使用。区切り文字と親カテゴリを併記するかをパラメータで指定可。
- the_category_rss — RSS で使用
- single_cat_title
- category_description — パラメータで指定したカテゴリの概要（カテゴリ管理画面で入力したもの）を取得、echo で表示。
- wp_dropdown_categories 2.1 以上
- dropdown_cats 2.1 から非推奨
- wp_list_categories 2.1 以上
- list_cats 2.1 から非推奨 — wp_list_cats と同様な機能、パラメータの書き方が異なる。こっちが古そう。EasyAll で使用。
- 2.1 以上では wp_list_categories() を使う。
- wp_list_cats 2.1 から非推奨 — リンク付きカテゴリリストを表示。そのリンクをクリックすると、当該カテゴリの全記事を、the Template Hierarchy rules に沿ったカテゴリ・テンプレートにて表示。デフォルトテーマで使用。 使用例： WP： 逆引き（したいこと別）リスト
- 2.1 以上では wp_list_categories() を使う。
- in_category — 条件分岐に使うコンディショナルタグ6 の一つ。現在の記事がパラメータで指定したカテゴリに属するとき true を返す。ループ中で使用。ループ外で使うときは Use OUTSIDE The Loop 参照。
- get_category_parents — 現在の または 指定したカテゴリと、そこから最上位までの各カテゴリを取得。echo すれば表示。
- get_the_category — 現在の記事が属する各カテゴリの情報を取得。ループ中で使用。カテゴリID・カテゴリ名・カテゴリスラッグ・カテゴリ概要・親カテゴリが配列に格納されるので、好きなように取り出して使う。
Comment tags
Date and Time tags
- the_date — 現在の記事の投稿日時を表示 or 取得。ループ中で使用。1ページに同一投稿日の記事があったら、その最初の記事にのみ表示。どの記事にも表示したいときは the_time を使用。
パラメータで日時フォーマット・前後の文字・表示／取得の指定可。フォーマットを指定しなければ、管理画面 > オプション > 一般設定 - 日付のフォーマット で設定したフォーマット。 - the_time — 現在の記事の投稿日時を表示。ループ中で使用。パラメータで日時フォーマット指定可。指定しなければ、管理画面 > オプション > 一般設定 - 時間のフォーマット で設定したフォーマット。
General tags
- bloginfo — 設置したWPの各種情報を表示（主に管理画面の一般設定やユーザープロフィールの項目）。値を取得したいときは get_bloginfo を使用。テンプレートのどこでも使える。ブログ名・URI・RSS・文字コード・設置ディレクトリURIなど、表示したい項目をパラメータで指定。
sidebar.phpやheader.phpでよく使われているので参考に。 - get_bloginfo — bloginfo と同様の項目の値を取得。php のどこでも使える。
- wp_get_archives — 月別アーカイブリスト等、日付に基づくリンク付きアーカイブリストを表示。テンプレートのどこでも使える（サイドバーに限らない）。月・日・週別のほか、最近の投稿 n件のリストも可能。パラメータで 種別・件数・リスト形式・前後の文字・記事数の表示を指定可。
- get_posts new — マルチループ（複数ループ）の作成に使用。詳細記事
- wp_list_pages — 「ページ」一覧を表示。パラメータで参照： WP： 逆引き（したいこと別）リスト
Geo tags
Link tags
Links Manager tags
- get_links_list — 管理画面 > リンク で「表示：はい」になっている全てのリンクを、カテゴリ順に表示する。パラメータでソート順を指定：カテゴリ名順かカテゴリID順か。7 リンクカテゴリ画面の「カテゴリー設定」は有効だが、「フォーマット」は無視される。
- wp_get_links — パラメータで指定したカテゴリIDに属するリンクを表示。各リンクはカテゴリの「フォーマット」で設定したタグで括られるので、もしそれが<li>タグなら、<ul>タグや見出しの追加が必要。
- get_links
- wp_get_linksbyname 2.1 から非推奨 — 全カテゴリまたは指定したカテゴリのリンクを、パラメータの条件に従って表示。
- get_linksbyname 2.1 から非推奨
Permalink tags
- get_permalink — パラメータにIDを指定した記事のパーマリンクURIを取得する。これをechoすればURIを表示。ループ中でパラメータなしで使うと、現在の記事のパーマリンクURIを取得。
- the_permalink — 現在の記事のパーマリンクURIを表示。ループ中で使用。パラメータなし。
Post tags
- the_content — 現在の記事の本文を表示。ループ中で使用。記事中に<!–more–> がある場合、単体記事ページ（パーマリンクページ）以外では、それより前の部分を表示し「続きを読む」リンクを添える。パラメータで「続きを読む」の文言を指定可、strip_teaser はよく分からない。。。
- the_excerpt — 現在の記事の抜粋を表示。「抜粋表示オプション」が空なら最初の120語を出力。HTMLタグや画像は除外。ループ中で使用。パラメータなし。
単語間がスペースで区切られない日本語の場合、長文が出てしまうが、対策用パッチを使えば解決。でも、面倒なので本家に要望出したい。
デフォルトテーマで使われている previous_posts_link, next_posts_link、EasyAll で使われている previous_post_link, next_post_link は、Codex に掲載されていない。テンプレートタグとは違うのかな。。。
Trackback tags
関連ドキュメント
英語の方が最新版に近いです。。
- テンプレートタグの説明
- WordPress Codex » Template Tags [en] — テンプレートタグ一覧
- Wptags.com [ja] — テンプレートタグ日本語説明。最新版・詳細・事例は前項参照。
- ループとは？
- WordPress Codex » The Loop [en]
- WPJ Codex » ループ [ja]
- 「ページ」とは？
- テーマ・テンプレートに関するドキュメント一覧
- コンディショナルタグ（条件分岐タグ） — 状況別に処理（表示など）を変えるときの条件文に使用。トップページでだけ、カテゴリ別ページのときだけ表示、みたいなときに。デフォルトテーマでは、サイドバーの表示分けに使われている。
- インクルードタグ — ページのパーツ（ヘッダ部・サイドバー部・フッタ部）を、土台となるテンプレートファイル（
index.php等）に配置するときに使用。
当サイト内にあるその他のリファレンス
- よく使われる値の取得・表示・リスト表示などの処理をまとめて、一語で呼び出せるようにしたもの。目に付くところでは、サイドバーにあるページリスト・カテゴリリスト・月別アーカイブリストの表示等。
sidebar.phpの<li><a href='http://bono.s201.xrea.com/date/2008/09/' title='September 2008'>September 2008</a></li> <li><a href='http://bono.s201.xrea.com/date/2008/08/' title='August 2008'>August 2008</a></li> <li><a href='http://bono.s201.xrea.com/date/2008/07/' title='July 2008'>July 2008</a></li> <li><a href='http://bono.s201.xrea.com/date/2008/06/' title='June 2008'>June 2008</a></li> <li><a href='http://bono.s201.xrea.com/date/2008/04/' title='April 2008'>April 2008</a></li> <li><a href='http://bono.s201.xrea.com/date/2008/03/' title='March 2008'>March 2008</a></li> <li><a href='http://bono.s201.xrea.com/date/2008/02/' title='February 2008'>February 2008</a></li> <li><a href='http://bono.s201.xrea.com/date/2008/01/' title='January 2008'>January 2008</a></li> <li><a href='http://bono.s201.xrea.com/date/2007/12/' title='December 2007'>December 2007</a></li> <li><a href='http://bono.s201.xrea.com/date/2007/11/' title='November 2007'>November 2007</a></li> <li><a href='http://bono.s201.xrea.com/date/2007/10/' title='October 2007'>October 2007</a></li> <li><a href='http://bono.s201.xrea.com/date/2007/09/' title='September 2007'>September 2007</a></li> <li><a href='http://bono.s201.xrea.com/date/2007/08/' title='August 2007'>August 2007</a></li> <li><a href='http://bono.s201.xrea.com/date/2007/07/' title='July 2007'>July 2007</a></li> <li><a href='http://bono.s201.xrea.com/date/2007/06/' title='June 2007'>June 2007</a></li> <li><a href='http://bono.s201.xrea.com/date/2007/05/' title='May 2007'>May 2007</a></li> <li><a href='http://bono.s201.xrea.com/date/2007/04/' title='April 2007'>April 2007</a></li> <li><a href='http://bono.s201.xrea.com/date/2007/03/' title='March 2007'>March 2007</a></li> <li><a href='http://bono.s201.xrea.com/date/2007/02/' title='February 2007'>February 2007</a></li> <li><a href='http://bono.s201.xrea.com/date/2007/01/' title='January 2007'>January 2007</a></li> <li><a href='http://bono.s201.xrea.com/date/2006/12/' title='December 2006'>December 2006</a></li> <li><a href='http://bono.s201.xrea.com/date/2006/11/' title='November 2006'>November 2006</a></li> <li><a href='http://bono.s201.xrea.com/date/2006/10/' title='October 2006'>October 2006</a></li> <li><a href='http://bono.s201.xrea.com/date/2006/09/' title='September 2006'>September 2006</a></li> <li><a href='http://bono.s201.xrea.com/date/2006/08/' title='August 2006'>August 2006</a></li> <li><a href='http://bono.s201.xrea.com/date/2006/07/' title='July 2006'>July 2006</a></li> <li><a href='http://bono.s201.xrea.com/date/2006/06/' title='June 2006'>June 2006</a></li> <li><a href='http://bono.s201.xrea.com/date/2006/05/' title='May 2006'>May 2006</a></li> <li><a href='http://bono.s201.xrea.com/date/2006/04/' title='April 2006'>April 2006</a></li> <li><a href='http://bono.s201.xrea.com/date/2006/03/' title='March 2006'>March 2006</a></li> <li><a href='http://bono.s201.xrea.com/date/2005/05/' title='May 2005'>May 2005</a></li> <li><a href='http://bono.s201.xrea.com/date/2005/04/' title='April 2005'>April 2005</a></li> <li><a href='http://bono.s201.xrea.com/date/2003/05/' title='May 2003'>May 2003</a></li> <li><a href='http://bono.s201.xrea.com/date/2003/03/' title='March 2003'>March 2003</a></li> <li><a href='http://bono.s201.xrea.com/date/2003/02/' title='February 2003'>February 2003</a></li> <li><a href='http://bono.s201.xrea.com/date/2003/01/' title='January 2003'>January 2003</a></li> <li><a href='http://bono.s201.xrea.com/date/2002/12/' title='December 2002'>December 2002</a></li> <li><a href='http://bono.s201.xrea.com/date/2002/11/' title='November 2002'>November 2002</a></li> <li><a href='http://bono.s201.xrea.com/date/2002/10/' title='October 2002'>October 2002</a></li> <li><a href='http://bono.s201.xrea.com/date/2002/09/' title='September 2002'>September 2002</a></li> <li><a href='http://bono.s201.xrea.com/date/2002/08/' title='August 2002'>August 2002</a></li> <li><a href='http://bono.s201.xrea.com/date/2002/07/' title='July 2002'>July 2002</a></li> <li><a href='http://bono.s201.xrea.com/date/2002/06/' title='June 2002'>June 2002</a></li> <li><a href='http://bono.s201.xrea.com/date/2002/05/' title='May 2002'>May 2002</a></li> <li><a href='http://bono.s201.xrea.com/date/2002/04/' title='April 2002'>April 2002</a></li> <li><a href='http://bono.s201.xrea.com/date/2002/03/' title='March 2002'>March 2002</a></li> <li><a href='http://bono.s201.xrea.com/date/2002/02/' title='February 2002'>February 2002</a></li> <li><a href='http://bono.s201.xrea.com/date/2002/01/' title='January 2002'>January 2002</a></li> <li><a href='http://bono.s201.xrea.com/date/2001/11/' title='November 2001'>November 2001</a></li> <li><a href='http://bono.s201.xrea.com/date/2001/10/' title='October 2001'>October 2001</a></li> <li><a href='http://bono.s201.xrea.com/date/2001/07/' title='July 2001'>July 2001</a></li> <li><a href='http://bono.s201.xrea.com/date/2001/06/' title='June 2001'>June 2001</a></li> <li><a href='http://bono.s201.xrea.com/date/2001/05/' title='May 2001'>May 2001</a></li>みたいなやつ。[back] - 次点は、コンディショナルタグ、インクルードタグあたり？[back]
- メモが散乱してきたので。。。このページが完成する日はやって来るのだろうか。(^-^;;;[back]
- 原文に Deprecated in 2.1 と付記[back]
- 原文に Version 2.1 と付記[back]
- 次点は、コンディショナルタグ、インクルードタグあたり？[back]
- アンダーバーをつけて ‘_name’, ‘_id’ とすると、降順に表示される。[back]