About Hello Process Module (Example)
A starting point skeleton from which to build your own Process module (for PW 2.6+)
|Category 1||Admin Helpers|
Admin helper modules are those that provide helpful tools, UI enhancements or optimizations to the admin panel (excluding Fieldtype or Inputfield modules).
|Category 2||Process Modules|
Process modules are apps that run in the ProcessWire admin.
|Category 3||Proof 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.
Should be safe for use in production environments. *
|Compatibility||2.6, 2.7, 3.0|
|Date Added||August 18, 2012|
|Last Updated||February 2, 2015|
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.
This module's files should be placed in /site/modules/ProcessHello/
How to install or uninstall modules
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.
To see exactly what this module does, you may want to install it as-is first. Then uninstall and follow the instructions below.
Rename the ProcessHello.module file to be Process[YourModuleName].module.php
Change the class name to be Process[YourModuleName]
Modify and add to this module to make it do what you want.
If your module needs its own CSS and/or JS files, rename those included to be the same as your module name and modify them to do whatever you want. If your module does NOT need CSS and/or JS files then delete them.
Edit the Process[YourModuleName].info.php file to contain info specific to your module.
If you want your module to be configurable, edit the Process[YourModuleName].config.php file, update the configuration, and change the class name as appropriate. If you do not need a configurable module, simply remove the file.
Change all the text here to describe your module and update the README.md file.
Change the copyright line directly below to have your information.
When ready, post your module to GitHub and to modules.processwire.com!
Stop by the ProcessWire forums anytime and we will be glad to help with any questions.
ProcessWire Copyright 2014 by Ryan Cramer
- Admin Helpers
- Core Modules
- Development Tools
- Field Types
- Input Fields
- Language Modules
- Language Packs
- Markup Generation
- Premium Modules
- Process Modules
- Proof of Concept
- Site Profiles
- Social, Feeds, Services
- Text Formatters
- Other Modules
- Users and Access
*Use modules at your own risk. There are no guarantees or warranties. It is recommended that you backup your site and database before installing new modules.