WordPress 开发人员：使用样板文件很好

已发表: 2017-10-04

样板代码作为一个术语经常以贬义的方式使用，因为似乎没有人特别喜欢编写它（包括 WordPress 开发人员）。它指的是在编写实际执行某些操作的代码之前，在许多地方重复而不更改的代码作为脚手架。一些语言，如 Java 和 C++，因为这样而受到批评。但是，所有这些脚手架都是有原因的。也就是说，在代码结构中提供和执行良好的组织原则（最佳实践）。

在 WordPress 主题和插件的上下文中，使用样板代码的好处以更清晰和直接的方式展示。有几个 WordPress 项目提供了一系列经过深思熟虑的样板代码，可以帮助您组织代码并避免错误。

什么是样板代码？

样板代码基本上是可以在项目开发中使用的目录和源代码文件的骨架。这些目录有助于将各种源代码文件组织到适当的位置，并且通常该结构反映了您的开发平台上的那个。

对于 WordPress 插件，源代码文件通常包含占位符函数定义、值和注释，描述代码的哪一部分去哪里。 Boilerplate WordPress 主题还提供了一个目录结构，其中包含有组织和注释的骨架 js 和 CSS 文件。

样板在 WordPress 开发中的好处

所有的 WordPress 插件都有一些常用的功能，例如激活、停用，以及它们需要实现的各种钩子。样板代码可以提供一个通用的结构，该结构设计良好并强制执行良好的软件实践。使用样板代码可以实现三件好事：更好的代码质量、更容易的维护和更快的开发。而这些反过来又使您成为更好的 WordPress 开发人员。

更好的代码质量

尽管 WordPress 核心的代码质量很好，但 WordPress 插件通常不是这样。使用样板的自然结果是标准化。符合执行良好实践的标准的插件，具有更简洁的代码，最重要的是，在正确的位置。 Boilerplate 还鼓励开发人员完整地实现插件的接口和功能。通过提供该脚手架，它可以帮助您不要遗漏某些内容，或者在错误的地方实施不当。

由于所有内容都正确布局并带有注释，因此对于初学者 WordPress 开发人员来说也是一个很大的帮助。

更容易维护

以上所有导致更容易维护。使用样板编写的代码更易于阅读、理解和排除故障。通过标准化，开发人员可以获取您的代码，并确切地知道在哪里寻找。但是，这不仅适用于其他 WordPress 开发人员，也适用于您自己。一周前写的代码在你脑海中仍然记忆犹新，几个月后很快就会变得难以理解。

更快的发展

样板代码还有助于加快开发时间。通过为您提供项目的完整工作框架，它可以让您在重要的地方开始编写代码和设计。您无需花时间组织代码或弄清楚您需要哪些默认函数或 CSS 组件，然后编写它们。

但最大的收获是当您创建自己的、更高级的样板包时。如果您通常构建某些类型的 WordPress 网站，例如电子商务或个人页面，那么奇迹就会发生。您可以使用包含占位符代码和主题功能的框架文件编写一个包，这些功能在特定类型的所有项目中都很常见。这样，您只需解压缩包并开始仅使用项目的详细信息填充它。

如果您是 Pressidium 客户，您可以使用我们的克隆工具，该工具是在考虑到这个简单概念的情况下构建的。例如，假设您在 Pressidium 平台上创建了一个样板电子商务 WordPress 网站。您只需单击一下即可克隆它，然后开始处理细节，而不是每次都从头开始。

在 WordPress 项目中使用样板

WordPress 有几个样板“系统”。但在本文中，我们将重点关注两个众所周知且记录在案的：WordPress 插件样板文件和roots.io。

WordPress Plugin Boilerplate 将自己宣传为“用于构建高质量 WordPress 插件的标准化、有组织、面向对象的基础”，并且它确实提供了。它遵循 WordPress API 和文档标准，构建在 WordPress 插件 API 之上，并提供了一种简洁的本地化方式。让我们来看看它的内容：

Changelog.md
这是 Markdown 中的 Changelog 文件。

plugin-name/
包含其他所有内容的主文件夹。

admin/
所有与管理相关的功能都放在此处。它包括三个相关的文件夹， css ， js和partials 。

includes/
该目录包括用于激活/停用功能的类、i18n 本地化以及用于定义所有函数/挂钩的加载器类。

class-plugin-name-activator.php
class-plugin-name-deactivator.php
class-plugin-name-i18n.php
class-plugin-name-loader.php
class-plugin-name.php
index.php

languages/plugin-name.pot 包含插件本地化字符串的样板 .pot 文件。

public/
在这里，您放置了所有面向公众的相关插件代码。您再次拥有相关的css 、 js和partials文件夹。

注意：在开始之前，不要忘记将所有出现的“plugin-name”重命名为插件的名称。

我们选择的第二个样板系统要复杂得多，因此无法在本文中完整介绍它。但是，它具有出色的在线文档。开发人员还为您可以从官方网站购买的每个组件编写了一系列电子书！

Roots.io 是一个高级样板系统，提供三个组件（Trellis、Bedrock 和 Sage），可以单独使用，也可以结合使用。它旨在用于 WordPress 项目，而不仅仅是插件或主题。它具有高级功能，例如通过 Vagrant 提供虚拟机、使用 Composer 进行依赖管理、对编写样式表的 Sass 支持、自动 Javascript 纠错、浏览器测试、图像优化等。它基于 HTML5 样板，并带有最新版本的 Bootstrap。

结束时

那里有许多样板系统，每个都满足不同的需求。如果您是高级 WordPress 开发人员，需要完整的 WordPress 项目样板解决方案以及集成功能和工具链，请选择 Roots.io。如果您是初学者 WordPress 开发人员，或者您只需要一个简单的样板来开始开发您的插件或主题，那么 WordPress 插件样板最适合您的需求。