in_the_loop() – Function | Developer.WordPress.org

Determines whether the caller is in the Loop.

Description

For more information on this and similar theme functions, check out the Conditional Tags article in the Theme Developer Handbook.

Return

bool True if caller is within loop, false if loop hasn’t started or ended.

Source

function in_the_loop() {
	global $wp_query;

	if ( ! isset( $wp_query ) ) {
		return false;
	}

	return $wp_query->in_the_loop;
}

View all references View on Trac View on GitHub

Used byDescription
wp_get_loading_optimization_attributes()wp-includes/media.php

Gets loading optimization attributes.

wp_get_loading_attr_default()wp-includes/deprecated.php

Gets the default value to use for a loading attribute on an element.

get_the_post_thumbnail()wp-includes/post-thumbnail-template.php

Retrieves the post thumbnail.

Changelog

VersionDescription
2.0.0Introduced.

User Contributed Notes

  1. Skip to note 2 content

    Modify Single Post Entry Titles

    For use in your functions file, this code example enables you to modify the default output of your entry titles.

    function wpdocs_modify_single_post_entry_titles( $title ) {
    
    	if ( is_singular( 'post' ) && in_the_loop() ) {
    		/* Modify $title */
    	}
    
    	return $title;
    }
    add_filter( 'the_title', 'wpdocs_modify_single_post_entry_titles' );