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

  • ProcessWire 3.0.133 adds a useful new Page::meta() method for a new type of page-specific persistent data storage, adds the ability for users to create their own bookmarks in Lister, and has a handy and time saving update for the asmSelect input type— More
    14 June 2019
  • New post: This week we’ll take a look at 3 different WEBP image strategies that you can use in ProcessWire 3.0.132+. Then we’ll dive into a major update for the Google Client API module, and finish up by outlining some useful new updates in FormBuilder— More
    31 May 2019
  • New post: This week we've added WEBP support in ProcessWire thanks to a GitHub pull request from Horst Nogajski. This enables you to have highly optimized image output in PW and I think you’ll really like the difference it makes— More
    24 May 2019

Latest news

  • ProcessWire Weekly #267
    In the 267th issue of ProcessWire Weekly we're going to cover the latest changes in the development branch of ProcessWire, introduce a new module called MarkupMenu, and highlight a brand new site of the week. Read on!
    Weekly.pw / 22 June 2019
  • ProcessWire 3.0.133 core updates
    ProcessWire 3.0.133 adds a useful new $page->meta() method for a new type of page-specific persistent data storage, adds the ability for users to create their own bookmarks in Lister, and has a handy and time saving update for the asmSelect input type. Read on for all the details, examples and screenshots.
    Blog / 14 June 2019
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer