阐述 WordPress `_doing_ajax()` 函数的源码：如何判断当前请求是否为 AJAX。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位观众，大家好！我是今天的主讲人，咱们今天要聊聊 WordPress 里一个挺有意思的小函数——_doing_ajax()。别看它名字短，作用可不小，它专门负责鉴定，看看当前的请求是不是 AJAX 请求。在 WordPress 的世界里， AJAX 可是个劳模，很多动态操作都得靠它。所以，准确判断是否 AJAX 请求，对于插件和主题开发来说，那是相当重要。好了，废话不多说，咱们这就开始扒一扒 _doing_ajax() 的源码，看看它到底是怎么工作的。

1. _doing_ajax() 的源码剖析

首先，让我们祭出 _doing_ajax() 函数的源码：

<?php
/**
 * Returns whether we are doing Ajax.
 *
 * @since 2.5.0
 *
 * @return bool True if doing Ajax, false if not.
 */
function _doing_ajax() {
    /**
     * Filters whether the current request is an Ajax request.
     *
     * @since 3.0.0
     *
     * @param bool $doing_ajax Whether the current request is an Ajax request.
     */
    return apply_filters( 'doing_ajax', defined( 'DOING_AJAX' ) && DOING_AJAX );
}

这段代码看起来很简单，只有几行。但麻雀虽小，五脏俱全，我们来逐行分析：

/** ... */：这是函数的 DocBlock 注释，用于说明函数的作用、版本和返回值。良好的注释习惯，是成为优秀程序员的必备技能。
function _doing_ajax() { ... }：定义了一个名为 _doing_ajax() 的函数，它不接受任何参数。
return apply_filters( 'doing_ajax', defined( 'DOING_AJAX' ) && DOING_AJAX );：这是最核心的一行代码，它做了两件事：
- defined( 'DOING_AJAX' ) && DOING_AJAX：首先，它检查是否定义了名为 DOING_AJAX 的常量，并且该常量的值是否为 true。如果两者都满足，则返回 true，否则返回 false。
- apply_filters( 'doing_ajax', ... )：然后，它使用 apply_filters() 函数，允许其他插件或主题通过 doing_ajax 过滤器来修改 _doing_ajax() 函数的返回值。这是一个非常重要的机制，它提供了极大的灵活性。

2. DOING_AJAX 常量：背后的功臣

从上面的源码分析可以看出，_doing_ajax() 函数的核心在于检查 DOING_AJAX 常量是否已定义且为 true。那么，这个 DOING_AJAX 常量是在哪里定义的呢？

通常，DOING_AJAX 常量是在 WordPress 处理 AJAX 请求的入口文件中定义的，例如 wp-admin/admin-ajax.php。让我们来看一下 admin-ajax.php 文件中相关代码的简化版本：

<?php
/**
 * WordPress Ajax Process Execution.
 *
 * @package WordPress
 * @subpackage Administration
 *
 * @link https://codex.wordpress.org/AJAX_in_Plugins
 */

/**
 * Executing Ajax will use several functions, so these files must be included.
 */
define( 'DOING_AJAX', true ); // 这里定义了 DOING_AJAX 常量
if ( ! defined( 'WP_ADMIN' ) ) {
    define( 'WP_ADMIN', true );
}

/** Load WordPress Bootstrap */
require_once( dirname( __FILE__ ) . '/admin.php' );

/** Load Ajax Handlers */
require_once( ABSPATH . 'wp-admin/includes/ajax-actions.php' );

// ... 更多代码 ...

可以看到，在 admin-ajax.php 文件的开头，就定义了 DOING_AJAX 常量，并将其设置为 true。这就告诉 WordPress，当前正在处理一个 AJAX 请求。

3. apply_filters()：灵活的后门

apply_filters() 函数是 WordPress 中一个非常强大的工具，它允许插件和主题修改 WordPress 的核心行为。在 _doing_ajax() 函数中，apply_filters( 'doing_ajax', ... ) 允许插件和主题通过 doing_ajax 过滤器来修改 _doing_ajax() 函数的返回值。

这有什么用呢？举个例子：

场景 1：自定义 AJAX 请求处理 假设你有一个自定义的 AJAX 请求处理程序，它不使用 admin-ajax.php 文件。在这种情况下，你可以使用 doing_ajax 过滤器，手动将 _doing_ajax() 函数的返回值设置为 true。
场景 2：模拟 AJAX 请求 在单元测试中，你可能需要模拟 AJAX 请求。你可以使用 doing_ajax 过滤器，强制 _doing_ajax() 函数返回 true，以便测试你的代码在 AJAX 环境下的行为。

让我们来看一个使用 doing_ajax 过滤器的例子：

<?php
add_filter( 'doing_ajax', 'my_custom_doing_ajax' );

function my_custom_doing_ajax( $doing_ajax ) {
    // 检查是否满足自定义的 AJAX 请求条件
    if ( isset( $_GET['my_custom_ajax'] ) && $_GET['my_custom_ajax'] == 'true' ) {
        return true; // 如果是自定义 AJAX 请求，则返回 true
    }

    return $doing_ajax; // 否则，返回原始值
}

在这个例子中，我们定义了一个名为 my_custom_doing_ajax() 的函数，它接受一个参数 $doing_ajax，表示 _doing_ajax() 函数的原始返回值。然后，我们检查 $_GET 数组中是否有一个名为 my_custom_ajax 的参数，并且该参数的值是否为 true。如果是，则返回 true，否则返回原始值。

通过这种方式，我们可以根据自定义的条件来判断是否为 AJAX 请求，从而实现更灵活的控制。

4. 使用 _doing_ajax() 函数

现在，我们已经了解了 _doing_ajax() 函数的源码和工作原理。那么，我们该如何在实际开发中使用它呢？

其实很简单，只需要在你的代码中调用 _doing_ajax() 函数即可。例如：

<?php
if ( _doing_ajax() ) {
    // 如果是 AJAX 请求，则执行 AJAX 相关的操作
    echo 'This is an AJAX request.';
} else {
    // 如果不是 AJAX 请求，则执行其他操作
    echo 'This is not an AJAX request.';
}

在这个例子中，我们使用 _doing_ajax() 函数来判断当前请求是否为 AJAX 请求。如果是，则输出 "This is an AJAX request."，否则输出 "This is not an AJAX request."。

5. 为什么要用 _doing_ajax() 而不是直接检查 DOING_AJAX 常量？

你可能会问，既然 _doing_ajax() 函数的核心是检查 DOING_AJAX 常量，那为什么我们不直接检查 DOING_AJAX 常量呢？

原因有以下几点：

封装性：_doing_ajax() 函数提供了一层封装，使得我们可以更容易地判断是否为 AJAX 请求，而无需关心底层的实现细节。
灵活性：_doing_ajax() 函数使用了 apply_filters() 函数，允许插件和主题修改其返回值，从而提供了更大的灵活性。如果我们直接检查 DOING_AJAX 常量，就无法实现这种灵活性。
可维护性：如果 WordPress 的底层实现发生了变化，例如不再使用 DOING_AJAX 常量来判断是否为 AJAX 请求，那么我们只需要修改 _doing_ajax() 函数的实现即可，而无需修改所有调用它的代码。

6. 总结：_doing_ajax() 的价值

_doing_ajax() 函数虽然简单，但却非常实用。它可以帮助我们准确判断当前请求是否为 AJAX 请求，从而实现更灵活和可维护的代码。掌握 _doing_ajax() 函数的源码和使用方法，对于 WordPress 插件和主题开发来说，是非常重要的。

为了方便大家理解，我把 _doing_ajax() 函数的要点总结成一个表格：

特性	描述
函数名	`_doing_ajax()`
作用	判断当前请求是否为 AJAX 请求。
返回值	`true` (如果是 AJAX 请求) 或 `false` (如果不是 AJAX 请求)。
核心实现	检查 `DOING_AJAX` 常量是否已定义且为 `true`。
灵活性	使用 `apply_filters( 'doing_ajax', ... )` 函数，允许插件和主题通过 `doing_ajax` 过滤器来修改返回值。
使用场景	在插件和主题开发中，根据是否为 AJAX 请求，执行不同的操作。例如，只在 AJAX 请求时才返回 JSON 数据。
优点	封装性、灵活性、可维护性。
注意事项	`DOING_AJAX` 常量通常在 `wp-admin/admin-ajax.php` 文件中定义。如果使用自定义的 AJAX 请求处理程序，可能需要手动设置 `_doing_ajax()` 函数的返回值。

7. 进阶思考：除了 _doing_ajax()，还有其他判断 AJAX 请求的方法吗？

除了 _doing_ajax() 函数，还有一些其他的方法可以用来判断 AJAX 请求，例如：

检查 HTTP 请求头： AJAX 请求通常会设置一个 X-Requested-With HTTP 请求头，其值为 XMLHttpRequest。我们可以通过检查这个请求头来判断是否为 AJAX 请求。但是，这种方法并不完全可靠，因为客户端可以伪造这个请求头。

<?php
if ( isset( $_SERVER['HTTP_X_REQUESTED_WITH'] ) && strtolower( $_SERVER['HTTP_X_REQUESTED_WITH'] ) == 'xmlhttprequest' ) {
    // 这是 AJAX 请求
    echo 'This is an AJAX request (based on HTTP header).';
} else {
    // 这不是 AJAX 请求
    echo 'This is not an AJAX request (based on HTTP header).';
}

检查 $_REQUEST 数组：我们可以检查 $_REQUEST 数组中是否包含特定的参数，这些参数通常只会在 AJAX 请求中出现。但是，这种方法也不太可靠，因为不同的 AJAX 请求可能会使用不同的参数。

<?php
if ( isset( $_REQUEST['action'] ) && $_REQUEST['action'] == 'my_ajax_action' ) {
    // 这很可能是一个 AJAX 请求
    echo 'This is likely an AJAX request (based on $_REQUEST).';
} else {
    // 这可能不是 AJAX 请求
    echo 'This may not be an AJAX request (based on $_REQUEST).';
}

总的来说，_doing_ajax() 函数是判断 AJAX 请求最可靠和推荐的方法，因为它是由 WordPress 核心提供的，并且考虑到了各种情况。

8. 总结的总结

好了，今天的讲座就到这里。希望通过今天的讲解，大家对 WordPress 的 _doing_ajax() 函数有了更深入的了解。记住，理解源码是成为优秀程序员的关键。以后遇到类似的问题，就可以自己动手，丰衣足食了！谢谢大家！

发表回复 取消回复

发表回复取消回复