ProcessWire apigen documentation

Use this as another way to view the code comments for details on any given function in ProcessWire. But it's generally better to use the other API docs rather than this, as much of what you see in these apigen docs is not stuff you would typically use in developing a site.

Classes summary
Breadcrumb	class Breadcrumb
Breadcrumbs	class Breadcrumbs
CacheFile	ProcessWire CacheFile
Comment	ProcessWire Fieldtype Comments > Comment
CommentArray	ProcessWire FieldtypeComments > CommentArray
CommentFilter	ProcessWire FieldtypeComments > CommentFilter
CommentForm	Default/example implementation of the CommentFormInterface
CommentList	CommentList provides the default implementation of the CommentListInterface interface.
Config	ProcessWire Config
Database	Database class provides a layer on top of mysqli
DatabaseQuery	ProcessWire DatabaseQuery
DatabaseQuerySelect	ProcessWire DatabaseQuerySelect
DatabaseQuerySelectFulltext	ProcessWire DatabaseQuerySelectFulltext
DatabaseStopwords	ProcessWire DatabaseStopwords
Debug	ProcessWire Debug
Field	ProcessWire Field
Fieldgroup	ProcessWire Fieldgroup
Fieldgroups	Maintains collection of all fieldgroups
FieldgroupsArray	Array of Fieldgroup instances, as used by the Fieldgroups class
Fields	Manages the collection of all Field instances, not specific to any one Fieldgroup
FieldsArray	WireArray of Field instances, as used by Fields class
Fieldtype	ProcessWire Fieldtype Base
FieldtypeMulti	ProcessWire FieldtypeMulti
Fieldtypes	ProcessWire Fieldtypes
FileLog	ProcessWire FileLog
FilenameArray
Fuel	ProcessWire Fuel
HookEvent	Instances of HookEvent are passed to Hook handlers when their requested method has been called.
ImageSizer	ProcessWire ImageSizer
Inputfield	An Inputfield an actual form input field widget, and this is provided as the base class for different kinds of form input widgets provided as modules.
InputfieldsArray	A WireArray of Inputfield instances.
InputfieldWrapper	A type of Inputfield that is designed specifically to wrap other Inputfields
Language	ProcessWire Language (single) Page Class
LanguageParser	ProcessWire Language Parser
Languages	ProcessWire Languages (plural) Class
LanguagesPageFieldValue	Serves as a multi-language value placeholder for field values that contain a value in more than one language.
LanguageSupportInstall	Installer and uninstaller for LanguageSupport module
LanguageTranslator	ProcessWire Language Translator
Markdown_Parser
MarkdownExtra_Parser
ModuleJS	ProcessWire ModuleJS
ModulePlaceholder	ProcessWire ModulePlaceholder
Modules	ProcessWire Modules
Notice	Base class that holds a message, source class, and timestamp
NoticeError	A notice that's indicated to be an error
NoticeMessage	A notice that's indicated to be informational
Notices	A class to contain multiple Notice instances, whether messages or errors
NullPage	Placeholder class for non-existant and non-saveable Page
Page	ProcessWire Page
PageArray	ProcessWire PageArray
Pagefile	ProcessWire Pagefile
Pagefiles	ProcessWire Pagefiles
PagefilesManager	ProcessWire PagefilesManager
PageFinder	ProcessWire PageFinder
Pageimage	ProcessWire Pageimage
Pageimages	ProcessWire Pageimages
PagerNav	Collection of Pager items that determines which pagination links should be used
PagerNavItem	An individual pager item
Pages	ProcessWire Pages
PagesAccess	ProcessWire Pages Access
PagesSortfields	ProcessWire PagesSortfields
PagesType	ProcessWire PagesType
Paths	ProcessWire Paths
Permission	ProcessWire Permission Page
Permissions	ProcessWire PagesType
Process	ProcessWire Process
ProcessController	A Controller for Process* Modules
ProcessWire	ProcessWire Bootstrap class
Role	ProcessWire Role Page
Roles	ProcessWire PagesType
Sanitizer	ProcessWire Sanitizer
Selector	Selector maintains a single selector consisting of field name, operator, and value.
SelectorBitwiseAnd	Selector that matches a bitwise AND '&'
SelectorContains	Selector that matches one string value (phrase) that happens to be present in another string value
SelectorContainsLike	Same as SelectorContains but serves as operator placeholder for SQL LIKE operations
SelectorContainsWords	Selector that matches one string value that happens to have all of it's words present in another string value (regardless of individual word location)
SelectorEnds	Selector that matches if the value exists at the end of another value
SelectorEqual	Selector that matches equality between two values
SelectorGreaterThan	Selector that matches one value greater than another
SelectorGreaterThanEqual	Selector that matches one value greater than or equal to another
SelectorLessThan	Selector that matches one value less than another
SelectorLessThanEqual	Selector that matches one value less than or equal to another
SelectorNotEqual	Selector that matches two values that aren't equal
Selectors	ProcessWire WireArray
SelectorStarts	Selector that matches if the value exists at the beginning of another value
Session	ProcessWire Session
SessionCSRF	ProcessWire CSRF Protection
SmartyPants_Parser
SmartyPantsTypographer_Parser
SystemUpdate1	Adds a 'data' column to the fieldgroups_fields table
Template	ProcessWire Template
TemplateFile	ProcessWire TemplateFile
Templates	Manages and provides access to all the Template instances
TemplatesArray	WireArray of Template instances
Textformatter	ProcessWire Textformatter
Textile
User	ProcessWire UserPage
Users	ProcessWire PagesType
Wire	ProcessWire Base Class "Wire"
WireArray	ProcessWire WireArray
WireData	ProcessWire WireData
WireInput	Manages the group of GET, POST, COOKIE and whitelist vars, each of which is a WireInputData object.
WireInputData	WireInputData manages one of GET, POST, COOKIE, or whitelist
WireSaveableItems	ProcessWire WireSaveableItems
WireSaveableItemsLookup	ProcessWire WireSaveableItemsLookup
WireUpload	ProcessWire WireUpload

Interfaces summary
CommentFormInterface	Interface for building CommentForms, followed by an example/default implementation in the CommentForm class
CommentListInterface
ConfigurableModule	ConfigurableModule is an interface that indicates the module is configurable by providing a getModuleConfigInputfields method and config properties may be get/set directly like:
FieldtypeLanguageInterface	Interface used to indicate that the Fieldtype supports multiple languages
FieldtypePageTitleCompatible	Indicates that a given Fieldtype may be used for page titles
HasLookupItems	For classes that contain lookup items, as used by WireSaveableItemsLookup
HasRoles
InputfieldHasArrayValue	Inputfields that implement this interface always have a $value attribute that is an array
Module	Base interface for all ProcessWire Modules
Saveable	For classes that are saved to a database or disk.
TrackChanges	For classes that need to track changes made by other objects.

Exceptions summary
ProcessController404Exception	Exception thrown when a requested Process or Process method is requested that doesn't exist
ProcessControllerPermissionException	Exception thrown when the user doesn't have access to execute the requested Process
Wire404Exception	Triggered when a requested item does not exist and generates a fatal error
WireDatabaseException	WireDatabaseException is the exception thrown by the Database class
WireException	Generic ProcessWire exception
WirePermissionException	Triggered when access to a resource is not allowed

Functions summary
__	Perform a language translation
_n	Perform a language translation with singular and plural versions
_x	Perform a language translation in a specific context
fuel	Return all Fuel, or specified ProcessWire API variable, or NULL if it doesn't exist.
identify_modifier_markdown
Markdown
mdwp_add_p
mdwp_hide_tags
mdwp_show_tags
mdwp_strip_p
ProcessWireClassLoader	Handles dynamic loading of classes as registered with spl_autoload_register
ProcessWireHostSiteConfig	Multi-domain configuration: Optionally define alternate /site/ dirs according to host
ProcessWireShutdown	Look for errors at shutdown and log them, plus echo the error if the page is editable
removeNewlines	Remove newlines from the given string and return it
SmartDashes
SmartEllipsis
SmartQuotes
smarty_modifier_markdown
smarty_modifier_smartypants
SmartyPants
tabIndent
unregisterGLOBALS	Emulate register globals OFF
wire	Return a ProcessWire API variable, or NULL if it doesn't exist
wireDecodeJSON	Decode JSON to array
wireEncodeJSON	Encode array for storage and remove empty values
wireMkdir	Create a directory that is writable to ProcessWire and uses the $config chmod settings

Namespaces

Classes

Interfaces

Exceptions

Functions

ProcessWire apigen documentation