get_the_ID()

Retrieve the ID of the current item in the WordPress Loop.

Contents

Return Return

(int|false) The ID of the current item in the WordPress Loop. False if $post is not set.

Top ↑

Source Source

File: wp-includes/post-template.php 

function get_the_ID() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
	$post = get_post();
	return ! empty( $post ) ? $post->ID : false;
}

Expand full source code Collapse full source code View on Trac

Top ↑

Uses Uses

Uses
Uses Description
wp-includes/post.php: get_post()

Retrieves post data given a post ID or post object.

Top ↑

Used By Used By

Used By
Used By Description
wp-admin/includes/dashboard.php: wp_dashboard_recent_posts()

Generates Publishing Soon and Recently Published sections.
wp-includes/general-template.php: wp_get_archives()

Display archive links based on type and format.
wp-includes/link-template.php: get_post_comments_feed_link()

Retrieves the permalink for the post comments feed.
wp-includes/post-template.php: prepend_attachment()

Wrap attachment in paragraph tag before content.
wp-includes/post-template.php: the_ID()

Display the ID of the current item in the WordPress Loop.
wp-includes/media.php: wp_video_shortcode()

Builds the Video shortcode output.
wp-includes/media.php: wp_audio_shortcode()

Builds the Audio shortcode output.
wp-includes/post.php: is_sticky()

Determines whether a post is sticky.
wp-includes/post.php: get_post_custom()

Retrieve post meta fields, based on post ID.
wp-includes/comment-template.php: get_comment_id_fields()

Retrieves hidden input HTML for replying to comments.
wp-includes/comment-template.php: wp_list_comments()

Displays a list of comments.
wp-includes/comment-template.php: comment_form()

Outputs a complete commenting form for use within a template.
wp-includes/comment-template.php: get_trackback_url()

Retrieves the current post’s trackback URL.
wp-includes/comment-template.php: comments_popup_link()

Displays the link to the comments for the current post ID.
Show 9 more used by Hide more used by

Top ↑

Changelog Changelog

Changelog
Version Description
2.1.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 9You must log in to vote on the helpfulness of this note
    Contributed by Craigbavender —

    Should be noted that if this is ran on the Blog homepage, it instead returns the first listed Post ID instead of the blog homepage ID.

  2. Skip to note 2 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 8You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Post Anchor Identifier
    get_the_ID() can be used to provide a unique anchor in a script. For instance, a dynamically-generated drop down menu with actions for each post in an archive could have

    <?php
	$id = get_the_ID();
	$dropdown = "<select name='dropdown-".$id."' >";
	$dropdown .= "<option id='option1-". $id ."'>Option 1</option>";
	$dropdown .= "</select>";
?>

    This would allow us to use JavaScript to control the element as it has a unique ID, and when submitting it as a form through the POST or GET methods the dropdown box will be sent with a unique ID which allows the script to note which post it is working on. Alternatively a hidden variable could be sent which will allow the script to see which post the submission is referring to

    <?php
	echo '<input type="hidden" name="activepost" id="activepost" value="'.get_the_ID().'" />';
?>

You must log in before being able to contribute a note or feedback.