yoast_get_primary_term_id()


WordPressのyoast_get_primary_term_id()関数は、Yoast SEOプラグインによって指定された投稿またはカスタム投稿タイプのプライマリタームIDを取得するために使用されます。

構文

yoast_get_primary_term_id( string $taxonomy, int $post_id = null );

引数の説明:

  • $taxonomy (string) — 取得したいプライマリタームが属するタクソノミーのスラッグ(例: 'category'または'post_tag')。
  • $post_id (int, オプション) — 投稿ID。指定しない場合は現在の投稿IDが使用されます。

例 1: 現在の投稿のカテゴリのプライマリタームIDを取得

<?php $primary_term_id = yoast_get_primary_term_id( 'category' ); ?>

例 2: 特定の投稿IDのタグのプライマリタームIDを取得

<?php $primary_term_id = yoast_get_primary_term_id( 'post_tag', get_the_ID() ); ?>

例 3: プライマリタームを名前で取得して表示

<?php
$primary_term_id = yoast_get_primary_term_id( 'category' );
if ( $primary_term_id ) {
    $term = get_term( $primary_term_id );
    echo $term->name;
}
?>

例 4: カスタムタクソノミーのプライマリタームIDを取得

<?php $primary_term_id = yoast_get_primary_term_id( 'custom_taxonomy', get_the_ID() ); ?>

例 5: プライマリタームが設定されているかを確認

<?php
$primary_term_id = yoast_get_primary_term_id( 'category' );
if ( $primary_term_id ) {
    echo 'プライマリタームが設定されています: ' . $primary_term_id;
} else {
    echo 'プライマリタームは設定されていません。';
}
?>

注意事項

  • プライマリタームが設定されていない場合、この関数はnullを返します。