- 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細)
「テンプレートタグ/get bookmarks」の版間の差分
提供: WordPress Codex 日本語版
< テンプレートタグ
(00:21, June 28, 2013 Obenland 版の英語版を全体にコピペ。) |
細 (→関連項目) |
||
(他の1人の利用者による、間の1版が非表示) | |||
24行目: | 24行目: | ||
'search' => '' ); ?></pre> | 'search' => '' ); ?></pre> | ||
− | + | デフォルトでは、使用方法はこの値が入ります: | |
− | * | + | * 全てのブックマークが名前の降順で並びます |
− | * | + | * 非公開のブックマークは戻されません |
− | * | + | * link_updated_f フィールド (タイムスタンプ形式の更新時間) は戻されません |
<div id="Parameters"> | <div id="Parameters"> | ||
== パラメータ == | == パラメータ == | ||
</div> | </div> | ||
− | ; orderby : ('' | + | ; orderby : (''文字列'') ブックマークを並べる順番の値。デフォルトは <tt>'name'</tt> 。有効なオプションは: |
− | :* <tt>'link_id'</tt> - | + | :* <tt>'link_id'</tt> - WordPress 3.2 以前では: <tt>'id'</tt> |
:* <tt>'url'</tt> | :* <tt>'url'</tt> | ||
− | :* <tt>'name'</tt> - | + | :* <tt>'name'</tt> - デフォルト |
− | :* <tt>'owner'</tt> - | + | :* <tt>'owner'</tt> - ブックマークマネージャーを通してそれを追加したユーザー。 |
:* <tt>'rating'</tt> | :* <tt>'rating'</tt> | ||
:* <tt>'visible'</tt> | :* <tt>'visible'</tt> | ||
− | :* <tt>'length'</tt> - | + | :* <tt>'length'</tt> - ブックマーク名。短い順。 |
− | :* <tt>'rand'</tt> - | + | :* <tt>'rand'</tt> - ブックマークをランダムな順に表示する。 |
− | ; order : ('' | + | ; order : (''文字列'') 上記、 orderly パラメーターの値を昇順か降順か決める。有効な値は: |
− | :* <tt>ASC</tt> - | + | :* <tt>ASC (昇順)</tt> - デフォルト |
− | :* <tt>DESC</tt> | + | :* <tt>DESC (降順)</tt> |
− | ; limit : ('' | + | ; limit : (''整数'') 表示させるブックマークの最大数。デフォルトは <tt>-1</tt> (全て表示) |
− | ; category : ('' | + | ; category : (''文字列'') コンマで区切られたブックマークカテゴリーの ID リスト |
− | ; category_name : ('' | + | ; category_name : (''文字列'') 取得するブックマークのカテゴリー名。上記 category パラメーターより優先される。 |
− | ; hide_invisible : ('' | + | ; hide_invisible : (''真偽値'') TRUE にすると link_visible が 'Y' であるものだけが取得される。 |
− | :* <tt>1</tt> (True) - | + | :* <tt>1</tt> (True) - デフォルト |
:* <tt>0</tt> (False) | :* <tt>0</tt> (False) | ||
− | ; show_updated : ('' | + | ; show_updated : (''真偽値'') TRUE にすると、 "link_updated" と同じ値を UNIX のタイムスタンプフォーマットで格納する "link_category_f" が結果に追加される。これは PHP の日付機能を用いるときに便利なモノ。 |
:* <tt>1</tt> (True) | :* <tt>1</tt> (True) | ||
− | :* <tt>0</tt> (False) - | + | :* <tt>0</tt> (False) - デフォルト |
− | ; include : ('' | + | ; include : (''文字列'') 出力するブックマークの ID リストをコンマで区切ったもの。例えば、 'include=1,3,6' は、ブックマーク ID が 1, 3, 6 のものを出力する。もしこの値が使われた場合、 ''category'', ''category_name'', ''exclude'' のパラメーターは無視される。デフォルトは <tt><nowiki>''</nowiki></tt> (全てのブックマーク)。 |
− | ; exclude : ('' | + | ; exclude : (''文字列'') 出力しないブックマークの ID リストをコンマで区切ったもの。例えば、 'exclude=4,12' は、ブックマーク ID が 4, 12 のものを出力しない。デフォルトは <tt><nowiki>''</nowiki></tt> (出力しないものはない → 全てのブックマークを表示)。 |
− | ; search : ('' | + | ; search : (''文字列'') <tt>search</tt> 文字列のように、 <tt>link_url</tt>, <tt>link_name</tt>, <tt>link_description</tt> を検索する。デフォルトは <tt><nowiki>''</nowiki></tt> 。 |
− | = | + | <div id="Return Values"> |
− | ; ( | + | == 戻り値 == |
+ | </div> | ||
+ | ; (配列) : ブックマーク列のリストオブジェクト。各ブックマークオブジェクトは以下を含む: | ||
+ | 'link_id', 'link_url', 'link_name', 'link_image', 'link_target', 'link_category', 'link_description', 'link_visible', 'link_owner', 'link_rating', 'link_updated', 'link_rel', 'link_notes', 'link_rss' | ||
<div id="Examples"> | <div id="Examples"> | ||
== 使用例 == | == 使用例 == | ||
</div> | </div> | ||
− | - | + | - "Related Sites" という名のリンクカテゴリーを作成する<br /> |
− | - | + | - いくつかのリンクを作成し、 "Related Sites" カテゴリーに追加する |
− | + | リンクを取得するためには、テンプレートに以下のコードを用いるとよい: | |
<pre> | <pre> | ||
<?php | <?php | ||
84行目: | 87行目: | ||
)); | )); | ||
− | // | + | // 各ブックマークをループし、フォーマットされた出力を表示する |
foreach ( $bookmarks as $bookmark ) { | foreach ( $bookmarks as $bookmark ) { | ||
printf( '<a class="relatedlink" href="%s">%s</a><br />', $bookmark->link_url, $bookmark->link_name ); | printf( '<a class="relatedlink" href="%s">%s</a><br />', $bookmark->link_url, $bookmark->link_name ); | ||
105行目: | 108行目: | ||
</div> | </div> | ||
− | {{原文|Template Tags/get_bookmarks| | + | {{原文|Template Tags/get_bookmarks|141102}}<!-- 21:45, February 8, 2014 Djkaz 版 --> |
111行目: | 114行目: | ||
{{Tag Footer}} | {{Tag Footer}} | ||
− | |||
− |
2015年5月23日 (土) 00:13時点における最新版
この関数は管理画面 > リンク > 編集画面にあるブックマークの配列を返すものです。このテンプレートタグはブックマークの情報を直に取得するものです。
使い方
<?php get_bookmarks( $args ); ?>
初期設定での使用
<?php $args = array( 'orderby' => 'name', 'order' => 'ASC', 'limit' => -1, 'category' => '', 'category_name' => '', 'hide_invisible' => 1, 'show_updated' => 0, 'include' => '', 'exclude' => '', 'search' => '' ); ?>
デフォルトでは、使用方法はこの値が入ります:
- 全てのブックマークが名前の降順で並びます
- 非公開のブックマークは戻されません
- link_updated_f フィールド (タイムスタンプ形式の更新時間) は戻されません
パラメータ
- orderby
- (文字列) ブックマークを並べる順番の値。デフォルトは 'name' 。有効なオプションは:
- 'link_id' - WordPress 3.2 以前では: 'id'
- 'url'
- 'name' - デフォルト
- 'owner' - ブックマークマネージャーを通してそれを追加したユーザー。
- 'rating'
- 'visible'
- 'length' - ブックマーク名。短い順。
- 'rand' - ブックマークをランダムな順に表示する。
- order
- (文字列) 上記、 orderly パラメーターの値を昇順か降順か決める。有効な値は:
- ASC (昇順) - デフォルト
- DESC (降順)
- limit
- (整数) 表示させるブックマークの最大数。デフォルトは -1 (全て表示)
- category
- (文字列) コンマで区切られたブックマークカテゴリーの ID リスト
- category_name
- (文字列) 取得するブックマークのカテゴリー名。上記 category パラメーターより優先される。
- hide_invisible
- (真偽値) TRUE にすると link_visible が 'Y' であるものだけが取得される。
- 1 (True) - デフォルト
- 0 (False)
- show_updated
- (真偽値) TRUE にすると、 "link_updated" と同じ値を UNIX のタイムスタンプフォーマットで格納する "link_category_f" が結果に追加される。これは PHP の日付機能を用いるときに便利なモノ。
- 1 (True)
- 0 (False) - デフォルト
- include
- (文字列) 出力するブックマークの ID リストをコンマで区切ったもの。例えば、 'include=1,3,6' は、ブックマーク ID が 1, 3, 6 のものを出力する。もしこの値が使われた場合、 category, category_name, exclude のパラメーターは無視される。デフォルトは '' (全てのブックマーク)。
- exclude
- (文字列) 出力しないブックマークの ID リストをコンマで区切ったもの。例えば、 'exclude=4,12' は、ブックマーク ID が 4, 12 のものを出力しない。デフォルトは '' (出力しないものはない → 全てのブックマークを表示)。
- search
- (文字列) search 文字列のように、 link_url, link_name, link_description を検索する。デフォルトは '' 。
戻り値
- (配列)
- ブックマーク列のリストオブジェクト。各ブックマークオブジェクトは以下を含む:
'link_id', 'link_url', 'link_name', 'link_image', 'link_target', 'link_category', 'link_description', 'link_visible', 'link_owner', 'link_rating', 'link_updated', 'link_rel', 'link_notes', 'link_rss'
使用例
- "Related Sites" という名のリンクカテゴリーを作成する
- いくつかのリンクを作成し、 "Related Sites" カテゴリーに追加する
リンクを取得するためには、テンプレートに以下のコードを用いるとよい:
<?php $bookmarks = get_bookmarks( array( 'orderby' => 'name', 'order' => 'ASC', 'category_name' => 'Related Sites' )); // 各ブックマークをループし、フォーマットされた出力を表示する foreach ( $bookmarks as $bookmark ) { printf( '<a class="relatedlink" href="%s">%s</a><br />', $bookmark->link_url, $bookmark->link_name ); } ?>
改訂履歴
Version 2.1 にて導入されました。
ソースファイル
get_bookmarks() は wp-includes/bookmark.php
にあります。
関連項目
最新英語版: WordPress Codex » Template Tags/get_bookmarks (最新版との差分)
ブックマークタグ: wp_list_bookmarks, get_bookmarks, get_bookmark get_bookmark_field
関数リファレンス、テンプレートタグ目次もご覧ください。