PHP变量作用域详解：避免返回错误陷阱

理解PHP变量作用域

在PHP中，变量的作用域决定了其在代码中的可访问性。主要有两种作用域：

1. 全局作用域 (Global Scope)：在函数外部定义的变量拥有全局作用域。它们可以在脚本的任何地方被访问，但不能在函数内部直接访问。
2. 局部作用域 (Local Scope)：在函数内部定义的变量拥有局部作用域。它们只能在该函数内部被访问，函数执行完毕后，这些变量就会被销毁。

当你在函数内部尝试访问一个在函数外部定义的变量时，PHP默认会认为这是一个新的局部变量，而不是引用外部的同名变量。如果这个局部变量没有被赋值，它将被视为未定义（null），这可能导致意外的行为，例如条件判断始终为真，或者抛出“Undefined variable”的警告/错误。

考虑以下原始代码片段中的函数定义：

// ... 外部变量定义 ...
$lid_mail = $row['user_mail'];
$user_email = $user->user_email;

function gfedit_verify_user_entry(){
    if(isset($_GET['lid']) && $lid_mail == $user_email){ // 问题出在这里
        return true;
    }
    else{
        return false;
    }
}
// ... 函数调用 ...

在这个例子中，$lid_mail 和 $user_email 是在函数 gfedit_verify_user_entry() 外部定义的。然而，在函数内部，当尝试使用它们时，PHP会认为它们是未定义的局部变量。由于PHP的弱类型特性，未定义的变量在比较时通常被视为 null，因此 null == null 的比较结果为 true，导致函数无论实际情况如何都返回 true。尽管 $_GET 是一个超全局变量，可以在函数内部直接访问，但自定义的 $lid_mail 和 $user_email 则不然。

解决方案一：通过参数传递数据（推荐实践）

解决变量作用域问题的最佳实践是将函数所需的数据作为参数传递给它。这种方法使函数更加独立、可重用和易于测试，因为它明确声明了其依赖项。

示例代码：

get_row($wpdb->prepare("SELECT * FROM wp_edit_gf WHERE lid = %d", $lid), ARRAY_A); // 注意：使用%d防止SQL注入
global $current_user;
$user_id = $current_user->ID;
$user = get_user_by('id', $user_id);
$user_email = $user->user_email;
$lid_mail = $row['user_mail'];

/**
 * 验证用户对条目的访问权限
 *
 * @param bool   $is_lid_set 是否设置了GET参数lid
 * @param string $entry_mail 条目关联的邮箱
 * @param string $current_user_mail 当前用户的邮箱
 * @return bool
 */
function gfedit_verify_user_entry(bool $is_lid_set, string $entry_mail, string $current_user_mail): bool {
    // 确保 lid 已设置且邮箱匹配
    return $is_lid_set && ($entry_mail === $current_user_mail);
}

// 在调用函数时，将外部变量作为参数传入
$is_lid_present = isset($_GET['lid']); // 将isset($_GET['lid'])的结果也作为参数传入，使函数更纯粹
if(!is_user_logged_in()){
    header("Location: https://example.com/my-account/?login=true&back=home&page=1");
    exit();
} elseif(!gfedit_verify_user_entry($is_lid_present, $lid_mail, $user_email)){
    echo "access denied!";
} else {
    // 访问允许后的逻辑
    echo "Access granted!";
}
?>

优点：

• 清晰的依赖关系：函数签名清楚地表明了它需要哪些数据才能正常工作。
• 可重用性：函数不再依赖于特定的全局变量，可以在不同上下文中轻松重用。
• 可测试性：更容易为函数编写单元测试，因为可以轻松模拟输入数据。
• 减少副作用：函数内部不会意外修改全局变量。

解决方案二：使用 global 关键字（谨慎使用）

虽然不推荐作为首选方案，但你也可以使用 global 关键字在函数内部显式地引用全局变量。

示例代码：

user_email;

function gfedit_verify_user_entry(){
    global $lid_mail, $user_email; // 声明要使用的全局变量

    if(isset($_GET['lid']) && $lid_mail == $user_email){
        return true;
    }
    else{
        return false;
    }
}
// ... 函数调用 ...
if(!is_user_logged_in()){
    header("Location: https://example.com/my-account/?login=true&back=home&page=1");
    exit();
} elseif(!gfedit_verify_user_entry()){
    echo "access denied!";
} else {
    // 访问允许后的逻辑
    echo "Access granted!";
}
?>

注意事项：

• 超全局变量：$_GET, $_POST, $_SESSION, $_SERVER 等超全局变量无需使用 global 关键字即可在函数内部直接访问。
• 代码耦合度高：使用 global 会使函数与全局状态紧密耦合，降低了函数的独立性和可重用性。
• 难以维护和调试：当全局变量的值在程序的不同部分被修改时，追踪其变化和调试问题会变得非常困难。
• 推荐场景：在极少数情况下，例如需要修改全局配置或与特定外部系统（如WordPress的 $wpdb 对象）交互时，可能会考虑使用 global，但即使如此，也应尽可能封装或通过依赖注入的方式来管理。

调试与最佳实践

• 使用 var_dump() 或 echo 调试：在函数内部，使用 var_dump($lid_mail); 或 echo $user_email; 来检查变量在当前作用域中的实际值，可以帮助你快速定位问题。
• 检查变量是否存在：使用 isset() 函数来检查变量是否已定义且不为 null，这有助于避免“Undefined variable”的通知。
• 最小化全局状态：尽量减少对全局变量的依赖。设计函数时，优先考虑它们作为独立单元如何接收输入并产生输出。
• 函数纯粹性：一个“纯粹”的函数只依赖于其输入参数，并且不产生任何副作用（例如修改全局变量或外部状态）。这样的函数更容易理解、测试和维护。

总结

理解PHP中的变量作用域是编写健壮、可维护代码的关键。当函数“无故”不工作或返回异常结果时，变量作用域问题往往是罪魁祸首。通过将函数所需的数据作为参数显式传递，我们可以构建更清晰、更灵活且更易于调试的PHP应用程序。尽管 global 关键字提供了访问全局变量的途径，但其潜在的负面影响使得它成为一种应谨慎使用的替代方案。始终优先考虑通过参数传递数据，以提升代码质量和可维护性。