An output framework for ProcessWire.

Wireframe ProcessWire module and output framework

Wireframe is, in the lack of a better term, an output framework for the ProcessWire CMS/CMF. It loosely follows the MVC (Model-View-Controller) architecture, introducing concepts such as View Controllers to ProcessWire site development.

Technically Wireframe is a combination of a ProcessWire module - called Wireframe - and a set of related classes. Certain features are bundled into a separate module called Wireframe API; this optional companion module can be used to quickly set up a JSON based API.

This README file provides basic instructions for setting Wireframe up. More detailed instructions can be found from https://wireframe-framework.com, and if you'd like to see an example site using Wireframe, be sure to check out https://github.com/wireframe-framework/site-wireframe-boilerplate/.

Getting started


  1. Download and install the Wireframe ProcessWire module

There are a couple of ways to get the module:

  1. Set up the Wireframe directories within the /site/templates/ directory

If your site already has identically named folders you can call them something else, as long as you also adjust the paths in config settings ($config->wireframe array) accordingly. For more details visit https://wireframe-framework.com/docs/configuration-settings/.

Alternatively you can install the site-wireframe-boilerplate site profile, available from GitHub: https://github.com/wireframe-framework/site-wireframe-docs. This is a complete site running on Wireframe, so you may find it useful if you're just starting a new project, but it's not something you'd want to use if you've already got an existing site set up.

  1. Copy wireframe.php from the module's directory to /site/templates/wireframe.php

This is the file that bootstraps Wireframe. If you want to pass variables to Wireframe during init or render phases, you can directly modify this file.

  1. Add wireframe as the alternate filename of the template(s) you want to use Wirerame for

This can be done via the Alternate Template Filename setting found from the template edit screen, and will redirect requests for pages using those templates through the Wireframe bootstrap file.

Note: you don't actually have to route all your templates through Wireframe. In case you want to use other output strategies for some of your templates, that will work just fine: just skip step 4 for those templates.

Resources


License


This project is licensed under the Mozilla Public License Version 2.0.

Install and use modules at your own risk. Always have a site and database backup before installing new modules.

Twitter updates

  • Adding custom actions to ProcessWire image fields in the admin, part of this week’s dev branch additions: More
    27 January 2023
  • ProcessWire 3.0.210 new main/master version released— More
    6 January 2023
  • ProcessWire 3.0.209: Core updates and an interesting AI that knows ProcessWire– More
    30 December 2022

Latest news

  • ProcessWire Weekly #455
    In the 455th issue of ProcessWire Weekly we'll check out the latest core updates, introduce a new third party module called JkPublishPages, and more. Read on!
    Weekly.pw / 28 January 2023
  • ProcessWire 3.0.210 new main/master version
    140 commits, 55 resolved issues, dozens of new features, eight contributors, and five new pull requests make yet another great new version of ProcessWire.
    Blog / 6 January 2023
  • 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