webdevstudios/oops-wp

一组接口和类结构,旨在促进WordPress中的面向对象编程实践。

1.0.0 2021-02-27 18:31 UTC

README

此库提供了一组抽象类、接口和特性,以帮助在WordPress中推广面向对象开发。

安装

安装OOPS-WP最新稳定版本的首选方法是使用Composer。从您的项目目录中,您可以运行

composer require webdevstudios/oops-wp

这将安装与您调用命令的位置相关的库,在/vendor/webdevstudios/oops-wp。您可以导航到该目录以查看您可用的各种类、接口和特性。为了使这些结构对WordPress可用,您需要要求Composer生成的自动加载文件

if ( is_readable( __DIR__ . '/vendor/autoload.php' ) ) {
	require_once __DIR__ . '/vendor/autoload.php';
}

注意:有关为什么包括is_readable()检查的详细信息,请参阅维基百科

注意事项

WordPress并非为与Composer兼容而设计,许多插件和主题可能会使用相同的库。此库建议用于具有对开发和安装环境完全控制的代理型项目。将OOPS-WP作为打包发布的一部分可能意味着可能会在项目中安装多个不同的副本,从而导致系统中出现意外的错误。这是WordPress解决依赖关系的方式的不足,而不是OOPS-WP的问题。有关此问题的更多信息,请参阅Peter Suhm在WPTavern上的这篇优秀文章

文档和开发路线图

在其初始版本中,OOPS-WP包含很少的结构来促进插件和主题开发。有几个接口:HookableRunnableRegisterable,以及几个抽象类,特别是ServiceRegistrarServiceEditorBlockPostType。这些是针对WebDevStudios快速搭建一些基本结构实体而生的,但它们并不是WordPress支持的所有数据结构。

要查看WordPress中正在开发的结构,您可以访问此存储库的问题页面。要了解如何使用此包提供结构的文档和示例,您可以访问维基百科

版本控制

本项目遵循语义化版本控制的最佳实践。这意味着PATCH版本(例如,0.1.1)将仅包括细微的bug修复或其他非功能更新,例如本README中的文本。MINOR版本(例如,0.2.0)将包括新功能,例如额外的类结构,以及向后兼容的友好变更。MAJOR版本(例如,1.0.0)将包含破坏向后兼容性的变更。因此,您可以在版本已升级到主要版本(例如,^1)的包上安全地运行composer update webdevstudios/oops-wp,无需担心更新会破坏您的网站。升级到下一个主要版本意味着您可能需要更新所有使用此库的类,以确保它们遵循最新的API。

贡献

有关如何为此项目做出贡献的信息,请参阅贡献文档