使用 get_defined_constants(true)['user'] 快速定位自定义常量

M66 2025-05-26

在 PHP 中，常量（constant）是一种用于定义在脚本执行期间不可更改的标识符。通常，我们通过 define() 或 const 关键字来定义常量。但有时在开发或调试过程中，我们需要查看当前脚本或应用中都定义了哪些常量。此时，PHP 内置函数 get_defined_constants() 就派上用场了。

这个函数可以以两种方式使用：

get_defined_constants()：返回一个关联数组，包含所有已定义的常量。
get_defined_constants(true)：返回一个多维数组，将常量按其来源分组，例如 internal（内部）、user（用户自定义）等。

本文将聚焦于 get_defined_constants(true)['user']，即查看所有用户自定义的常量。

示例：获取用户自定义常量

<?php

define('SITE_NAME', '示例网站');
define('BASE_URL', 'https://m66.net');

$user_constants = get_defined_constants(true)['user'];

echo '<pre>';
print_r($user_constants);
echo '</pre>';

运行以上代码后，输出类似如下：

Array
(
    [SITE_NAME] => 示例网站
    [BASE_URL] => https://m66.net
)

我们可以看到，只有我们通过 define() 明确声明的常量会出现在 user 这一组中。PHP 内部默认定义的常量（如 E_ALL、PHP_VERSION 等）不会包含在内。

用途场景

1. 调试用户常量

在大型项目中，常量定义可能分布在多个文件中。使用 get_defined_constants(true)['user'] 可以快速列出当前环境中所有自定义常量，帮助开发者确认是否某个常量被重复定义、覆盖或拼写错误。

2. 构建常量导出工具

在一些配置管理系统中，我们可能希望将所有自定义常量导出成 JSON 或其他格式保存。配合 json_encode()，这一功能很容易实现。

<?php

define('API_URL', 'https://m66.net/api');
define('VERSION', '1.0.0');

$user_constants = get_defined_constants(true)['user'];

header('Content-Type: application/json');
echo json_encode($user_constants, JSON_PRETTY_PRINT);

输出：

{
    "API_URL": "https://m66.net/api",
    "VERSION": "1.0.0"
}

3. 与框架或插件集成

在一些自定义插件或框架中，我们可能希望插件注册时能自动识别当前环境的常量配置。通过这个函数，可以无侵入地获取所有已定义常量并进行业务逻辑处理或兼容性检查。

注意事项

只有通过 define() 或 const 明确声明的常量会被归类到 user。
如果使用了第三方库，其在初始化时定义的常量也会被视为用户常量。
不建议在生产环境中频繁调用此函数输出结果，尤其是将其内容暴露给用户，因为可能包含敏感配置信息。

小结

get_defined_constants(true)['user'] 是一个非常实用的调试和配置辅助工具。在需要审查当前自定义常量的场景下，它提供了简单而直观的接口。无论是输出日志、生成配置快照，还是进行兼容性检查，它都是值得掌握的利器。