README

由Pragmatic项目创建。

WordPress项目编写一致PHP代码的风格指南。

安装

我们的PHP编码标准通过php_codesniffer强制执行，并可以使用PHP包管理器composer进行安装。

$ composer require pragmaticweb/php-coding-standards --dev

使用方法

基本使用

当使用composer安装时，运行以下命令即可使用我们的编码标准：

$ vendor/bin/phpcs --standard="Pragmatic" ./my-plugin ./my-file.php

配置文件

为了使修改我们的标准以更好地适应您的项目更简单，您可以创建一个phpcs.xml.dist文件，其中可以包含类似以下内容：

	<?xml version="1.0"?>
	<ruleset name="MyProjectCodingStandard">

		<description>My Project coding standard.</description>

		<file>./my-plugin</file>
		<file>./my-file.php</file>

		<config name="text_domain" value="my-project"/>

		<rule ref="Pragmatic" />

	</ruleset>

使用配置文件，您只需运行vendor/bin/phpcs来检查代码风格。

有关更高级的使用方法，请参阅PHP Codesniffer文档。

包含的规则

WordPress编码标准

我们目前几乎完全使用WordPress编码标准，但有一些例外（见ruleset.xml）。

请参阅https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards。

PHP兼容性WP

它允许分析代码与更高版本和更低版本的PHP的兼容性。默认目标版本是PHP 7.0+。

可以通过自定义phpcs.xml更改目标版本。

请参阅https://github.com/PHPCompatibility/PHPCompatibilityWP

PSR2

请参阅https://github.com/php-fig-rectified/psr2r-sniffer

贡献

Pragmatic编码标准使我们的工程师能够共同工作并编写一致的PHP代码。

欢迎提交拉取请求，但它们需要经过我们团队成员的审查。

请首先打开一个问题来讨论您想要更改的内容，如果我们的团队同意，那么我们可能会考虑合并它们。

pragmaticweb / php-coding-standards

维护者

详细信息