wp_doing_ajax(): bool

Determines whether the current request is a WordPress Ajax request.

Contents

Return

bool True if it's a WordPress Ajax request, false otherwise.

Top ↑

Source

File: wp-includes/load.php. View all references 

function wp_doing_ajax() {
	/**
	 * Filters whether the current request is a WordPress Ajax request.
	 *
	 * @since 4.7.0
	 *
	 * @param bool $wp_doing_ajax Whether the current request is a WordPress Ajax request.
	 */
	return apply_filters( 'wp_doing_ajax', defined( 'DOING_AJAX' ) && DOING_AJAX );
}

View on Trac View on GitHub

Top ↑

Hooks

Top ↑

Top ↑

Uses

Uses
Uses Description
apply_filters() wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.

Top ↑

Used By

Used By
Used By Description
is_protected_endpoint() wp-includes/load.php

Determines whether we are currently on an endpoint that should be protected against WSODs.
is_protected_ajax_action() wp-includes/load.php

Determines whether we are currently handling an Ajax action that should be protected against WSODs.
wp_check_comment_flood() wp-includes/comment.php

Checks whether comment flooding is occurring.
WP_Comments_List_Table::handle_row_actions() wp-admin/includes/class-wp-comments-list-table.php

Generates and displays row actions links.
WP_Terms_List_Table::handle_row_actions() wp-admin/includes/class-wp-terms-list-table.php

Generates and displays row action links.
themes_api() wp-admin/includes/theme.php

Retrieves theme installer pages from the WordPress.org Themes API.
WP_List_Table::set_pagination_args() wp-admin/includes/class-wp-list-table.php

An internal method that sets all the necessary pagination arguments
check_upload_size() wp-admin/includes/ms.php

Determines whether uploaded file exceeds space quota.
wp_dashboard_cached_rss_widget() wp-admin/includes/dashboard.php

Checks to see if all of the feed url in $check_urls are cached.
WP_Comments_List_Table::prepare_items() wp-admin/includes/class-wp-comments-list-table.php
WP_Terms_List_Table::column_name() wp-admin/includes/class-wp-terms-list-table.php
WP_Customize_Manager::doing_ajax() wp-includes/class-wp-customize-manager.php

Returns true if it’s an Ajax request.
_wp_customize_include() wp-includes/theme.php

Includes and instantiates the WP_Customize_Manager class.
check_ajax_referer() wp-includes/pluggable.php

Verifies the Ajax request to prevent processing requests external of the blog.
wp_validate_auth_cookie() wp-includes/pluggable.php

Validates authentication cookie.
wp_debug_mode() wp-includes/load.php

Set PHP error reporting based on WordPress debug settings.
wp_send_json() wp-includes/functions.php

Sends a JSON response back to an Ajax request.
wp_die() wp-includes/functions.php

Kills WordPress execution and displays HTML page with an error message.
WP_Ajax_Response::send() wp-includes/class-wp-ajax-response.php

Display XML formatted responses.
wp_user_settings() wp-includes/option.php

Saves and restores user interface settings stored in a cookie.
wp_allow_comment() wp-includes/comment.php

Validates whether this comment is allowed to be made.
Show 16 more used by Hide more used by

Top ↑

Changelog

Changelog
Version Description
4.7.0 Introduced.

Top ↑

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: 0You must log in to vote on the helpfulness of this note
    Contributed by ashwin.parthasarathi —

    In a PHP code, if we want to differentiate its output behavior based on how it is being called (like a normal function or like a WP AJAX callback), then we should use the wp_doing_ajax() function like below,

    function wpdocs_render() {

	/* ........ SOME LOGIC ....... */
	
	$return_data = array( 'success'  => true );
	
	if ( wp_doing_ajax() ) {
		wp_send_json_success( $return_data );
	} else {
		return $return_data;
	}

}

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