テンプレートタグ/get links

このテンプレートタグは WordPress 2.3 から非推奨となりました。後継となる新しいテンプレートタグが作られたか、動作対象外となり、WordPress の将来のバージョンで削除される見込みです。 このタグを使っていた場合は、後継の wp_list_bookmarks に切り替えてください。

• 書式： <?php get_links(category, 'before', 'after', 'between', show_images, 'order', show_description,show_rating, limit, show_updated, echo); ?>
• 説明： リンク管理画面（リンクマネジャー）で追加・編集したリンクのうち、特定のカテゴリー内のリンクを出力。管理画面で指定した「開始タグ」、「終了タグ」、「リンクと概要の間（に挿入するテキスト）」の設定を使用して出力結果をフォーマットする。
• 位置： ループ外
• 引数：
  • category （整数）- 出力させるリンクカテゴリーのID。デフォルト値は-1で、すべてのカテゴリー内のリンクを出力。
  • before （文字列）

リンクの直前に出力するコードやテキスト。デフォルト値は空。

• • after （文字列）- リンクの直後に出力するコードやテキスト。デフォルト値は空。
  • between （文字列）- リンクの間に出力するコードやテキスト。デフォルト値は ' '（半角スペース）。
  • show_images （文字列）- リンクの間に出力するコードやテキスト。デフォルト値は ' '（半角スペース）。
  • show_images （true/false）- リンクテキストの代わりに管理画面で指定した画像を出力するかどうか。
    • true（テキストの代わりに画像にリンクする）
    • false（デフォルト。画像は出力せず、テキストでリンクを示す）
  • order （規定値）- リンクの並び順。_nameや_idのようにアンダースコアを始めに加えると、並び順の上下が逆になる（「rand」を除く）。
    • id、url、name、target（リンクのターゲットウィンドウ）、category、description（説明文）、owner（リンクを追加した「所有者」）、rating（0〜9の評価）、updated（更新日時）、rel（リンク先の相手との関係/XFN）、notes（非公開のメモ）、rss（フィードURL）、length（リンク名。短いリンク→長いリンクの順）、rand（ランダム順）
  • show_description （true/false）- リンクの説明を出力するかどうか。show_imagesがデフォルトまたはfalseの場合のみ有効。
    • true（デフォルト。説明文を出力）
    • false（説明文を出力しない）
  • show_rating （true/false）- リンクの評価を出力するかどうか。
    • true（デフォルト。評価を出力）
    • false（評価を出力しない）
  • limit （整数）- 出力するリンクの数。デフォルト値は-1で、存在するすべてのリンクを出力。
  • show_updated （整数）- 更新日時のタイムスタンプを出力するかどうか。
    • true（更新日時を出力）
    • false（デフォルト。更新日時を出力しない）
  • echo （true/false）- 取得した値の処理方法。
    • true（デフォルト。リンク一覧をページ内に出力する）
    • false（PHPで使用できる値としてリンク一覧の情報を返す）