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
+5-4Lines changed: 5 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@
17
17
18
18
## Description
19
19
20
-
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.
20
+
This is a boilerplate WordPress plugin featuring namespace autoloading and [Carbon Fields](https://carbonfields.net/) examples. It is intended to be used as a starting point for creating WordPress plugins. It contains several examples and dependencies to get you started.
21
21
22
22
It may also be used as the means of [separating custom code](http://www.billerickson.net/core-functionality-plugin/) from the theme or [extending a child theme](https://www.wp-code.com/wordpress-snippets/wordpress-grandchildren-themes/).
23
23
@@ -39,7 +39,7 @@ Here are some ways that you can contribute:
39
39
* Automatic translation file (`.pot`) creation. See [Translation](https://github.com/dmhendricks/wordpress-base-plugin/wiki/Translation).
40
40
* Shortcodes, widgets (via [Carbon Fields](https://carbonfields.net)) and custom post types (via [PostTypes](https://github.com/jjgrainger/PostTypes/)) examples
41
41
* 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)
42
-
*Adding options to Customizer example
42
+
* Customizer options
43
43
*[More to come...](#future-plans)
44
44
45
45
**Note:** Gulp and Bower are optional, but handy. If you do not wish to use them, you can delete the references.
@@ -57,7 +57,7 @@ If you need tips on installing Node.js, Composer, Gulp & Bower, see [Installing
57
57
58
58
#### The short version:
59
59
60
-
1. Clone repository to `plugins`
60
+
1. Clone repository to your `plugins` directory
61
61
1. Change the four variables in [package.json](https://github.com/dmhendricks/wordpress-base-plugin/wiki#setting-initial-variables)
62
62
1. Run `npm install; gulp rename; composer install`
63
63
@@ -74,6 +74,7 @@ See the [Getting Started](https://github.com/dmhendricks/wordpress-base-plugin/w
74
74
## Future Plans
75
75
76
76
* Refactor the Plugin and Loader classes
77
+
* Add plugin uninstall hook
77
78
* Add [phpdotenv](https://github.com/etelford/phpdotenv) support
78
79
* Switch to npm and WebPack for frontend dependency management
79
80
@@ -90,7 +91,7 @@ Release changes are noted on the [Releases](https://github.com/dmhendricks/wordp
90
91
* Added `get_wpsac_plugin_option()` example to Plugin class
91
92
* Updated JS injection to use wordpress-toolkit [ScriptObject](https://github.com/dmhendricks/wordpress-toolkit/wiki/ScriptObject)
92
93
* Added Customizer options example (via [inc2734/wp-customizer-framework](https://github.com/inc2734/wp-customizer-framework))
0 commit comments