About Hello Process Module (Example)

A starting point skeleton from which to build your own Process module (for PW 2.6+)

Category 1Admin Helpers
Admin helper modules are those that provide helpful tools, UI enhancements or optimizations to the admin panel (excluding Fieldtype or Inputfield modules).
Category 2Process Modules
Process modules are apps that run in the ProcessWire admin.
Category 3Proof of Concept
Proof of concept modules are designed as examples or starting points for others to build from. May not be ideal for users wanting to plug-n-play.
Release StateStable
Should be safe for use in production environments. *
Authorryan
Module Version0.0.2
Class NameProcessHello
Compatibility2.6, 2.7, 3.0
Date AddedAugust 18, 2012
Last UpdatedFebruary 2, 2015
Recommended ByNew recommendations may take up to 1 day to appear.

Details

A starting point skeleton from which to build your own Process module (for PW 2.6+). Process modules are used primarily for building admin applications and tools. This module also creates a page in the ProcessWire admin to run itself from.

Instructions

This module's files should be placed in /site/modules/ProcessHello/
How to install or uninstall modules

README

Hello Process Module

A starting point skeleton from which to build your own Process module.Process modules are used primarily for building admin applications and tools. This module also creates a page in the ProcessWire admin to run itself from.

This version of ProcessHello is designed for ProcessWire 2.5.5 or newer.

How to use this to make your own Process module

To see exactly what this module does, you may want to install it as-is first.Then uninstall and follow the instructions below.

  1. Rename the ProcessHello.module file to be Process[YourModuleName].module.php

  2. Change the class name to be Process[YourModuleName]

  3. Modify and add to this module to make it do what you want.

  4. If your module needs its own CSS and/or JS files, rename those included to be the same asyour module name and modify them to do whatever you want. If your module does NOT need CSS and/or JS files then delete them.

  5. Edit the Process[YourModuleName].info.php file to contain info specific to your module.

  6. If you want your module to be configurable, edit the Process[YourModuleName].config.phpfile, update the configuration, and change the class name as appropriate. If you do not need a configurable module, simply remove the file.

  7. Change all the text here to describe your module and update the README.md file.

  8. Change the copyright line directly below to have your information.

  9. When ready, post your module to GitHub and to modules.processwire.com!

Stop by the ProcessWire forums anytime and we will be gladto help with any questions.


ProcessWire Copyright 2014 by Ryan Cramer

Comments

No comments yet. Be the first to post!

Post a Comment

Your e-mail is kept confidential and not included with your comment. Website is optional.