https://github.com/uriweb/uri-plugin-template
:rocket: A template for creating WordPress plugins with dev tools
https://github.com/uriweb/uri-plugin-template
template wordpress wordpress-plugin
Last synced: 21 days ago
JSON representation
:rocket: A template for creating WordPress plugins with dev tools
- Host: GitHub
- URL: https://github.com/uriweb/uri-plugin-template
- Owner: uriweb
- License: gpl-3.0
- Created: 2018-10-01T18:59:01.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-06-17T18:01:54.000Z (12 months ago)
- Last Synced: 2025-07-24T11:03:13.382Z (11 months ago)
- Topics: template, wordpress, wordpress-plugin
- Language: JavaScript
- Homepage:
- Size: 1020 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# URI Plugin Template
The URI Plugin Template repository is a base template for building WordPress plugins with gulp, PHP Code Sniffer, and Travis CI.
## How do I get set up?
There are a few things you need to do to get up and running:
1. Download [master.zip](https://github.com/uriweb/uri-plugin-template/archive/master.zip) and unzip it
2. Rename `.gitattributes-sample` to `.gitattributes`
3. Rename the main plugin file [`uri-plugin-template.php`](https://github.com/uriweb/uri-plugin-template/blob/master/uri-plugin-template.php) and update the header to match your new plugin.
4. Update [`package.json`](https://github.com/uriweb/uri-plugin-template/blob/master/package.json) with your new plugin info.
5. Update the `@package` tag in [`src/js/script.js`](https://github.com/uriweb/uri-plugin-template/blob/master/src/js/script.js).
6. Gulp runs a task to update the plugin version number from `package.json`, so you don't have to update it in two places. However, gulp looks for the main plugin file by name in order to do this, so you'll need to update [`gulp.js`](https://github.com/uriweb/uri-plugin-template/blob/e7208805f9fedd83c29739de3307e91a0e64aaea/gulpfile.js#L86) to reflect the new name.
7. If you already have gulp and gulp-cli installed globally, install gulp and devDependencies in the project directory:
```shell
$ cd
$ npm install gulp
$ npm install --save-dev
```
Finally, don't forget to update this readme.
**For a more thorough install, and for PHP Code Sniffer support, head over to [SETUP.md](https://github.com/uriweb/uri-plugin-template/blob/master/SETUP.md).**
## Plugin Details
[](https://travis-ci.com/uriweb/uri-plugin-template)
[](https://www.codefactor.io/repository/github/uriweb/uri-plugin-template/overview/master)
[](https://www.codacy.com/app/uriweb/uri-plugin-template?utm_source=github.com&utm_medium=referral&utm_content=uriweb/uri-plugin-template&utm_campaign=Badge_Grade)
[](https://david-dm.org/uriweb/uri-plugin-template?type=dev)
URI Plugin Template
A base template for building WordPress plugins with gulp, PHP Code Sniffer, and Travis CI.
Contributors: Brandon Fuller
Tags: plugins
Requires at least: 4.0
Tested up to: 4.9
Stable tag: 0.1.0