• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

「テンプレートタグ/get bookmarks」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(00:21, June 28, 2013 Obenland 版の英語版を全体にコピペ。)
(和訳完了)
24行目: 24行目:
 
'search'        => '' ); ?></pre>
 
'search'        => '' ); ?></pre>
  
By default, the usage gets:
+
デフォルトでは、使用方法はこの値が入ります:
* All bookmarks ordered by name, ascending
+
* 全てのブックマークが名前の降順で並びます
* Bookmarks marked as hidden are not returned.
+
* 非公開のブックマークは戻されません
* The link_updated_f field (the update time in the form of a timestamp) is not returned.
+
* link_updated_f フィールド (タイムスタンプ形式の更新時間) は戻されません
  
 
<div id="Parameters">
 
<div id="Parameters">
 
== パラメータ ==
 
== パラメータ ==
 
</div>
 
</div>
; orderby : (''string'') Value to sort bookmarks on. Defaults to <tt>'name'</tt>. Valid options:
+
; orderby : (''文字列'') ブックマークを並べる順番の値。デフォルトは <tt>'name'</tt> 。有効なオプションは:
:* <tt>'link_id'</tt> - Before WordPress 3.2: <tt>'id'</tt>
+
:* <tt>'link_id'</tt> - WordPress 3.2 以前では: <tt>'id'</tt>
 
:* <tt>'url'</tt>
 
:* <tt>'url'</tt>
:* <tt>'name'</tt> - Default
+
:* <tt>'name'</tt> - デフォルト
:* <tt>'owner'</tt> - User who added bookmark through bookmarks Manager.
+
:* <tt>'owner'</tt> - ブックマークマネージャーを通してそれを追加したユーザー。
 
:* <tt>'rating'</tt>
 
:* <tt>'rating'</tt>
 
:* <tt>'visible'</tt>
 
:* <tt>'visible'</tt>
:* <tt>'length'</tt> - The length of the bookmark name, shortest to longest. 
+
:* <tt>'length'</tt> - ブックマーク名。短い順。
:* <tt>'rand'</tt> - Display bookmarks in random order. 
+
:* <tt>'rand'</tt> - ブックマークをランダムな順に表示する。
  
; order : (''string'') Sort order, ascending or descending for the orderby parameter. Valid values:
+
; order : (''文字列'') 上記、 orderly パラメーターの値を昇順か降順か決める。有効な値は:
:* <tt>ASC</tt> - Default
+
:* <tt>ASC (昇順)</tt> - デフォルト
:* <tt>DESC</tt>
+
:* <tt>DESC (降順)</tt>
  
; limit : (''integer'') Maximum number of bookmarks to display. Defaults to <tt>-1</tt> (all bookmarks).
+
; limit : (''整数'') 表示させるブックマークの最大数。デフォルトは <tt>-1</tt> (全て表示)
  
; category : (''string'') Comma separated list of bookmark category ID's.
+
; category : (''文字列'') コンマで区切られたブックマークカテゴリーの ID リスト
  
; category_name : (''string'') Category name of a category of bookmarks to retrieve. Overrides category parameter.
+
; category_name : (''文字列'') 取得するブックマークのカテゴリー名。上記 category パラメーターより優先される。
  
; hide_invisible : (''boolean'') TRUE causes only bookmarks with link_visible set to 'Y' to be retrieved.
+
; hide_invisible : (''真偽値'') TRUE にすると link_visible 'Y' であるものだけが取得される。
:* <tt>1</tt> (True) - Default
+
:* <tt>1</tt> (True) - デフォルト
 
:* <tt>0</tt> (False)
 
:* <tt>0</tt> (False)
  
; show_updated : (''boolean'') TRUE causes an extra column called "link_category_f" to be inserted into the results, which contains the same value as "link_updated", but in a unix timestamp format. Handy for using PHP date functions on this data.
+
; show_updated : (''真偽値'') TRUE にすると、 "link_updated" と同じ値を UNIX のタイムスタンプフォーマットで格納する "link_category_f" が結果に追加される。これは PHP の日付機能を用いるときに便利なモノ。
 
:* <tt>1</tt> (True)
 
:* <tt>1</tt> (True)
:* <tt>0</tt> (False) - Default
+
:* <tt>0</tt> (False) - デフォルト
  
; include : (''string'') Comma separated list of numeric bookmark IDs to include in the output.  For example, 'include=1,3,6' means to return or echo bookmark IDs 1, 3, and 6.  If the include string is used, the ''category'', ''category_name'', and ''exclude'' parameters are ignored.  Defaults to <tt>''</tt> (all Bookmarks).
+
; include : (''文字列'') 出力するブックマークの ID リストをコンマで区切ったもの。例えば、 'include=1,3,6' は、ブックマーク ID が 1, 3, 6 のものを出力する。もしこの値が使われた場合、 ''category'', ''category_name'', ''exclude'' のパラメーターは無視される。デフォルトは <tt><nowiki>''</nowiki></tt> (全てのブックマーク)
  
; exclude : (''string'') Comma separated list of numeric bookmark IDs to exclude.  For example, 'exclude=4,12' means that bookmark IDs 4 and 12 will NOT be returned or echoed.  Defaults to <tt>''</tt> (exclude nothing).
+
; exclude : (''文字列'') 出力しないブックマークの ID リストをコンマで区切ったもの。例えば、 'exclude=4,12' は、ブックマーク ID が 4, 12 のものを出力しない。デフォルトは <tt><nowiki>''</nowiki></tt> (出力しないものはない → 全てのブックマークを表示)
  
; search : (''string'') Searches <tt>link_url</tt>, <tt>link_name</tt> or <tt>link_description</tt> like the <tt>search</tt> string. Defaults to <tt>''</tt>.
+
; search : (''文字列'') <tt>search</tt> 文字列のように、 <tt>link_url</tt>, <tt>link_name</tt>, <tt>link_description</tt> を検索する。デフォルトは <tt><nowiki>''</nowiki></tt>
  
== Return Values ==
+
<div id="Return Values">
; (array) : List of bookmark row objects.  Each bookmark object may contain the following: '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>
 +
; (配列) : ブックマーク列のリストオブジェクト。各ブックマークオブジェクトは以下を含む:
 +
'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>
- Create a link category named "Related Sites"<br />
+
- "Related Sites" という名のリンクカテゴリーを作成する<br />
- Create a few links, adding them to the "Related Sites" category
+
- いくつかのリンクを作成し、 "Related Sites" カテゴリーに追加する
  
You may use the following code in your templates to retrieve the links:
+
リンクを取得するためには、テンプレートに以下のコードを用いるとよい:
 
<pre>
 
<pre>
 
<?php
 
<?php
84行目: 87行目:
 
));
 
));
  
// Loop through each bookmark and print formatted output
+
// 各ブックマークをループし、フォーマットされた出力を表示する
 
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|132614}}<!-- 00:21, June 28, 2013 Obenland 版 -->
+
{{原文|Template Tags/get_bookmarks|141102}}<!-- 21:45, February 8, 2014 Djkaz  版 -->
  
  

2014年2月8日 (土) 21:54時点における版

この関数は管理画面 > リンク > 編集画面にあるブックマークの配列を返すものです。このテンプレートタグはブックマークの情報を直に取得するものです。

使い方

<?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


関数リファレンステンプレートタグ目次もご覧ください。