由 Awesome Motive 提供支持。
了解更多 海鹰博客。

终极 WordPress 编码标准指南:开发人员必备

WordPress 编码标准完全指南

WordPress的编码标准确保了该平台庞大代码库的一致性和可维护性。这些精心制作的指南提炼了WordPress 的开发技巧,提高了清晰度和效率。 

通过遵循这些WordPress 维护指南,世界各地的开发人员可以和谐地作出贡献,无缝地理解彼此的工作。让您的WordPress 开发团队认真遵守 WordPress 编码标准,确保长期提供高质量、可扩展和可维护的解决方案。

为什么要坚持 WordPress 的编码标准?

WordPress 编码标准旨在确保不同项目和贡献者之间的代码一致性。 它提高了协作开发的可读性和可维护性,促进了代码审查和对整个 WordPress 生态系统最佳实践的遵守。

什么是 WordPress 编码标准?

什么是 WordPress 编码标准?

WordPress 编码标准为整个 WordPress 项目和社区(从核心代码到主题和插件)的协作和一致性提供了基准。这些标准由 WordPress 社区与WordPress 支持部门协商制定,是 WordPress开发人员和贡献者应遵循的最佳实践。

了解更多信息:如何减少第三方代码的影响?

编码标准的重要性

编码标准有助于防止常见错误、提高代码可读性并简化修改。通过遵守这些标准,代码看起来就像由一个人编写的一样,使任何人都更容易理解和修改。

对 WordPress 核心的贡献

如果要为 WordPress core 做出贡献,熟悉这些标准至关重要,因为提交的代码必须符合这些标准。

如何为您独特的 WordPress 网站保持编码标准?

让我们的 WordPress 专业开发人员来处理这些令人头疼的问题吧!

WordPress 编码标准的组成部分

该标准涵盖 CSS、HTML、JavaScript 和 PHP 的特定语言指南,以及与 WCAG AA 一致的可访问性指南。

另请阅读: 如何将 HTML 转换为 WordPress 主题?

第三方图书馆例外

不过,纳入 WordPress 的第三方库可不受这些标准的约束。

WordPress 编码标准示例

WordPress 编码标准示例

让我们通过各种示例来探索 WordPress 的编码标准,了解它们在现实世界中的应用。这些示例说明了在 WordPress 中编写清晰、可维护代码的最佳实践建议。

WORDPRESS中的PHP

WordPress 使用PHP 更新作为其核心编程语言。遵守 PHP 编码标准对于 WordPress 代码的可维护性和一致性至关重要。以下是 PHP 编码标准为何重要的原因:

换行

WordPress 编码标准的换行

WordPress 对换行的规定不多,但通常会在大多数语句后添加换行符。此外,建议将变量定义、if 块和数组项放在不同的行上。

缩进

WordPress 编码标准的缩进

为使代码更易于阅读,请使用缩进来显示代码的逻辑结构。行首应使用制表符,行中缩进则使用空格。

空间使用

WordPress 编码标准的空间使用

删除行尾多余的空格,使代码更易于阅读。同时,删除带有制表符或非分隔符的空行。为清晰起见,在括号内使用空格。在开头括号后和结尾括号前添加换行符,类型转换除外。

报价

WordPress编码标准引言

在 WordPress 中,字符串的主要规则是使用单引号,除非您要对字符串中的内容进行评估。如果需要在字符串中使用引号,请交替使用单引号和双引号。可以使用括弧引号,但很少有必要。

牙套

WordPress 编码标准的括号

最简单的方法是始终使用大括号。虽然标准允许同一结构中没有多行块的单行 "if "语句跳过大括号,但单行循环却不允许这样做。为了清晰起见,我更倾向于始终使用大括号。此外,标准规定将开头大括号与初始语句放在同一行,而不是像 PHP 文档中那样放在初始语句的下面。

格式化 SQL 查询

WordPress 编码标准的 SQL 查询

编写 SQL 查询时,请记住将关键字大写。复杂的查询应分成多行。充分理解查询很重要,尤其是其安全方面,我们稍后将讨论这一点。由于WordPress 的安全错误,SQL 注入攻击时有发生,允许黑客直接访问和操纵 WordPress 网站背后的数据库。

命名约定

WordPress 编码标准命名活动

在 WordPress 代码中,名称应避免使用驼峰字母。函数应使用小写字母,必要时使用下划线。类名应大写每个单词的第一个字母,并用下划线分隔。

文件名应全部小写,各部分之间用连字符连接。如果文件只包含一个类,应以该类命名,前缀为 "class-"。

为清晰起见,使用字符串值代替布尔值作为函数参数。最重要的原则是使名称具有描述性。在协作环境中,要以帮助大家理解你的代码为目标。

比较报表

WordPress 编码标准比较报表

不仅是 WordPress,一个好的做法是始终将变量放在比较的右侧。这样,如果忘记了等号,就会导致错误,而不是求值为真。如果你喜欢使用三元运算符,这也是允许的,但建议检查是否为真,这样会更清楚。使用 ! empty() 检查变量是否为非空时是一个例外。

格式化 HTML

根据 WordPress Codex,使用 W3C 验证器验证所有 HTML 代码非常重要。不过,有效的代码并不总是意味着好的代码,尽管两者之间有明显的联系。

类型

WordPress 遵循 W3C 于 2000 年推荐的 XHTML 1.0 规范。尽管如此,WordPress 的默认主题 Twenty Eleven 却使用 HTML5。这并不冲突,因为 HTML5 包含 XML 序列化,允许使用 "XHTML5"。

使用报价

在 HTML 中,引号主要用于属性及其值。您可以选择单引号或双引号,但应始终使用一种类型。就我个人而言,为了保持一致性,我尽可能使用单引号,在 PHP 中也是如此。这有助于我通过查看引号快速发现一行中的任何特殊情况。

关闭标签

XHTML 规范要求关闭所有标记。无效元素需要在最后一个角括弧前用斜线关闭。确保斜线前有一个空格。

缩进

WordPress 编码标准的缩进

按照与 PHP 相同的规则缩进 HTML。在缩进时要注意逻辑结构。将 PHP 和 HTML 结合使用时,应根据通常的缩进流程缩进 PHP 块。

格式化 CSS 

按照 WordPress 编码标准格式化 CSS

CSS 格式化包括对网页内容的呈现进行组织和样式化,确保在不同设备和浏览器上的一致性和可读性。格式正确的 CSS 可以增强网站的结构和视觉吸引力,从而带来更好的用户体验。

阅读更多: 如何删除 WordPress 中未使用的 CSS?

缩进和结构

您的 CSS 应遵循这一大致模式:将每个选择器写在单独一行上,即使你为一个规则集列出了多个选择器。此外,每个属性值对都应独立成行。将开头括号放在选择器所在行,将结尾括号放在单独一行,其缩进与开头选择器的缩进相同。

命名约定

只使用小写字母。用连字符分隔选择器中的单词。给选择器起一个人类可读的名称。

属性和价值

编写属性和值有很多规则。除覆盖先前定义的属性外,尽可能使用速记版本的属性。尽可能使用小写 HEX 编码来表示颜色。如果合适,请使用较短的版本。在属性后的冒号后插入空格。始终使用小写字符,除非需要使用大写字符,如字体名称和特定供应商属性。按字母顺序排列 CSS 属性,但供应商特定属性和尺寸属性除外,供应商特定属性应排在普通属性之前,尺寸属性应放在一起。如果指定了宽度和高度,应先写宽度。

评论

WordPress 编码标准的评论

CSS 只支持一种注释类型--块样式;它没有单独的内联注释符号。在一行中书写简短的注释,下面不要换行。对于跨多行的注释,在开头语法后插入一个换行符,在结尾语法前插入一个换行符。如果使用注释来划分代码部分,则使用以下符号:

使用 CSS 预处理器

适用于 WordPress 编码标准的 WordPress CSS 处理器

使用 CSS 预处理器(如 SASS 和 Less)让我们的开发工作变得更加轻松,但它们也并非没有缺点。这些工具生成的代码通常是有效的,但不能说非常干净。手动生成的样式表(经过深思熟虑)要比 Less 自动生成的样式表可读得多。这取决于你在做什么。如果您的产品是商业性的,那么最终目标就是通过有效和优化的代码获得良好的用户体验。在这种情况下,可以使用预处理器的输出作为主要 CSS,但要为开发人员提供原始文件。虽然您的 CSS 不符合 WordPress 的标准,但在 WordPress 正式表态之前,包含原始文件可以在一定程度上弥补差距。为了简化开发过程(目的是获得更好的用户体验),牺牲 CSS 的编码标准是可以的。但牺牲代码的有效性则不行。

如何为 WordPress 的编码标准做出贡献?

代码就像写作,每个人都有自己独特的风格。你的 HTML 看起来可能与我的不同,我的 JavaScript 可能会让你的眼睛流血,而你的 CSS 则可能美得改变生活。但是在合作开发 WordPress 这样的项目时,拥有统一的编码标准至关重要。

WordPress 编码标准的存在是为了确保任何为代码库做出贡献的人都能轻松阅读、理解并在他人工作的基础上进行开发。通过遵守这些标准,您基本上可以与其他贡献者使用相同的语言。这就好比同意使用一致的语法和格式规则,这样大家就可以在同一本书上无缝协作。

如果您想为 WordPress 做出贡献,熟悉并遵循编码标准是关键。它可以让您的个人编码风格与更大的 WordPress 代码库完美融合。

结论

遵守 WordPress 编码标准对于保持代码库的凝聚力和协作性至关重要。这些准则由 WordPress 社区制定,是全球贡献者的共同语言。通过遵循 PHP、HTML、CSS、JavaScript 和可访问性标准,开发人员可以确保代码的一致性、可读性和可维护性。

随着 WordPress 的不断发展,这些编码标准将在为整个社区营造和谐高效的开发环境方面发挥至关重要的作用。

如果您是一位 WordPress 网站所有者,正在寻求创收潜力,那么提升您的 WordPress 会员网站

许多用户认为,维护一个过时的传统 WordPress 网站是一场艰苦的战斗。这些

数字体验平台 (DXP) 是一款综合性企业软件,可帮助企业管理和交付

阿哈娜-达塔 2024 年 5 月 7 日

2024 年医疗保健网站的最佳网站设计实践

一个精心设计的医疗保健网站不仅仅是一个在线展示,它还是一个强大的

设计
阿哈娜-达塔 2024 年 5 月 7 日

维护功能良好的传统 WordPress 网站的技巧

许多用户认为,维护一个过时的传统 WordPress 网站是一场艰苦的战斗。这些

WordPress
阿哈娜-达塔 2024 年 5 月 6 日

如何进行 WordPress 维护(简单步骤)

由于更新等技术方面的原因,维护 WordPress 对许多网站所有者来说都是一项挑战、

WordPress

开始使用海鹰

在我们的应用程序中注册,查看我们的定价并获得折扣。