Skip to content

Latest commit

 

History

History
238 lines (149 loc) · 11.8 KB

README.md

File metadata and controls

238 lines (149 loc) · 11.8 KB
Raw

License: AGPL v3 Docs gitmoji-changelog Gitpod ready-to-code GitHub Workflow Status Codacy Badge GitHub stars

WP Plugin Template

🐘 ⚗️ WP Plugin Template

Check readme.txt for plugin usage documentation (required by WordPress.org).

This template is highly inspired from hlashbrooke/WordPress Plugin Template.

📘 Docs

See WordPress.org plugin at wordpress.org/plugins/wp-plugin-template.

A technical documentation is also available at https://monogramm.github.io/wp-plugin-template/. You can generate the PHP documentation using PHPDocumentor:

docker run --rm -v "${PWD}:/data" phpdoc/phpdoc:3 run

📈 Changes

All notable changes to this project will be documented in CHANGELOG file.

This (technical) CHANGELOG is generated with ❤️ by gitmoji-changelog.

This project adheres to Semantic Versioning.

🚧 Install

Gitpod

You can use GitPod to run a local development environment: open in Gitpod

If you wish to sign your commits using GitPod, follow the instructions from gitpod-io/gitpod#666:

  • Convert your source .gnugpg directory contents to base64 data: tar -czvf - ./.gnupg | base64 -w 0
  • Place this data into a gitpod environment variable called GNUGPG
  • Get your source signing key: gpg --list-secret-keys --keyid-format LONG
  • Place this data into a gitpod environment variable called GNUGPG_KEY

Docker

You can use the docker test environment to install this plugin. Check tests section for details.

Git clone

If you already have a WordPress instance, you can clone this plugin directly:

cd wp-content/plugins/
git clone https://github.com/Monogramm/wp-plugin-template.git

ZIP Archive

You can build the WordPress plugin zip file using the following command:

./bin/generate-plugin-zip.sh 'wp-plugin-template'

You can then manually install the plugin on your WordPress.

🚀 Usage

How to create a new plugin from this template

You can simply copy the files out of this repo and rename everything as you need it, but to make things easier I have included a shell script in this repo that will automatically copy the files to a new folder, remove all traces of the existing git repo, rename everything in the files according to your new plugin name, and initialise a new git repo in the folder if you choose to do so.

Running the script

You can run the script just like you would run any shell script - it does not take any arguments, so you don't need to worry about that. Once you start the script it will ask for three things:

  1. Plugin name - this must be the full name of your plugin, with correct capitalisation and spacing.
  2. Destination folder - this will be the folder where your new plugin will be created - typically this will be your wp-content/plugins folder. You can provide a path that is relative to the script, or an absolute path - either will work.
  3. Include Grunt support (y/n) - if you enter 'y' here then the Grunt files will be included in the new plugin folder.
  4. Initialize new git repo (y/n) - if you enter 'y' here then a git repo will be initialised in the new plugin folder.

Easy management script

This template provides a shell script for easy management of your plugin.

./manage.sh

API functions

There are a few libraries built into it that will make a number of common tasks a lot easier.

Registering a new post type

Using the post type API and the wrapper function from the main plugin class you can easily register new post types with one line of code. For example if you wanted to register a listing post type then you could do it like this:

WP_Plugin_Template()->register_post_type( 'listing', __( 'Listings', 'wp-plugin-template' ), __( 'Listing', 'wp-plugin-template' ) );

Note that the WP_Plugin_Template() function name and the wp-plugin-template text domain will each be unique to your plugin after you have used the cloning script.

This will register a new post type with all the standard settings. If you would like to modify the post type settings you can use the {$post_type}_register_args filter. See the WordPress codex page for all available arguments.

Registering a new taxonomy

Using the taxonomy API and the wrapper function from the main plugin class you can easily register new taxonomies with one line of code. For example if you wanted to register a location taxonomy that applies to the listing post type then you could do it like this:

WP_Plugin_Template()->register_taxonomy( 'location', __( 'Locations', 'wp-plugin-template' ), __( 'Location', 'wp-plugin-template' ), 'listing' );

Note that the WP_Plugin_Template() function name and the wp-plugin-template text domain will each be unique to your plugin after you have used the cloning script.

This will register a new taxonomy with all the standard settings. If you would like to modify the taxonomy settings you can use the {$taxonomy}_register_args filter. See the WordPress codex page for all available arguments.

Defining your Settings Page Location

Using the filter {base}menu_settings you can define the placement of your settings page. Set the location key to options, menu or submenu. When using submenu also set the parent_slug key to your preferred parent menu, e.g themes.php. For example use the following code to let your options page display under the Appearance parent menu.

$settings['location'] = 'submenu';
$settings['parent_slug'] = 'themes.php';

See respective codex pages for location option defined below:

Calling your Options

Using the Settings API and the wrapper function from the main plugin class you can easily store options from the WP admin like text boxes, radio options, dropdown, etc. You can call the values by using id that you have set under the settings_fields function. For example you have the id - text_field, you can call its value by using get_option('wp_plugin_template_text_field'). Take note that by default, this plugin is using a prefix of wp_plugin_template_ before the id that you will be calling, you can override that value by changing it under the __construct function $this->base variable;

What does this template offers

This template includes the following features:

  • Plugin headers as required by WordPress & WordPress.org
  • Readme.txt file as required by WordPress.org
  • Main plugin class
  • Full & minified Javascript files
  • Grunt.js support
  • Standard enqueue functions for the dashboard and the frontend
  • A library for easily registering a new post type
  • A library for easily registering a new taxonomy
  • A library for handling common admin functions (including adding meta boxes to any post type, displaying settings fields and display custom fields for posts)
  • A complete and versatile settings class like you see here
  • A .pot generation / update to make localisation easier
  • Full text of the AGPLv3 license
  • Automated tests and code quality monitoring using PHPUnit, PHPCS and ESLint
  • GitHub and GitLab templates for Issues and Pull Requests
  • Docker dev and test environments for easy integration into any CI (with current integration to Travis CI and GitHub Actions)
  • Plugin install and uninstall hooks
  • Easy class to manage shortcodes

See the changelog for a complete list of changes as the template develops.

✅ Run tests

You can use the docker-compose file to run a dev / test environment:

./manage.sh start

You can now access a local WordPress env at http://localhost:8080.

Follow the tests logs (Ctrl + C to exit):

./manage.sh logs sut

The sut container will run:

  • PHPUnit for this plugin
  • PHPCS for Code quality

You can also check Travis-CI Travis-CI or GitHub Actions for the latest tests results.

To reset your test environment, you can just drop the containers and the persisted data:

./manage.sh reset

👤 Authors

Monogramm

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page. Check the contributing guide.

👍 Show your support

Give a ⭐ if this project helped you!

📄 License

Copyright © 2020 Monogramm.
This project is AGPL v3 licensed.

This README was generated with ❤️ by readme-md-generator