get_the_ID(): int|false
- Since
- 2.1.0
- Source
wp-includes/post-template.php:27
Compatibility
- WordPress
- since 2.1.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Return value
int|false- The ID of the current item in the WordPress Loop. False if $post is not set.
Performance profile
How much work a call to get_the_ID() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Heavy
- Scaling
- Constant
- Instructions
- 6–7
- Plugin surface
- None
- Called by
- 26
Reaches the database via get_post().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 8.
Nothing here hands control to plugin code.
26 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- querycontent query
get_post()called directly
Further down the call graph this can also reach hook, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost get_the_ID() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 6–7 | get_post() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 8 instructions, 6–7 executed per call, 1 branch. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 1
- get_post()Retrieves post data given a post ID or post object.
Used by · 26
- Twenty_Fourteen_Ephemera_Widget::widget()Outputs the HTML for this widget.
- comments_popup_link()Displays the link to the comments for the current post ID.
- get_post_comments_feed_link()Retrieves the permalink for the post comments feed.
- get_post_custom()Retrieves post meta fields, based on post ID.
- get_trackback_url()Retrieves the current post's trackback URL.
- is_sticky()Determines whether a post is sticky.
- prepend_attachment()Wraps attachment in paragraph tag before content.
- print_embed_sharing_dialog()Prints the necessary markup for the embed sharing dialog.
- render_block_core_post_template()Renders the `core/post-template` block on the server.
- the_ID()Displays the ID of the current item in the WordPress Loop.
- twenty_twenty_one_continue_reading_link()Creates the continue reading link.
- twentyeleven_get_gallery_images()Retrieves the IDs for images in a gallery.
Show all 26
- twentyfifteen_excerpt_more()Replaces "[.
- twentyfourteen_excerpt_more()Replaces "[.
- twentynineteen_excerpt_more()Replaces "[.
- twentynineteen_get_discussion_data()Returns information about the current post's discussion, with cache support.
- twentyseventeen_excerpt_more()Replaces "[.
- twentysixteen_excerpt_more()Replaces "[.
- twentyten_get_gallery_images()Retrieves the IDs for images in a gallery.
- twentythirteen_excerpt_more()Replaces "[.
- twentytwenty_read_more_tag()Overwrite default more tag with styling and screen reader markup.
- wp_audio_shortcode()Builds the Audio shortcode output.
- wp_dashboard_recent_posts()Generates Publishing Soon and Recently Published sections.
- wp_get_archives()Displays archive links based on type and format.
- wp_list_comments()Displays a list of comments.
- wp_video_shortcode()Builds the Video shortcode output.
Source code
function get_the_ID() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid $post = get_post(); return ! empty( $post ) ? $post->ID : false;}Changelog
Introduced in 2.1.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.9.7 tag, from
src/wp-includes/post-template.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.