|
1 | 1 | # Abstract Plugin Base |
| 2 | + |
2 | 3 | Used as a base class to help standardize the way we build WordPress plugins. |
3 | 4 |
|
4 | 5 | CircleCI Build: [](https://circleci.com/gh/WordPress-Phoenix/abstract-plugin-base) |
5 | 6 |
|
6 | | -# WordPress Options Builder Class Library |
7 | | - |
8 | | -WordPress options builder class is a library that helps you setup theme or plugin options that store data in the database with just a line or two of code! |
| 7 | +## Table of Contents |
9 | 8 |
|
10 | | -## Table of Contents: |
11 | | -- [Installation](#installation) |
12 | | -- [Usage](#usage) |
| 9 | +* [Installation](#installation) |
| 10 | +* [Usage](#usage) |
13 | 11 |
|
14 | | -# Installation |
| 12 | +## Installation |
15 | 13 |
|
16 | 14 | You can use this library to start a new plugin from scratch, or you can enhance your existing plugins with this library. Once you have read over the installation instructions it should make sense which direction to go. |
17 | 15 |
|
18 | | -## Composer style (recommended) |
19 | | -1. Confirm that composer is installed in your development environment using `which composer`. If CLI does not print any path, you need to install composer like `brew install composer`. |
20 | | -2. Set CLI working directory to wp-content/plugins/{your-plugin-name} |
21 | | -3. Install Abstract_Plugin class via composer command line like |
22 | | -```bash |
23 | | -composer require WordPress-Phoenix/abstract-plugin-base && composer install |
24 | | -``` |
25 | | -4. Look at sample code below to see how to include this library in your plugin. |
| 16 | +### Composer style (recommended) |
| 17 | + |
| 18 | +1. Confirm that composer is installed in your development environment using `which composer`. If CLI does not print any path, you need to [install Composer](https://getcomposer.org/download/). |
| 19 | +2. Set CLI working directory to wp-content/plugins/{your-plugin-name} |
| 20 | +3. Install Abstract_Plugin class via composer command line like |
| 21 | + ```bash |
| 22 | + composer require wordpress-phoenix/abstract-plugin-base |
| 23 | + ``` |
| 24 | +4. Look at sample code below to see how to include this library in your plugin. |
| 25 | + |
| 26 | +### Manual Installation |
| 27 | + |
| 28 | +1. Download the most updated copy of this repository from `https://api.github.com/repos/WordPress-Phoenix/abstract-plugin-base/zipball` |
| 29 | +2. Extract the zip file, and copy the PHP file into your plugin project. |
| 30 | +3. Include the file in your plugin. |
| 31 | + |
| 32 | +## Usage |
26 | 33 |
|
27 | | -## Manual Installation |
28 | | -1. Download the most updated copy of this repository from `https://api.github.com/repos/WordPress-Phoenix/abstract-plugin-base/zipball` |
29 | | -2. Extract the zip file, and copy the PHP file into your plugin project. |
30 | | -3. Use SSI (Server Side Includes) to include the file into your plugin. |
| 34 | +### Why should you use this library when building your plugin? |
| 35 | +By building your plugin using OOP principals, and extending this Plugin_Base class object, you will be able to quickly and efficiently build your plugin, allowing it to be simple to start, but giving it the ability to grow complex without changing its architecture. |
31 | 36 |
|
32 | | -# Usage |
| 37 | +Immediate features include: |
33 | 38 |
|
34 | | -## Why should you use this library when building your plugin? |
35 | | -By building your plugin using OOP principals, and extending this Plugin_Base class object, you will be able to quickly and efficiently build |
36 | | -your plugin, allowing it to be simple to start, but giving it the ability to grow complex without changing its architecture. Immediate |
37 | | -features include: |
38 | | -- Built in SPL Autoload for your includes folder, should you follow WordPress codex naming standards for class files. |
39 | | -- Template class provides you all the best practices for standard plugin initialization |
40 | | -- Minimizes code needed / maintenance of your main plugin file. |
41 | | -- Assists developers new to WordPress plugin development in file / folder architecture. |
42 | | -- By starting all your plugins with the same architecture, we create a standard that is better for the dev community. |
| 39 | +* Built in SPL Autoload for your includes folder, should you follow WordPress codex naming standards for class files. |
| 40 | +* Template class provides you all the best practices for standard plugin initialization |
| 41 | +* Minimizes code needed / maintenance of your main plugin file. |
| 42 | +* Assists developers new to WordPress plugin development in file / folder architecture. |
| 43 | +* By starting all your plugins with the same architecture, we create a standard that is better for the dev community. |
43 | 44 |
|
44 | | -## Simplest example of the main plugin file, and required plugin class file |
| 45 | +### Simplest example of the main plugin file, and required plugin class file |
| 46 | + |
| 47 | +`custom-my-plugin.php`: |
45 | 48 |
|
46 | | -custom-my-plugin.php |
47 | 49 | ```php |
48 | 50 | <?php |
49 | 51 | /** |
50 | 52 | * Plugin Name: Custom My Plugin |
51 | 53 | * Plugin URI: https://github.com/ |
52 | 54 | */ |
53 | 55 |
|
54 | | -//avoid direct calls to this file, because now WP core and framework has been used |
| 56 | +// Avoid direct calls to this file, because now WP core and framework has been used |
55 | 57 | if ( ! function_exists( 'add_filter' ) ) { |
56 | 58 | header( 'Status: 403 Forbidden' ); |
57 | 59 | header( 'HTTP/1.1 403 Forbidden' ); |
58 | 60 | exit(); |
59 | 61 | } |
| 62 | +
|
60 | 63 | // Create plugin instance on plugins_loaded action to maximize flexibility of wp hooks and filters system. |
61 | 64 | include_once 'vendor/autoload.php'; |
62 | 65 | include_once 'app/class-my-plugin.php'; |
63 | | -Custom\My_Plugin\App::run( __FILE__ ); |
64 | 66 |
|
| 67 | +Custom\My_Plugin\App::run( __FILE__ ); |
65 | 68 | ``` |
66 | 69 |
|
67 | | -app/class-app.php |
| 70 | +`app/class-app.php`: |
| 71 | +
|
68 | 72 | ```php |
69 | 73 | <?php |
| 74 | +
|
70 | 75 | namespace Custom\My_Plugin; |
| 76 | +
|
71 | 77 | use WPAZ_Plugin_Base\V_2_6\Abstract_Plugin; |
72 | 78 |
|
73 | 79 | /** |
74 | 80 | * Class App |
75 | 81 | */ |
76 | 82 | class App extends Abstract_Plugin { |
77 | | - |
78 | | - public static $autoload_class_prefix = __NAMESPACE__; |
79 | | - protected static $current_file = __FILE__; |
80 | | - public static $autoload_type = 'psr-4'; |
81 | | - // Set to 2 when you use 2 namespaces in the main app file |
82 | | - public static $autoload_ns_match_depth = 2; |
83 | | - |
84 | | - public function onload( $instance ) { |
85 | | - // Nothing yet |
86 | | - } // END public function __construct |
87 | | - |
88 | | - public function init() { |
89 | | - do_action( get_called_class() . '_before_init' ); |
90 | | - // Do plugin stuff usually looks something like |
91 | | - // $subclass = new OptionalAppSubfolder/Custom_Class_Subclass(); |
92 | | - // $subclass->custom_plugin_function(); |
93 | | - do_action( get_called_class() . '_after_init' ); |
94 | | - } |
95 | | - |
96 | | - public function authenticated_init() { |
97 | | - if ( is_user_logged_in() ) { |
98 | | - // Ready for wp-admin - but not required |
99 | | - //$this->admin = new Admin/App( $this ); |
100 | | - } |
101 | | - } |
102 | | - |
103 | | - protected function defines_and_globals() { |
104 | | - // None yet. |
105 | | - } |
106 | | - |
107 | | -} // END class |
108 | 83 |
|
| 84 | + public static $autoload_class_prefix = __NAMESPACE__; |
| 85 | +
|
| 86 | + protected static $current_file = __FILE__; |
| 87 | +
|
| 88 | + public static $autoload_type = 'psr-4'; |
| 89 | +
|
| 90 | + // Set to 2 when you use 2 namespaces in the main app file |
| 91 | + public static $autoload_ns_match_depth = 2; |
| 92 | +
|
| 93 | + public function onload( $instance ) { |
| 94 | + // Nothing yet |
| 95 | + } |
| 96 | +
|
| 97 | + public function init() { |
| 98 | + do_action( static::class . '_before_init' ); |
| 99 | +
|
| 100 | + // Do plugin stuff usually looks something like |
| 101 | + // $subclass = new OptionalAppSubfolder\Custom_Class_Subclass(); |
| 102 | + // $subclass->custom_plugin_function(); |
| 103 | +
|
| 104 | + do_action( static::class . '_after_init' ); |
| 105 | + } |
| 106 | +
|
| 107 | + public function authenticated_init() { |
| 108 | + if ( ! is_user_logged_in() ) { |
| 109 | + return; |
| 110 | + } |
| 111 | +
|
| 112 | + // Ready for wp-admin - but not required |
| 113 | + //$this->admin = new Admin\App( $this ); |
| 114 | + } |
| 115 | +
|
| 116 | + protected function defines_and_globals() { |
| 117 | + // None yet. |
| 118 | + } |
| 119 | +
|
| 120 | +} |
109 | 121 | ``` |
0 commit comments