An open API service indexing awesome lists of open source software.

https://github.com/herm71/blackbird-starter-plugin

A starter plugin for plugin development. Registers new settings page with custom options.
https://github.com/herm71/blackbird-starter-plugin

Last synced: about 1 month ago
JSON representation

A starter plugin for plugin development. Registers new settings page with custom options.

Awesome Lists containing this project

README

          

# Blackbird Starter Plugin

# Synopsis

This is a starter-plugin, a basis to build on. This plugin was developed using the [WordPress Settings API Tutorial](http://ottopress.com/2009/wordpress-settings-api-tutorial/).
The plugin creates a new "Settings" admin page, and registers a few input fields. You can copy and paste to add more options based on the examples given.

Because this was developed as a learning tool, it is heavily commented. The bulk of the code resides in `blackbird-starter-plugin/lib/functions/bb_admin.php`. I have referenced the API calls in the heading comments of each section of the code. This is an evolving process, but I hope to have given enough direction to get you started.

# Motivation

I developed this for my own purposes. I came across the [**Getting Started with WordPress Plugin Development: The Ultimate Guide**](https://premium.wpmudev.org/blog/wordpress-plugin-development-guide/) in a web search. I wanted to get to know the code so I decided to create my own version of it. Something I can clone into a project and craft to my liking. Also, to familiarize myself with the **WordPress Settings API**.

# Installation

1. Download the [Blackbird Starter Plugin zip file] (https://github.com/Herm71/blackbird-starter-plugin.git).
2. In your WordPress Dashboard, navigate to **Plugins**.
3. Click the **Add New** button at the top of the page.
4. Click the **Upload Plugin** button at the top of the screen.
5. Click **Choose File**
5. Navigate to the **blackbird-starter-plugin.zip** file you downloaded from [GitHub](https://www.github.com) and click **open**, then click **Install Now**.
6. Once the plugin is installed, click **Activate Plugin**.
7. After the plugin is installed, navigate to **Settings** in the dashboard and you will find a new sub-menu titled, **"Blackbird Custom Plugin Menu."**

# Contributors

Again, I give credit to [Otto on WordPress](http://ottopress.com) for introducing me to the process and the code structure. Otherwise all code was written by me, [Jason Chafin](http://www.jasonchafin.com), founder and president of [Blackbird Consulting](http://www.blackbirdconsult.com).

**Twitter:** @BlackbirdConsul

**GitHub:** `/Herm71`

# License

[Creative Commons 1.0 Universal](LICENSE)

# Change Log
All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## 0.1.0 - 2016-02-044
### Changed
- Rewrote plugin structure
- Added basic checkbox form to Options page

## 0.0.1 - 2016-02-044
### Added
- Initial Commit
- Developed plugin

## Changelog Template

## 0.0.0 - 2016-01-22
### Added
- Initial Commit
- Developed plugin

### Changed
- Initial Commit
- Developed plugin

### Fixed
- Initial Commit
- Developed plugin

### Removed
- Initial Commit
- Developed plugin