sirbrillig/phpcs-no-get-current-user

一个禁止使用get_current_user()的phpcs嗅探器。

维护者

详情

github.com/sirbrillig/phpcs-no-get-current-user

源代码

问题

安装数: 63,625

依赖项: 0

建议者: 0

安全性: 0

星级: 3

关注者: 1

分支: 0

开放问题: 0

类型:phpcodesniffer-standard

v1.1.0 2021-03-05 22:19 UTC

Requires

  • php: ^7.0 || ^8.0

Requires (Dev)

BSD-2-Clause 48b96050983dabb52e9f32764454b71187a912c9

  • Payton Swick <payton.woop@foolord.com>

This package is auto-updated.

Last update: 2024-09-06 05:40:28 UTC

README

一个禁止使用get_current_user()的phpcs嗅探器。

尤其是在使用像WordPress这样的PHP框架时，大多数代码不太可能想要使用PHP函数get_current_user()。它还可能与其他框架函数（如WordPress的wp_get_current_user()）混淆。此嗅探器将使用该函数视为错误，尽管如果为特定行禁用嗅探器，仍然可以进行合法使用。

安装

要在使用composer设置的项目中使用这些规则，我们建议使用phpcodesniffer-composer-installer库，该库将在运行phpcs时自动使用当前项目中的所有已安装标准，并使用composer类型phpcodesniffer-standard。

composer require --dev squizlabs/php_codesniffer dealerdirect/phpcodesniffer-composer-installer
composer require --dev sirbrillig/phpcs-no-get-current-user

配置

在项目中安装嗅探标准时，您需要编辑一个带有rule标签的phpcs.xml文件，该标签位于ruleset标签内。该标签的ref属性应指定一个标准、类别、嗅探器或错误代码以启用。还可以使用这些标签禁用或修改某些规则。官方注释文件解释了如何进行此操作。

<?xml version="1.0"?>
<ruleset name="MyStandard">
 <description>My library.</description>
 <rule ref="NoGetCurrentUser"/>
</ruleset>

嗅探代码

此嗅探器报告了一个嗅探代码。

  • NoGetCurrentUser.Disallowed.NoGetCurrentUser.Found

在任意给定文件中，您可以使用phpcs注释来禁用这些嗅探器。例如

$php_user = get_current_user(); // phpcs:ignore NoGetCurrentUser.Disallowed.NoGetCurrentUser.Found

对于整个文件，您可以忽略类似这样的嗅探器

<?php
// phpcs:disable NoGetCurrentUser.Disallowed.NoGetCurrentUser.Found

用法

大多数编辑器都提供有phpcs插件，但您也可以手动运行phpcs。要在项目中运行phpcs的文件，请使用以下命令行（-s参数将显示嗅探代码，这对于了解错误非常重要）。

vendor/bin/phpcs -s src/MyProject/MyClass.php

另请参阅