get_bookmark()


関数WordPressget_bookmark()は、指定されたブックマーク(リンク)の情報を取得するために使用されます。この関数は、リンクのIDやその他の属性に基づいて、リンクの詳細を取得します。

構文

get_bookmark( int|stdClass $bookmark, string $output = OBJECT, string $filter = 'raw' );

引数の説明:

  • $bookmark (int|stdClass) — ブックマークのIDまたはオブジェクト。
  • $output (string) — 戻り値の形式。OBJECT、ARRAY_A、ARRAY_Nのいずれか。
  • $filter (string) — フィルタの種類。デフォルトは’raw’。

例1: ブックマークの情報を取得

この例では、IDが1のブックマークの情報を取得します。

<?php $bookmark = get_bookmark( 1 ); print_r( $bookmark ); ?>

例2: ブックマークのURLを表示

ブックマークのURLを取得して表示します。

<?php $bookmark = get_bookmark( 1 ); echo $bookmark->link_url; ?>

例3: ブックマークの名前を表示

ブックマークの名前を取得して表示します。

<?php $bookmark = get_bookmark( 1 ); echo $bookmark->link_name; ?>

例4: ブックマークの説明を表示

ブックマークの説明を取得して表示します。

<?php $bookmark = get_bookmark( 1 ); echo $bookmark->link_description; ?>

例5: ブックマークの情報を配列として取得

ブックマークの情報を配列として取得します。

<?php $bookmark = get_bookmark( 1, ARRAY_A ); print_r( $bookmark ); ?>

例6: ブックマークの情報をフィルタリングして取得

ブックマークの情報をフィルタリングして取得します。

<?php $bookmark = get_bookmark( 1, OBJECT, 'edit' ); print_r( $bookmark ); ?>

注意点

  • ブックマークのIDが存在しない場合、関数はnullを返します。
  • フィルタリングオプションを使用する際は、適切なフィルタを選択してください。

関連機能: