This is a boilerplate plugin which, by default:
- Creates a new custom post type
- Creates a new taxonomy
- Adds the defaults for outputting and theming the front-end
*The following should be run from your plugins directory
1.1 Clone the repo
git clone https://github.com/pvtl/wp-boilerplate-plugin.git <YOUR_NEW_PLUGIN_NAME>
1.2 Remove .git - we're starting a new plugin after all
cd <YOUR_NEW_PLUGIN_NAME> && rm -rf .git
1.3 Automatically rename the plugin
bash rename-plugin.sh
1.4 Delete rename-plugin.sh - you don't need it anymore
rm rename-plugin.sh
- Activate the plugin
- Import the
<this_plugin_dir>/custom-fields/acf-export.json
into ACF > Tools - Modify the fields and Export the JSON file + Generate the PHP (replacing the existing file contents in
<this_plugin_dir>/custom-fields/
) - Update the front-end templates to include any of the fields you need
- A
plugin-placeholder
custom post type - A
plugin-placeholder-category
taxonomy - Plugin Placeholder fields added to the post type
- Front-end templates (listing and single) to output the fields
- Wordpress
- Advanced Custom Fields Pro installed and activated
The default front-end templates make use of Foundation - however you can override these in your theme if you need something different.
*The following should be run from your plugins directory
git clone https://github.com/pvtl/wp-plugin-placeholders.git pvtl-plugin-placeholders
rm -rf pvtl-plugin-placeholders/.git
- Activate the plugin
- Update the project's
.gitignore
so that the plugin is included in the repo
By default, the plugin will use the templates found in <plugin_dir>/resouces/views/*.php
.
You can easily override these templates, by creating the respective templates in your theme, naming them:
File Name | Desc. |
---|---|
single-plugin-placeholder.php |
The single post template (overrides single.php) |
archive-plugin-placeholder.php |
The listing template (overrides archive.php) |
Are the extra field/s specific for this project?
- Simply create a new ACF group and add the fields, targeted to this post type
- You'll then need to override the front-end template/s to output the additional fields
Should these new field/s be default for all projects?
- Import the
/custom-fields/acf-export.json
into ACF > Tools - Modify the fields
- Export the JSON file + Generate the PHP (replacing the existing files)
- Update the front-end templates to include the fields
- Commit the changes back to the GIT repo