Skip to content

Latest commit

 

History

History
43 lines (33 loc) · 1.93 KB

README.md

File metadata and controls

43 lines (33 loc) · 1.93 KB
Raw

Sidecar (beta)

Sidecar is the Missing Plugin API for WordPress

Features

Sidecar provides an API for easily creating a WordPress Plugin that has the following features:

  • Admin Pages – One (1) of more linked from one or more Admin Menu(s)/Submenu(s).
  • Admin Tabs – Zero (0) or more per Admin Page.
  • Forms – Zero (0) or more per Admin Tab and/or tab-less Admin Page.
  • Form Fields – One (1) or more per Form.
  • Shortcodes – Zero (0) or more.

Philosophy

Sidecar is designed to allow the plugin developer to get the most functionality with the least amount of work and to minimize time required for testing and adding common features. Sidecar follows the D.R.Y. principle and the Decisions, not Options philosophy. Developers subclass the Plugin Base class and add all features required in the class, directly or indirectly. The Plugin Base class leverages the additional

PHP Classes

Sidecar has the classes for the following functionality:

  • Plugin
  • Admin Page
  • Admin Tab
  • Form
  • Field
  • Shortcodes

Current Feature Caveats

Sidecar currently only supports the following:

  • While in beta, the API is guaranteed to change. If you try it, expect to have to change your code that uses it.
  • Admin pages can only currently have a link appear in the "Settings" menu (without additional coding.)
  • Settings are associated with an Form; each Form has a 1-to-1 correspondence to a group of settings.
  • The Forms and Fields leverage WordPress' Settings API although Sidecar may in the future add functionality that exceeds what the Settings API can support in which case use of the Settings API will be optional.
  • Settings groups are currently not implemented.
  • Shortcodes are currently not implemented.

More Documentation to Come...