阐述 WordPress `get_children()` 函数的源码：如何通过 `WP_Query` 查询文章的子文章或附件。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位观众老爷，大家好！今天咱们来聊聊 WordPress 中那个“找娃神器”—— get_children() 函数。这玩意儿可不是真让你去找孩子，而是帮你找文章的子文章或者附件。别看它名字简单，背后可藏着一些 WordPress 的核心机制。今天我们就扒一扒它的源码，看看它到底是怎么“寻亲”的。

开场白：get_children() 是个啥？

简单来说，get_children() 函数可以根据父文章的 ID，找到它的所有子文章或者附件。这在很多场景下都很有用，比如：

展示文章的导航结构（例如，文章的章节）。
列出附件，比如图片、PDF 文档等等。
构建复杂的文章关系。

源码解读：一步一步揭开它的面纱

get_children() 函数位于 wp-includes/post.php 文件中。我们先来看看它的基本结构：

function get_children( $args = '', $output = OBJECT ) {
    global $wpdb;

    $defaults = array(
        'numberposts'      => -1,
        'post_status'      => 'any',
        'post_type'        => 'any',
        'post_parent'      => 0,
        'author'           => '',
        'orderby'          => 'menu_order ASC, post_title ASC, post_date ASC',
        'order'            => 'ASC',
        'exclude'          => '',
        'include'          => '',
        'meta_key'         => '',
        'meta_value'       => '',
        'meta_query'       => '',
        'suppress_filters' => true,
        'update_post_term_cache' => false,
        'update_post_meta_cache' => false,
    );

    $r = wp_parse_args( $args, $defaults );

    if ( isset( $r['parent'] ) ) {
        $r['post_parent'] = $r['parent'];
    }

    if ( isset( $r['post_parent'] ) && 0 === intval( $r['post_parent'] ) ) {
        unset( $r['post_parent'] );
    }

    $key = md5( serialize( $r ) . $output );
    $last_changed = wp_cache_get_last_changed( 'posts' );

    $cache_key = "get_children:$key:$last_changed";
    $children = wp_cache_get( $cache_key, 'posts' );

    if ( false === $children ) {
        $children = get_posts( $r );

        if ( ! is_array( $children ) ) {
            $children = array();
        }

        wp_cache_set( $cache_key, $children, 'posts' );
    }

    if ( $output == OBJECT ) {
        return $children;
    } elseif ( $output == ARRAY_A ) {
        $results = array();
        foreach ( (array) $children as $child ) {
            $results[$child->ID] = get_object_vars( $child );
        }
        return $results;
    } elseif ( $output == ARRAY_N ) {
        $results = array();
        foreach ( (array) $children as $child ) {
            $results[$child->ID] = array_values( get_object_vars( $child ) );
        }
        return $results;
    } else {
        return $children;
    }
}

看起来有点长，但别怕，我们慢慢拆解。

1. 参数处理：wp_parse_args() 和默认值

$defaults = array(
    'numberposts'      => -1,
    'post_status'      => 'any',
    'post_type'        => 'any',
    'post_parent'      => 0,
    'author'           => '',
    'orderby'          => 'menu_order ASC, post_title ASC, post_date ASC',
    'order'            => 'ASC',
    'exclude'          => '',
    'include'          => '',
    'meta_key'         => '',
    'meta_value'       => '',
    'meta_query'       => '',
    'suppress_filters' => true,
    'update_post_term_cache' => false,
    'update_post_meta_cache' => false,
);

$r = wp_parse_args( $args, $defaults );

这里定义了一堆默认参数，并使用 wp_parse_args() 函数将传入的参数与默认参数合并。wp_parse_args() 是 WordPress 中一个非常常用的函数，它能确保你的参数数组中包含所有需要的键，即使你只传入了部分参数。

参数名	默认值	含义
`numberposts`	`-1`	要获取的文章数量，`-1` 表示获取所有文章。
`post_status`	`any`	文章状态，可以是 `publish`、`draft`、`pending`、`private`、`trash` 或 `any`。
`post_type`	`any`	文章类型，可以是 `post`、`page`、`attachment` 或自定义文章类型。
`post_parent`	`0`	父文章的 ID，`0` 表示没有父文章的文章。
`author`	`''`	作者的 ID 或用户名。
`orderby`	`'menu_order ASC, post_title ASC, post_date ASC'`	排序方式。
`order`	`ASC`	排序方向，可以是 `ASC`（升序）或 `DESC`（降序）。
`exclude`	`''`	要排除的文章 ID，多个 ID 用逗号分隔。
`include`	`''`	要包含的文章 ID，多个 ID 用逗号分隔。
`meta_key`	`''`	自定义字段的键名。
`meta_value`	`''`	自定义字段的值。
`meta_query`	`''`	用于构建复杂自定义字段查询的数组。
`suppress_filters`	`true`	是否禁用 WordPress 的过滤器。
`update_post_term_cache`	`false`	是否更新文章的分类和标签缓存。
`update_post_meta_cache`	`false`	是否更新文章的自定义字段缓存。

2. 别名处理：parent 到 post_parent

if ( isset( $r['parent'] ) ) {
    $r['post_parent'] = $r['parent'];
}

if ( isset( $r['post_parent'] ) && 0 === intval( $r['post_parent'] ) ) {
    unset( $r['post_parent'] );
}

这里做了一个小小的兼容性处理。如果你传入的参数是 parent 而不是 post_parent，它会自动将 parent 的值赋给 post_parent。另外，如果 post_parent 的值为 0，它会被 unset，这表示要查询所有没有父文章的文章。

3. 缓存机制：提高性能的关键

$key = md5( serialize( $r ) . $output );
$last_changed = wp_cache_get_last_changed( 'posts' );

$cache_key = "get_children:$key:$last_changed";
$children = wp_cache_get( $cache_key, 'posts' );

if ( false === $children ) {
    $children = get_posts( $r );

    if ( ! is_array( $children ) ) {
        $children = array();
    }

    wp_cache_set( $cache_key, $children, 'posts' );
}

这段代码使用了 WordPress 的对象缓存 API 来提高性能。它首先根据参数和输出类型生成一个唯一的缓存键，然后尝试从缓存中获取结果。如果缓存中没有结果，它才会调用 get_posts() 函数来查询数据库，并将结果存入缓存。下次再用相同的参数调用 get_children() 时，就可以直接从缓存中获取结果，避免重复查询数据库。

wp_cache_get_last_changed('posts'): 获取 posts 组的最后修改时间。这确保了缓存是最新的。
wp_cache_get($cache_key, 'posts'): 尝试从 posts 组中获取缓存数据。
wp_cache_set($cache_key, $children, 'posts'): 将查询结果存入 posts 组中。

4. 核心查询：get_posts() 函数

$children = get_posts( $r );

这里是整个函数的核心部分。get_posts() 函数是 WordPress 中用于查询文章的底层函数，它会根据传入的参数构建 SQL 查询语句，并从数据库中获取文章数据。get_children() 函数实际上只是 get_posts() 函数的一个封装，它预设了一些参数，比如 post_parent，方便你查询子文章。

5. 输出格式：OBJECT、ARRAY_A 和 ARRAY_N

if ( $output == OBJECT ) {
    return $children;
} elseif ( $output == ARRAY_A ) {
    $results = array();
    foreach ( (array) $children as $child ) {
        $results[$child->ID] = get_object_vars( $child );
    }
    return $results;
} elseif ( $output == ARRAY_N ) {
    $results = array();
    foreach ( (array) $children as $child ) {
        $results[$child->ID] = array_values( get_object_vars( $child ) );
    }
    return $results;
} else {
    return $children;
}

这段代码根据你指定的输出格式，将查询结果转换成不同的形式。

OBJECT：返回一个包含 WP_Post 对象的数组。这是默认的输出格式。
ARRAY_A：返回一个关联数组，数组的键是文章 ID，值是包含文章属性的关联数组。
ARRAY_N：返回一个索引数组，数组的键是文章 ID，值是包含文章属性的索引数组。

深入 get_posts()：WP_Query 的幕后英雄

get_posts() 函数的内部实际上使用了 WP_Query 类。WP_Query 是 WordPress 中最强大的查询类，它可以根据各种条件查询文章、页面、自定义文章类型等等。我们来看看 get_posts() 函数的源码：

function get_posts( $args = null ) {
    $defaults = array(
        'numberposts' => 5,
        'offset'      => 0,
        'category'    => 0,
        'orderby'     => 'post_date',
        'order'       => 'DESC',
        'include'     => array(),
        'exclude'     => array(),
        'meta_key'    => '',
        'meta_value'  => '',
        'post_type'   => 'post',
        'suppress_filters' => true,
    );

    $r = wp_parse_args( $args, $defaults );
    extract( $r, EXTR_SKIP );

    $get_posts = new WP_Query( $r );

    return $get_posts->posts;
}

可以看到，get_posts() 函数首先定义了一堆默认参数，然后使用 wp_parse_args() 函数将传入的参数与默认参数合并。接着，它创建了一个 WP_Query 对象，并将参数传递给它。最后，它返回 WP_Query 对象的 posts 属性，这个属性包含了查询到的文章数据。

WP_Query 的秘密武器：构建 SQL 查询

WP_Query 类内部会根据传入的参数构建复杂的 SQL 查询语句。例如，如果你指定了 post_parent 参数，WP_Query 类会在 SQL 查询语句中添加 WHERE post_parent = ... 这样的条件。

让我们看一个例子。假设我们要查询父文章 ID 为 123 的所有子文章，我们可以这样调用 get_children() 函数：

$children = get_children( array( 'post_parent' => 123 ) );

get_children() 函数会将这个参数传递给 get_posts() 函数，get_posts() 函数又会将参数传递给 WP_Query 类。WP_Query 类会构建如下的 SQL 查询语句（简化版）：

SELECT * FROM wp_posts WHERE post_parent = 123 AND post_type IN ('post', 'page', 'attachment') AND post_status = 'publish'

这个 SQL 查询语句会从 wp_posts 表中选择所有 post_parent 为 123，post_type 为 post、page 或 attachment，且 post_status 为 publish 的文章。

自定义查询：meta_query 和其他高级用法

get_children() 函数和 get_posts() 函数都支持很多高级用法，比如使用 meta_query 参数构建复杂的自定义字段查询。meta_query 参数允许你指定多个自定义字段的条件，并将它们组合起来进行查询。

例如，假设我们要查询父文章 ID 为 123，且自定义字段 color 的值为 red 的所有子文章，我们可以这样调用 get_children() 函数：

$children = get_children( array(
    'post_parent' => 123,
    'meta_query'  => array(
        array(
            'key'     => 'color',
            'value'   => 'red',
            'compare' => '=',
        ),
    ),
) );

这段代码中，我们使用 meta_query 参数指定了一个自定义字段的条件。key 参数指定了自定义字段的键名，value 参数指定了自定义字段的值，compare 参数指定了比较运算符。在这个例子中，我们使用了 = 运算符，表示要查询 color 字段的值等于 red 的文章。

参数名	含义
`key`	自定义字段的键名。
`value`	自定义字段的值。可以是单个值，也可以是数组。
`compare`	比较运算符，可以是 `=`、`!=`、`>`、`<`、`>=`、`<=`、`LIKE`、`NOT LIKE`、`IN`、`NOT IN`、`BETWEEN`、`NOT BETWEEN`、`REGEXP`、`NOT REGEXP`、`RLIKE`。
`type`	自定义字段值的类型，可以是 `NUMERIC`、`BINARY`、`CHAR`、`DATE`、`DATETIME`、`DECIMAL`、`SIGNED`、`TIME`、`UNSIGNED`。

你还可以使用多个 meta_query 数组来构建更复杂的查询。例如，假设我们要查询父文章 ID 为 123，且自定义字段 color 的值为 red 或 blue 的所有子文章，我们可以这样调用 get_children() 函数：

$children = get_children( array(
    'post_parent' => 123,
    'meta_query'  => array(
        'relation' => 'OR',
        array(
            'key'     => 'color',
            'value'   => 'red',
            'compare' => '=',
        ),
        array(
            'key'     => 'color',
            'value'   => 'blue',
            'compare' => '=',
        ),
    ),
) );

这段代码中，我们使用了 relation 参数指定了多个 meta_query 数组之间的关系。relation 参数可以是 AND 或 OR。在这个例子中，我们使用了 OR 运算符，表示要查询 color 字段的值等于 red 或 blue 的文章。

实战演练：构建一个简单的文章导航

现在，让我们用 get_children() 函数来构建一个简单的文章导航。假设我们有一篇文章，它的 ID 为 1，它有三个子文章，它们的标题分别为“第一章”、“第二章”和“第三章”。我们可以在文章的模板文件中添加如下代码：

<?php
$children = get_children( array( 'post_parent' => get_the_ID(), 'post_type' => 'any', 'post_status' => 'publish', 'orderby' => 'menu_order', 'order' => 'ASC' ) );

if ( $children ) {
    echo '<ul>';
    foreach ( $children as $child ) {
        echo '<li><a href="' . get_permalink( $child->ID ) . '">' . esc_html( $child->post_title ) . '</a></li>';
    }
    echo '</ul>';
}
?>

这段代码首先使用 get_children() 函数查询当前文章的所有子文章。然后，它遍历子文章数组，并输出一个包含子文章标题和链接的 HTML 列表。get_the_ID() 获取当前文章的ID。get_permalink( $child->ID ) 获取子文章的链接。esc_html( $child->post_title ) 对子文章的标题进行 HTML 转义，以防止 XSS 攻击。

总结：get_children() 的强大之处

总而言之，get_children() 函数是一个非常方便的函数，它可以帮助你轻松地查询文章的子文章或附件。它实际上是对 get_posts() 函数的封装，而 get_posts() 函数又使用了 WP_Query 类来构建 SQL 查询语句。通过理解 get_children() 函数的源码，你可以更好地掌握 WordPress 的查询机制，并构建更复杂的文章关系。记住，合理利用缓存可以显著提高性能。希望今天的讲解对你有所帮助！感谢各位的观看！

发表回复 取消回复

发表回复取消回复