get_bookmarks

説明

mixed get_bookmarks( [ mixed $args = '' ] )
リンク情報を取得する。

パラメータ

  • $args
    取得条件を文字列または配列で指定。指定できる条件は次の通り。
    条件名条件の値
    orderbyソート項目として'length'、'rand'、'link_id'、'name'などを指定(省略時は'name')。'length'と'rand'以外を複数指定する場合は,(カンマ)で区切る。
    orderソート順として'ASC'または'DESC'を指定(省略時は'ASC')。
    limit取得件数(省略時は-1)。
    categoryリンクカテゴリーID(省略時は'')
    category_nameリンクカテゴリー名(省略時は'')
    hide_invisible非表示情報を取得しない場合は1、取得する場合は0を指定(省略時は1)
    show_updated更新日情報を取得する場合は1、取得しない場合は0を指定(省略時は0)
    include限定して取得するリンクID。複数指定する場合は,(カンマ)で区切る(省略時は'')
    exclude除外するインクID。複数指定する場合は,(カンマ)で区切る(省略時は'')
    searchint

返り値

リンク情報の配列を返す。リンク情報のプロパティは次の通り。
プロパティ名データ型意味
link_idintID
link_urlstringウェブアドレス
link_namestring名前
link_imagestring画像のアドレス
link_targetstringリンクターゲット(''、'_top'、'_blank')
link_descriptionstring説明
link_visiblestring表示状態(表示の場合は'Y')
link_ownerstringオーナーID
link_ratingint評価(0~10)
link_updatedstring更新日時
link_relstringrel
link_notesstringメモ
link_rssstringRSSのアドレス

注意

リンク情報のカテゴリーは、投稿記事のカテゴリーとは別の管理となっている。

使用例

  • リンク情報を取得する。
    <?php $links = get_bookmarks( ); ?>
  • リンク情報をランダムに5件取得する。
    <?php $links = get_bookmarks( 'orderby=rand&limit=5' ); ?>

最終更新 : 2011年06月10日 13:53



お勧め

5.5で非推奨になる関数名について(2020年8月12日 更新)

来月にリリースされるWordPress 5.5に向けてBeta 1、2と公開が続いている。「WordPress 5.5 Beta 2(以降Beta 2)」のソースコードを見ていくと、いくつかの関数が非推奨になるようだ。

meta_compare_key使ってみた(2019年3月19日 更新)

ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名(メタキー)に含まれる文字列を指定する'meta_compare_key'キーだ。

プラグインの設定ページもレスポンシブ対応(2014年6月3日 更新)

レスポンシブ対応したWordPressの管理画面。プラグインやテーマのカスタマイズで管理画面を拡張しているなら、切り替わるタイミングはきっちり押さえておきたいところではないだろうか。

初期化に関連するアクションのおさらい(2013年11月27日 更新)

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

全投稿を取得するのはnopaging=1でいい(2011年8月31日 更新)

query_posts関数(またはWP_Queryクラス)を使う場合、取得する件数の指定を省略すると管理者ページの「表示設定」-「1ページに表示する最大件数」の指定値分だけの投稿情報を取得する。それでは条件にマッチするすべての投稿情報を取得するには?