ワードプレスのthe_ID関数の使用方法・解説

概要

the_ID 関数は、WordPress のテーマファイル内で投稿のユニークな ID を表示するために使用されます。主に、以下のような機能を実装する際によく使われます。

1. 投稿の詳細ページで投稿 ID を表示する。
2. カスタムポストタイプの投稿 ID を取得する。
3. 投稿のメタデータを編集する際に、特定の投稿を指定する。
4. 投稿に対するカスタムフィールドの値を取得するためのIDを参照する。
5. 投稿を参照するリンクを作成する際の URL に ID を使用する。
6. 特定の投稿を条件にしたクエリを構築する。
7. 投稿のコンテンツに投稿 ID を埋め込むことでトラッキングを行う。
8. 投稿の編集画面で ID を表示することで、管理者がどの投稿を扱っているかを明確にする。

構文

the_ID();

パラメータ

この関数にはパラメータはありません。

戻り値

この関数は、投稿の ID を表示するのみで、値を返しません。

関連する関数

https://refwp.com/?titleonly=1&s=the_ID

使用可能なバージョン

この関数は WordPress バージョン 1.5 以降で使用可能です。

関連ファイル

この関数は wp-includes/post.php に含まれています。

サンプルコード

サンプル 1: 投稿一覧ページに投稿 ID を表示する

<?php if ( have_posts() ) : while ( have_posts() ) : the_post(); ?>
    <h2><?php the_title(); ?></h2>
    <p>投稿ID: <?php the_ID(); ?></p>
<?php endwhile; endif; ?>

このコードは、投稿一覧ページに各投稿のタイトルと、その投稿の ID を表示します。

サンプル 2: シングル投稿ページで投稿 ID を表示する

<?php
if ( is_single() ) {
    echo 'この投稿のIDは: ';
    the_ID();
}
?>

このコードは、シングル投稿ページでその投稿の ID を表示します。

サンプル 3: 投稿IDをカスタムメタフィールドで使用

<?php
$post_id = get_the_ID();
$custom_field_value = get_post_meta($post_id, 'my_custom_field', true);
echo 'カスタムフィールドの値: ' . esc_html($custom_field_value);
?>

このコードは、現在の投稿 ID を取得して、その ID を使ってカスタムメタフィールドの値を取得し表示します。

サンプル 4: 投稿 ID を用いたリンクを作成

<a href="<?php echo get_permalink(); ?>?ref_id=<?php the_ID(); ?>">この投稿にリンク</a>

このコードは、現在の投稿にリンクを作成し、クエリパラメータとして投稿 ID を追加します。

サンプル 5: 投稿の ID を利用して条件付きクエリを実行

<?php
add_action('pre_get_posts', 'custom_query');
function custom_query($query) {
    if (is_home() && $query->is_main_query()) {
        $query->set('post__not_in', array(get_the_ID())); // 現在の投稿を除外
    }
}
?>

このコードは、ホームページのメインクエリから現在の投稿を除外するために、the_ID() 関数を使用しています。

この関数のアクションでの使用可能性

アクション	使用可能性
mu_plugin_loaded
registered_post_type
plugins_loaded
wp_roles_init
setup_theme
after_setup_theme
set_current_user
init
register_sidebar
wp_loaded
send_headers
parse_query
pre_get_posts	〇
wp
template_redirect
get_header
wp_head

非推奨または削除されたバージョン

特に非推奨または削除されたバージョンはありません。