Skip to content

WordPress Plugin Framework

The WordPress Plugin Framework (WPPF) is a library of object-oriented classes intended to facilitate the development of custom WordPress plugins in PHP. The framework lays out a file structure using a system of "modules" which organize code into functional components. This project also provides a CLI for quickly generating scaffolding code and further reducing the load of configuration on the developer. This documentation will cover creating code components as well as provide examples of useful framework tools. Through the use of example, I hope to both facilitate and encourage the use of the WordPress Coding Standards.

What this documentation covers

  • Intro: goals, conventions, and how the framework thinks about plugin structure.
  • Build a plugin: a tutorial walking through plugin construction.
  • Framework tools: explanations and examples of tools provided with the framework.
  • CLI reference: all scaffolders and what they generate.
  • API docs: the generated documentation from the codebase.