You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-37Lines changed: 11 additions & 37 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
7
7
## Description
8
8
9
-
This is a boilerplate WordPress plugin featuring namespace autoloading and integration with [Carbon Fields](https://github.com/htmlburger/carbon-fields). It is intended to be used as a starting point for creating quick WordPress plugins. It contains several examples and dependencies to get you started.
9
+
This is a boilerplate WordPress plugin featuring namespace autoloading and integration with [Carbon Fields](https://github.com/htmlburger/carbon-fields). It is intended to be used as a starting point for creating WordPress plugins. It contains several examples and dependencies to get you started.
10
10
11
11
It may also be used as the means of [separating custom code](http://www.billerickson.net/core-functionality-plugin/) from the theme.
12
12
@@ -16,7 +16,7 @@ It may also be used as the means of [separating custom code](http://www.billeric
16
16
* Version checking (PHP, Carbon Fields)
17
17
* Powered by [Composer](https://getcomposer.org/), [Gulp](https://gulpjs.com/) and [Bower](https://bower.io/)
* Automatic translation file (`.pot`) creation. See [Translation](https://github.com/dmhendricks/wordpress-base-plugin/wiki#translation).
19
+
* Automatic translation file (`.pot`) creation. See [Translation](https://github.com/dmhendricks/wordpress-base-plugin/wiki/Translation).
20
20
* Shortcodes, widgets and custom post type (via [PostTypes](https://github.com/jjgrainger/PostTypes/)) examples
21
21
* Configuration registry ([docs](https://github.com/dmhendricks/wordpress-toolkit/wiki/ConfigRegistry)) and optional `wp-config.php`[Constants](https://github.com/dmhendricks/wordpress-base-plugin/wiki/Configuration-&-Constants)
22
22
*[More to come...](#planned-features)
@@ -28,46 +28,27 @@ It may also be used as the means of [separating custom code](http://www.billeric
28
28
29
29
* WordPress 4.0 or higher
30
30
* PHP 5.6 or higher
31
-
*[Carbon Fields](https://github.com/htmlburger/carbon-fields) 2.0 or higher (see [here](https://github.com/dmhendricks/wordpress-base-plugin/wiki#carbon-fields) for more info)
31
+
*[Carbon Fields](https://github.com/htmlburger/carbon-fields) 2.0 or higher (see the wiki section [Carbon Fields](https://github.com/dmhendricks/wordpress-base-plugin/wiki#carbon-fields) for more info)
32
32
33
33
## Installation
34
34
35
-
If you need tips on installing Node.js, Composer, Gulp & Bower, see [Installing Dependencies](https://github.com/dmhendricks/wordpress-base-plugin/wiki#installing-dependencies).
35
+
If you need tips on installing Node.js, Composer, Gulp & Bower, see [Installing Dependencies](https://github.com/dmhendricks/wordpress-base-plugin/wiki/Installing-Dependencies).
36
36
37
37
### Clone Repository
38
38
39
39
1. At command prompt, change to your `wp-content/plugins` directory.
40
-
1. Close the repository: `git clone https://github.com/dmhendricks/wordpress-base-plugin.git`
41
-
42
-
### Composer
43
-
44
-
1. Modify `composer.json` to suit your needs.
45
-
1. Run `composer install` to install dependencies and autoload namespace.
46
-
47
-
If you want to install Carbon Fields as a [dependency](https://github.com/dmhendricks/wordpress-base-plugin/wiki#carbon-fields) rather than via a [loader plugin](https://github.com/dmhendricks/carbon-fields-loader):
48
-
49
-
```
50
-
$ composer require htmlburger/carbon-fields
51
-
```
40
+
1. Clone the repository: `git clone https://github.com/dmhendricks/wordpress-base-plugin.git`
41
+
1. Renamed the newly created `wordpress-base-plugin` directory to your own plugin slug.
52
42
53
43
### Next Steps
54
44
55
45
See the [Getting Started](https://github.com/dmhendricks/wordpress-base-plugin/wiki#getting-started) documentation for further steps.
56
46
57
-
## Plugin Settings
58
-
59
-
This plugin loads many of its defaults & settings from `plugin.json`. See [Configuration & Constants](https://github.com/dmhendricks/wordpress-base-plugin/wiki/Configuration-&-Constants#pluginjson) for more information.
60
-
61
47
## Planned Features & TODO
62
48
63
-
#### 0.3.0 Pre-Release
64
-
65
-
* Add gulp task to package plugin as ZIP file
66
-
67
-
#### Future Releases
68
-
69
49
* Add Customizer example
70
50
* Add dynamically-created CSS/JS files based on settings
51
+
* Add encrypted text field example
71
52
72
53
## Change Log
73
54
@@ -77,18 +58,19 @@ Release changes are noted on the [Releases](https://github.com/dmhendricks/wordp
77
58
78
59
* Bumped minimum PHP version check to 5.6
79
60
* Added [Gulp](https://gulpjs.com/) for task automation (SASS, JS processing)
* Added [Bower](https://bower.io/) to (optionally) load third-party scripts
82
63
* Drastically refactored configuration management
83
64
* Split out settings pages, shortcodes, CPT & widgets into separate files/classes (thanks [obstschale](https://github.com/obstschale/wordpress-base-plugin))
84
65
* Added `wp-pot-cli` to `package.json` to create `.pot` translation file
66
+
* Added `npm run zip` to package plugin as ZIP file
85
67
* Added `register_uninstall_hook` to delete Carbon Fields settings when plugin uninstalled
68
+
* Added Ajax example "Clear Cache" link to admin bar dropdown
86
69
* Added [wordpress-settings-api-class](https://github.com/tareq1988/wordpress-settings-api-class) settings page example
This plugin is intended to be used as a boilerplate for creating quick WordPress plugins.
11
+
This plugin is intended to be used as a boilerplate for creating WordPress plugins.
12
12
13
13
== Description ==
14
14
This is a boilerplate WordPress plugin featuring namespace autoloading and integration with [Carbon Fields](https://github.com/htmlburger/carbon-fields).
15
15
16
-
It is intended to be used as a starting point for quickly creating WordPress plugins.
16
+
It is intended to be used as a starting point for creating WordPress plugins.
17
17
18
18
= Requirements =
19
19
20
20
* WordPress 4.0 or higher
21
21
* PHP 5.6 or higher
22
-
* [Carbon Fields](https://github.com/htmlburger/carbon-fields) 2.0 or higher (see [Dependencies](https://github.com/dmhendricks/wordpress-base-plugin/wiki#dependencies) for more info)
22
+
* [Carbon Fields](https://github.com/htmlburger/carbon-fields) 2.0 or higher (see the wiki section on [Carbon Fields](https://github.com/dmhendricks/wordpress-base-plugin/wiki#carbon-fields) for more info)
23
23
24
24
== Installation ==
25
-
26
-
= Zip File =
27
-
28
-
1. Download the ZIP distribution from Github.
29
-
2. Extract to your plugin folder.
30
-
3. Configure & run Composer.
25
+
If you need tips on installing Node.js, Composer, Gulp & Bower, see [Installing Dependencies](https://github.com/dmhendricks/wordpress-base-plugin/wiki/Installing-Dependencies).
31
26
32
27
= Clone Repository =
33
28
34
29
1. At command prompt, change to your `wp-content/plugins` directory.
35
-
2. Close the repository: `git clone https://github.com/dmhendricks/wordpress-base-plugin.git`
36
-
3. Configure & run Composer.
37
-
38
-
= Composer =
30
+
2. Clone the repository: `git clone https://github.com/dmhendricks/wordpress-base-plugin.git`
31
+
3. Renamed the newly created `wordpress-base-plugin` directory to your own plugin slug.
39
32
40
-
Once you have the source files:
33
+
= Next Steps =
41
34
42
-
1. Modify `composer.json` to suit your needs
43
-
2. Run `composer install` to install dependencies and autoload namespace
35
+
See the [Getting Started](https://github.com/dmhendricks/wordpress-base-plugin/wiki#getting-started) documentation for further steps.
44
36
45
37
== Frequently Asked Questions ==
46
38
= Q. Why do I get the error "Warning: require( ... /autoload.php): failed to open stream: No such file or directory" when I try to activate it?
0 commit comments