Fuel maintains a single instance each of multiple objects used throughout the application.
The objects contained in fuel provide access to the ProcessWire API. For instance, $pages, $users, $fields, and so on. The fuel is required to keep the system running, so to speak.
This file is licensed under the MIT license
Click any linked item for full usage details and examples. Hookable methods are indicated with the icon.
Common
| Name | Return | Summary | |
|---|---|---|---|
$fuel->get() $fuel->get($key) $fuel->get($key) | None | ||
$fuel->getArray() $fuel->getArray() $fuel->getArray() | None | ||
$fuel->getIterator() $fuel->getIterator() $fuel->getIterator() | None | ||
Fuel::isCommon() Fuel::isCommon($name) Fuel::isCommon($name) | None | ||
$fuel->remove() $fuel->remove($key) $fuel->remove($key) | bool | Remove an API variable from the Fuel | |
$fuel->set() $fuel->set(string $key, $value) $fuel->set(string $key, $value, bool $lock = false) | $this | @param string $key API variable name to set - should be valid PHP variable name. |
Properties
| Name | Return | Summary | |
|---|---|---|---|
| $fuel->cache | WireCache | ||
| $fuel->config | Config | ||
| $fuel->database | WireDatabasePDO | ||
| $fuel->datetime | WireDateTime | ||
| $fuel->db | Database | ||
| $fuel->fieldgroups | Fieldgroups | ||
| $fuel->fields | Fields | ||
| $fuel->fieldtypes | Fieldtypes | ||
| $fuel->files | WireFileTools | ||
| $fuel->fuel | Fuel | ||
| $fuel->input | WireInput | ||
| $fuel->languages | Languages | If LanguageSupport installed | |
| $fuel->mail | WireMailTools | ||
| $fuel->modules | Modules | ||
| $fuel->notices | Notices | ||
| $fuel->page | Page | ||
| $fuel->pages | Pages | ||
| $fuel->permissions | Permissions | ||
| $fuel->process | Process | ||
| $fuel->profiler | WireProfilerInterface | ||
| $fuel->roles | Roles | ||
| $fuel->sanitizer | Sanitizer | ||
| $fuel->session | Session | ||
| $fuel->templates | Templates | ||
| $fuel->user | User | ||
| $fuel->users | Users | ||
| $fuel->wire | ProcessWire |
API reference based on ProcessWire core version 3.0.252