云策 WordPress 开发者社区

函数文档

wp_doing_ajax()

查看官方原文 ↗
💡 云策文档标注

概述

wp_doing_ajax() 函数用于判断当前请求是否为 WordPress Ajax 请求，返回布尔值。它基于 DOING_AJAX 常量定义，并可通过过滤器 wp_doing_ajax 进行自定义。

关键要点

  • 函数返回 true 表示当前是 WordPress Ajax 请求，否则返回 false。
  • 内部实现依赖于 DOING_AJAX 常量，并通过 apply_filters('wp_doing_ajax', ...) 允许开发者过滤结果。
  • 常用于在代码中区分 Ajax 请求和普通请求，以调整输出行为，例如使用 wp_send_json_success() 或直接返回数据。

代码示例

function wpdocs_render() {
    /* ........ SOME LOGIC ....... */
    
    $return_data = array( 'success' => true );
    
    if ( wp_doing_ajax() ) {
        wp_send_json_success( $return_data );
    } else {
        return $return_data;
    }
}
📄 原文内容

Determines whether the current request is a WordPress Ajax request.

Return

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

Source

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 all references View on Trac View on GitHub

Hooks

apply_filters( ‘wp_doing_ajax’, bool $wp_doing_ajax )

Filters whether the current request is a WordPress Ajax request.

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

Calls the callback functions that have been added to a filter hook.
Used by Description
wp_delete_all_temp_backups()wp-includes/update.php

Schedules the removal of all contents in the temporary backup directory.
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

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_Terms_List_Table::column_name()wp-admin/includes/class-wp-terms-list-table.php
WP_Comments_List_Table::prepare_items()wp-admin/includes/class-wp-comments-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

Sets 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 17 moreShow less

Changelog

Version Description
4.7.0 Introduced.

User Contributed Notes

  1. Skip to note 2 content


    Ashwin Parthasarathi


    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

    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;
	}

}