PHP：添加数组元素的引用问题及新分类元素添加失败排查

需求与问题 #

已有从数据库加载的$results变量，需要将其整理为按分类分组的数组，目标格式如下：

[
    {
        "category": "categoryName",
        "elements": [
            { 
                 "id": 1,
                 "name": "elementName"
            }
            ...
        ]
    },
    ...
]

编写了如下代码实现，但遇到问题：当创建新分类（进入is_null($category)分支）时，元素并未被添加到分类的elements数组中，猜测是引用不一致导致的，希望找到无需重复遍历数组的解决方法：

$response_data = [];

foreach ($results as $result) {
        
    $category = null;
    foreach ($response_data as &$data) {
        if ($data["category"] === $result->slug) {
            $category = &$data;
            break;
        }
    }

    if (is_null($category)) {
        $category = [ "category" => $result->slug, "elements" => [] ];
        $response_data[] = $category;
    }

    $category["elements"][] = [
        "id" => $result->post_id,
        "src" => $result->meta_value
    ];

    unset($category);
}

return $response_data;

原因分析与解决方法 #

问题根源 #

当你创建新分类并执行$response_data[] = $category时，$category是值传递而非引用传递——数组被复制后存入$response_data，后续修改$category["elements"]只是修改了临时变量，并不会同步到$response_data里的新元素。

最优方案：用分类slug作为数组键（无需遍历查找） #

直接用分类的slug作为$response_data的键，既能快速判断分类是否存在，又完全避免引用问题，代码更简洁高效：

$response_data = [];

foreach ($results as $result) {
    $slug = $result->slug;
    // 分类不存在则初始化
    if (!isset($response_data[$slug])) {
        $response_data[$slug] = [
            "category" => $slug,
            "elements" => []
        ];
    }
    // 直接向对应分类的elements添加元素
    $response_data[$slug]["elements"][] = [
        "id" => $result->post_id,
        "src" => $result->meta_value
    ];
}

// 如果需要最终格式是索引数组而非关联数组，转换一下
return array_values($response_data);

若坚持原结构：获取新添加元素的引用 #

如果必须保持目标的索引数组结构，可以在添加新分类后，直接取数组最后一个元素的引用，这样后续修改就能同步到$response_data中：

$response_data = [];

foreach ($results as $result) {
        
    $category = null;
    foreach ($response_data as &$data) {
        if ($data["category"] === $result->slug) {
            $category = &$data;
            break;
        }
    }
    unset($data); // 解除外层foreach的引用，避免后续意外问题

    if (is_null($category)) {
        // 添加新分类到数组
        $response_data[] = [ "category" => $result->slug, "elements" => [] ];
        // 获取新添加元素的引用
        $category = &$response_data[count($response_data) - 1];
    }

    $category["elements"][] = [
        "id" => $result->post_id,
        "src" => $result->meta_value
    ];

    unset($category);
}

return $response_data;

注意：外层foreach的&$data要记得用unset($data)解除引用，否则后续循环可能出现数据错乱的问题。

内容的提问来源于stack exchange，提问作者Javi Albors