ProcessWire API Explorer

A comprehensive ProcessWire reference that’s always up-to-date, easy-to-use and ready when you are

Get API Explorer Now

API Explorer is a ProcessWire module that creates an application in your admin "Setup" navigation. It provides comprehensive code documentation for ProcessWire API variables, classes and modules. It compiles this information using a combination of existing PWDOC tags, PHPDOC tags, and the PHP Reflection library. Meaning, this application doesn't contain the documentation itself, but rather compiles it by performing comprehensive static analysis directly on the code it documents. A significant benefit to this approach is that the documentation is always up-to-date with the version of ProcessWire that it is running on.

While all of the information presented by API Explorer can also be determined by other means (including our own online API reference) the API Explorer module presents it in a manner that is ideally suited to ProcessWire developers and development processes. API Explorer is the only tool that enables you to see documentation directly mapped to the version of ProcessWire it is running on.

API Explorer is like having a comprehensive ProcessWire reference book on your table, ready to use anytime whether online or not. If you develop anything in ProcessWire, we're confident API Explorer will be one of your favorite tools!

What you’ll find in API Explorer

  • Easily navigate methods, public properties and constants.

  • Covers all of ProcessWire's API variables, core classes and most modules.

  • Also is able to cover 3rd party Wire-derived classes and modules that are documented with phpdoc (and/or pwdoc if used).

  • Many methods and classes include usage examples and further discussion.

  • Complete coverage of method argument types, required vs. optional arguments, and return types.

  • Cross reference links between related methods, argument types and return types when appropriate.

  • On-the-fly ability to hide method arguments, show all arguments, or show only required arguments.

Requirements and additional information

API Explorer is part of the ProDevTools set of modules and currently requires ProcessWire 3.0.40 or newer. In the near future, API Explorer will also support ProcessWire 2.8 as well. API Explorer does not work with ProcessWire 2.7 and earlier.

ProcessWire API Explorer is Copyright 2016 by Ryan Cramer Design, LLC.

Screenshots

More about API Explorer

Get API Explorer Now

Twitter updates

  • We added WebP image support this year and many have been adopting it in existing projects. We look at a process used for migrating existing websites to WebP images— from preliminary considerations to implementation & testing, w/lots of tips & tricks too: More
    16 August 2019
  • Core version 3.0.137 on the dev branch adds the ability to hook multiple methods at once, in a single call. This post details how it works and provides a useful example of how you might put it to use in your development environment— More
    2 August 2019
  • ProcessWire 3.0.136 updates our CKEditor version and adds a new backtrace() method to the core Debug class— More
    26 July 2019

Latest news

  • ProcessWire Weekly #275
    In the 275th issue of ProcessWire Weekly we're going to walk you through the new features included in ProcessWire 3.0.138, cover some WebP related stuff, and highlight recent forum posts and online resources. Read on!
    Weekly.pw / 17 August 2019
  • WebP images on an existing site
    In this post we’ll look at a process used for migrating an existing website to use WebP images. We’ll cover everything from preliminary considerations to implementation and testing, with lots of tips and tricks along the way.
    Blog / 16 August 2019
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer