get_the_ID(): int|false

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

Contents

Return
Source
Related
- Uses
- Used By
Changelog
User Contributed Notes
- Feedback

Return

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

Source

File: wp-includes/post-template.php. View all references

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

View on Trac View on GitHub

Uses

Uses
Uses	Description
get_post() wp-includes/post.php	Retrieves post data given a post ID or post object.

Used By

Used By
Used By	Description
print_embed_sharing_dialog() wp-includes/embed.php	Prints the necessary markup for the embed sharing dialog.
wp_dashboard_recent_posts() wp-admin/includes/dashboard.php	Generates Publishing Soon and Recently Published sections.
wp_get_archives() wp-includes/general-template.php	Displays archive links based on type and format.
get_post_comments_feed_link() wp-includes/link-template.php	Retrieves the permalink for the post comments feed.
prepend_attachment() wp-includes/post-template.php	Wraps attachment in paragraph tag before content.
the_ID() wp-includes/post-template.php	Displays the ID of the current item in the WordPress Loop.
wp_video_shortcode() wp-includes/media.php	Builds the Video shortcode output.
wp_audio_shortcode() wp-includes/media.php	Builds the Audio shortcode output.
is_sticky() wp-includes/post.php	Determines whether a post is sticky.
get_post_custom() wp-includes/post.php	Retrieves post meta fields, based on post ID.
get_comment_id_fields() wp-includes/comment-template.php	Retrieves hidden input HTML for replying to comments.
wp_list_comments() wp-includes/comment-template.php	Displays a list of comments.
get_trackback_url() wp-includes/comment-template.php	Retrieves the current post’s trackback URL.
comments_popup_link() wp-includes/comment-template.php	Displays the link to the comments for the current post ID.

Show 9 more used by Hide more used by

Changelog

Changelog
Version	Description
2.1.0	Introduced.

User Contributed Notes

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 — 6 years ago

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.
Top ↑
Feedback
- If you are looking for conditional checks (i.e. if its this page, do this), is_single() checks if its the single post version of an ID. There are also other for homepage, page, etc. Check the other conditionals for others: https://codex.wordpress.org/Conditional_Tags — By michaeldhayes — 2 years ago
Log in to add feedback
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 — 7 years ago
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().'" />';
?>
```
Log in to add feedback
Skip to note 3 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 Joy Chetry — 3 years ago
In some cases, such as when you’re outside The Loop, you may need to use
get_queried_object_id() instead of get_the_ID().
```
$postID = get_queried_object_id();
```
Log in to add feedback
Skip to note 4 content

You must log in to vote on the helpfulness of this noteVote results for this note: -1You must log in to vote on the helpfulness of this note

Contributed by Codex — 7 years ago
Store the ID
The ID can be stored as a variable using
```
<?php $postid = get_the_ID(); ?>
```
Log in to add feedback

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