Code Monkey home page Code Monkey logo

plugin-name's Introduction

Boilerplate for building WordPress plugins.

WordPress Plugin Boilerplate

Boilerplate for building WordPress plugins.

Fundamental

Requirements

  • PHP version 7.0 or greater
  • WordPress 5.0 or greater
  • Docker 20.10 or greater (Development)
  • Grunt 1.4.0 (Development)

Features

PHP Standards Recommendations

WordPress

  • Settings page
  • About page
  • Contextual Help
  • Plugin action links

Install

Composer

composer create-project --no-install --remove-vcs arya/wordpress-plugin your-plugin dev-master
cd your-plugin

You'll need to rename

  1. The directory plugin-name to your-plugin
  2. The file plugin-name.php to your-plugin.php

Then find and replace in all the templates

  1. plugin-name to your-plugin
  2. plugin_name to your_plugin
  3. PLUGIN_NAME to YOUR_PLUGIN
  4. PluginName to YourPlugin (Namespace)

If you are a Linux or macOS user, you can use the command sed

egrep -lRZ 'plugin-name' . | xargs -0 -l sed -i -e 's/plugin-name/your-plugin/g'

Finally, edit the composer.json file to declare plugin dependencies

composer install --prefer-dist

Happy Coding!

Grunt

Install Grunt

sudo npm install --global grunt-cli
npm install --silent

Build (Minify resources)

grunt

Handle the version of the plugin

grunt version

Docker

Create and start the container

docker compose up -d

Stop and remove containers, networks, images, and volumes

docker compose down --volumes

License

This project is licensed under the GNU General Public License, Version 2.0. See LICENSE for the full license text.

plugin-name's People

Contributors

aochoae avatar dependabot[bot] avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.