ProcessWire

https://github.com/phlppschrr/processwire-api-docs
Admin
ProcessWire is a powerful and flexible open-source content management system (CMS) and content...
Tokens:2,073,634
Snippets:21,400
Trust Score:5.8
License:MPL-2.0
Update:11 hours ago
Show doc for...
Tokens:
Raw
### install($filename)

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/Pageimage/index.md

Installs the image from the given filename.

```APIDOC
## install($filename)

### Description
Installs the image from the given filename.

### Method
install

### Parameters
- **$filename** (string) - Required - The filename to install.
```

--------------------------------

### Example: Get and set Pagefile description with multi-language support

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/Pagefile/method-description.md

Shows how to get a Pagefile and set or get its description for specific languages or the current language. Use this when working with multi-language environments; for non-multi-language setups, prefer the Pagefile::$description property directly.

```php
// Get a Pagefile to work with
$pagefile = $page->files->first();

// Setting description
$pagefile->description('en', 'Setting English description');
$pagefile->description('de', 'Setting German description');

// Getting description for current language (whatever it happens to be)
echo $pagefile->description();

// Getting description for language "de"
echo $pagefile->description('de');
```

--------------------------------

### Session get and set examples

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/FunctionsAPI/method-session.md

Shows direct, regular, and shortcut syntax for getting and setting session values using the session() function.

```php
// Get a value from the session
$foo = session()->foo; // direct syntax
$foo = session()->get('foo'); // regular syntax
$foo = session('foo'); // shortcut syntax

// Set a value to the session
session()->foo = 'bar'; // direct syntax
session()->set('foo', 'bar');  // regular syntax
session('foo', 'bar'); // shortcut syntax
```

--------------------------------

### Example: set and get data values

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/WireArray/method-data.md

Shows how to set a data value, retrieve it, and get all data. The first call sets 'foo' to 'bar', the second retrieves it, and the third returns all data.

```php
// set a data value named 'foo' to value 'bar'
$a->data('foo', 'bar');

// retrieve the previously set data value
$bar = $a->data('foo');

// get all previously set data
$all = $a->data();
```

--------------------------------

### setting() function example

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/FunctionsAPI/method-setting.md

Demonstrates setting and getting runtime settings using the setting() function. Includes setting a single value, getting a value, setting multiple values with an array, retrieving all settings, and unsetting a setting.

```php
// set a setting named “foo” to value “bar”
setting('foo', 'bar');

// get a setting named “foo”
$value = setting('foo');

// set or replace multiple settings
setting([
  'foo' => 'value',
  'bar' => 123,
  'baz' => [ 'foo', 'bar', 'baz' ]
]);

// get all settings in associative array
$a = setting();

// to unset a setting
setting(false, 'foo');
```

--------------------------------

### Example: Using config() to get and set configuration values

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/FunctionsAPI/method-config.md

Shows how to use the config() function to retrieve the $config API variable, get values like debug, and set values using both property and shortcut syntax.

```php
$config = config(); // Simply get $config API var
$debug = config()->debug; // Get value of debug
$debug = config('debug'); // Same as above, shortcut syntax
config()->debug = true; // Set value of debug
config('debug', true);  // Same as above, shortcut syntax
```

--------------------------------

### Example: Get and find users with shortcut syntax

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/FunctionsAPI/method-users.md

Shows regular and shortcut syntax for getting a single user by name and finding multiple users by selector. The shortcut form passes the argument directly to get() or find().

```php
// Get a single user (regular and shortcut syntax)
$u = users()->get('karen');
$u = users('karen');

// Find multiple users (regular and shortcut syntax)
$us = users()->find('roles.name=editor');
$us = users('roles.name=editor');
```

--------------------------------

### Get PagePathHistory module instance

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/PagesPathFinder/method-pagepathhistorymodule.md

Returns the PagePathHistory module instance if installed, otherwise false. Basic usage example.

```php
// basic usage
$pagePathHistory = $pagesPathFinder->pagePathHistoryModule();
```

--------------------------------

### Example: $this->add() call

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/ModuleConfig/method-__construct.md

Shows the start of the method body using $this->add() to add the config fields array.

```php
$this->add(array(
```

--------------------------------

### Basic usage of backupStartFile()

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/WireDatabaseBackup/method-backupstartfile.md

Starts a new backup file by adding an info header. Returns a boolean indicating success.

```php
// basic usage
$bool = $wireDatabaseBackup->backupStartFile($file, $options);
```

--------------------------------

### Example: Getting, modifying and saving all module config data

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/Modules/method-___saveconfig.md

Shows how to retrieve all configuration data for a module, modify a property, and save it back. Also demonstrates getting and saving a single configuration property.

```php
// Getting, modifying and saving all module config data
$data = $modules->getConfig('HelloWorld');
$data['greeting'] = 'Hello World! How are you today?';
$modules->saveConfig('HelloWorld', $data);

// Getting a single configuration property
$value = $modules->getConfig('HelloWorld', 'some_property');

// Saving a single configuration property
$modules->saveConfig('HelloWorld', 'some_property', 'New Value');
```

--------------------------------

### backupStartFile($file, array $options): bool

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/WireDatabaseBackup/method-backupstartfile.md

Starts a new backup file by adding an info header to the top. Returns a boolean indicating success.

```APIDOC
## backupStartFile($file, array $options): bool

### Description
Starts a new backup file, adding an info header to the top.

### Method
backupStartFile

### Endpoint
$wireDatabaseBackup->backupStartFile($file, array $options)

### Parameters
- **$file** (string) - Required - The file path for the backup.
- **$options** (array) - Required - Options for the backup.

### Return Value
- **bool** - Returns true on success, false on failure.

### Usage Example
```php
$bool = $wireDatabaseBackup->backupStartFile($file, $options);
```
```

--------------------------------

### Get disk path with $config->path()

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/Config/method-path.md

Retrieves the disk path for a requested resource or module. The example shows getting the PW installation root path using 'root' and the equivalent alternate syntax $config->paths->root.

```php
// Get the PW installation root disk path
$path = $config->path('root');

// Same thing, using alternate syntax
$path = $config->paths->root;
```

--------------------------------

### Usage with all arguments for backupStartFile()

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/WireDatabaseBackup/method-backupstartfile.md

Calls backupStartFile() with both required arguments: $file (string) and $options (array). Returns a boolean.

```php
// usage with all arguments
$bool = $wireDatabaseBackup->backupStartFile($file, array $options);
```

--------------------------------

### Get module with $modules->get() and direct property access

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/Modules/method-get.md

Retrieves the MarkupAdminDataTable module using both the get() method and direct property access. If the module is not installed but installable, it will be installed and initialized automatically.

```php
// Get the MarkupAdminDataTable module
$table = $modules->get('MarkupAdminDataTable');

// You can also do this
$table = $modules->MarkupAdminDataTable;
```

--------------------------------

### $modules->get($key)

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/Modules/method-get.md

Retrieves a module by name or database ID. If the module is not installed but is installable, it will be installed, instantiated, and initialized automatically. Returns the module instance or null if not found.

```APIDOC
## $modules->get($key)

### Description
Retrieves a module by name or database ID. If the module is not installed but is installable, it will be installed, instantiated, and initialized automatically. Returns the module instance or null if not found.

### Method
`get`

### Signature
`$modules->get($key)`

### Parameters
- **$key** (string|int) - Required - Module name or database ID.

### Return Value
- **Module|_Module|null** - Returns a Module instance or null if not found.

### Exceptions
- **WirePermissionException** - If the module requires a permission the user does not have.

### Example
```php
// Get the MarkupAdminDataTable module
$table = $modules->get('MarkupAdminDataTable');

// You can also do this
$table = $modules->MarkupAdminDataTable;
```

### Usage
```php
// basic usage
$module = $modules->get($key);
```

### See Also
- [Modules::getModule()](method-getmodule.md)
- [Modules::isInstalled()](method-isinstalled.md)
```

--------------------------------

### install($filename): void

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/Pagefile/group-other.md

Installs a file.

```APIDOC
## Method: install($filename): void

### Description
Installs a file.

### Parameters
- **$filename** (string) - Required - The filename to install.

### Return Type
void
```

--------------------------------

### Example: Set, get, delete, and retrieve meta values

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/Page/method-meta.md

Shows how to set, get, delete, and retrieve page meta data using the WireDataDB instance and the shorter syntax. Setting a value saves it immediately to the DB; getting loads it immediately. Values must be basic PHP types (arrays, strings, numbers); objects are not supported.

```php
// set and save a meta value
$page->meta()->set('colors', [ 'red', 'green', 'blue' ]);

// get a meta value
$colors = $page->meta()->get('colors');

// alternate shorter syntax for either of the above
$page->meta('colors', [ 'red', 'green', 'blue' ]); // set
$colors = $page->meta('colors'); // get

// delete a meta value
$page->meta()->remove('colors');

// get the WireDataDB instance that stores the meta values,
// it has all the same methods as WireData objects...
$meta = $page->meta();

// ...such as, get all values in an array:
$values = $meta->getArray();
```

--------------------------------

### Usage with all arguments for $config->moduleInstall()

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/Config/method-moduleinstall.md

Shows the usage of moduleInstall with all arguments, $key and $value, returning an array or string.

```php
// usage with all arguments
$array = $config->moduleInstall($key = '', $value = null);
```

--------------------------------

### $fieldtypes->get($key)

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/Fieldtypes/method-get.md

Returns the instantiated Fieldtype module for a given Fieldtype name or class name. If the Fieldtype is not already installed, it will be installed automatically.

```APIDOC
## $fieldtypes->get($key)

### Description
Returns the instantiated Fieldtype module for a given Fieldtype name or class name. If the Fieldtype is not already installed, it will be installed automatically.

### Method
`get`

### Arguments
- `$key` (string) - Required - Fieldtype name or class name, or dynamic property of Fieldtypes

### Return Value
- `Fieldtype|null` - The instantiated Fieldtype module, or null if not found.

### Usage Example
```php
$fieldtype = $fieldtypes->get($key);
```
```

--------------------------------

### Basic usage of $config->moduleInstall()

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/Config/method-moduleinstall.md

Shows the basic usage of the moduleInstall method with no arguments, returning an array or string.

```php
// basic usage
$array = $config->moduleInstall();
```

--------------------------------

### install()

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/modules/LanguageSupport/LanguageSupportInstall/method-___install.md

Installs the LanguageSupport module and related modules. This method is hookable, allowing custom logic to be executed before or after the installation process.

```APIDOC
## install()

### Description
Installs the LanguageSupport module and related modules. This method is hookable, allowing custom logic to be executed before or after the installation process.

### Method
install

### Endpoint
$languageSupportInstall->install()

### Parameters
None

### Request Example
```php
// basic usage
$result = $languageSupportInstall->install();
```

### Response
#### Success Response
- **$result** (mixed) - The result of the installation process.

#### Response Example
```php
$result = $languageSupportInstall->install();
```

### Hooking
- Hookable method name: `install`
- Implementation: `___install`
- Hook with: `LanguageSupportInstall::install`

#### Hooking Before
```php
$this->addHookBefore('LanguageSupportInstall::install', function(HookEvent $event) {
  $languageSupportInstall = $event->object;

  // Your code here
});
```

#### Hooking After
```php
$this->addHookAfter('LanguageSupportInstall::install', function(HookEvent $event) {
  $languageSupportInstall = $event->object;

  // Your code here

  // Optionally modify return value
  $return = $event->return;
  $event->return = $return;
});
```
```

--------------------------------

### Example getConfigInputfields() implementation

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/Inputfield/method-___getconfiginputfields.md

Shows how to extend getConfigInputfields() to add custom configuration fields. Call parent method to get defaults and the InputfieldWrapper, then add new Inputfield instances. Fields with names starting with underscore are for runtime use and not stored in the database.

```php
// Example getConfigInputfields() implementation
public function ___getConfigInputfields() {
  // Get the defaults and $inputfields wrapper we can add to
  $inputfields = parent::___getConfigInputfields();
  // Add a new Inputfield to it
  $f = $this->wire('modules')->get('InputfieldText');
  $f->attr('name', 'first_name');
  $f->attr('value', $this->get('first_name'));
  $f->label = 'Your First Name';
  $inputfields->add($f);
  return $inputfields;
}
```

--------------------------------

### install()

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/AdminTheme/index.md

(hookable) Install the admin theme.

```APIDOC
## install()

### Description
(hookable) Install the admin theme.

### Method
`install()`

### Parameters
None

### Returns
- **void**
```

--------------------------------

### Basic usage of $fieldtypes->get($key)

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/Fieldtypes/method-get.md

Retrieves an instantiated Fieldtype module by name or class name. If the Fieldtype is not installed, it is installed automatically. Returns a Fieldtype object or null if not found.

```php
// basic usage
$fieldtype = $fieldtypes->get($key);
```

--------------------------------

### Basic usage of $languageSupportInstall->install()

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/modules/LanguageSupport/LanguageSupportInstall/method-___install.md

Installs the module and related modules. Returns a result.

```php
// basic usage
$result = $languageSupportInstall->install();
```

--------------------------------

### get(string $key): array|mixed|null|string

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/Selector/index.md

Gets a property of the Selector.

```APIDOC
## get(string $key): array|mixed|null|string

### Description
Get a property.

### Method
get

### Parameters
- **$key** (string) - Required - The property key.

### Returns
- **array|mixed|null|string** - The property value.
```

--------------------------------

### install()

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/Process/method-___install.md

Installs the module as per the Module interface. By default, a permission equal to the class name is installed unless overridden by the 'permission' property in the module information array.

```APIDOC
## install()

### Description
Installs the module as per the Module interface. By default, a permission equal to the class name is installed unless overridden by the 'permission' property in the module information array.

### Method
install()

### Endpoint
Process::install()

### Parameters
None

### Request Example
```php
// basic usage
$result = $process->install();
```

### Response
#### Success Response
- **$result** (mixed) - The result of the installation process.

#### Response Example
```php
$result = $process->install();
```

### Hooking
- Hookable method name: `install`
- Implementation: `___install`
- Hook with: `Process::install`

#### Hooking Before
```php
$this->addHookBefore('Process::install', function(HookEvent $event) {
  $process = $event->object;

  // Your code here
});
```

#### Hooking After
```php
$this->addHookAfter('Process::install', function(HookEvent $event) {
  $process = $event->object;

  // Your code here

  // Optionally modify return value
  $return = $event->return;
  $event->return = $return;
});
```
```

--------------------------------

### Fieldtype::install()

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/Fieldtype/method-___install.md

Installs the Fieldtype, called once at installation time by Modules::install(). Use this method to perform any custom setup beyond ___createTable() if needed.

```APIDOC
## Fieldtype::install()

### Description
Installs the Fieldtype. Called once at time of installation by Modules::install(). If custom Fieldtype classes need to perform any setup beyond that performed in ___createTable(), this method is where they should do it. This is not required, and probably not applicable to most.

### Method
install()

### Parameters
None

### Return Value
- **$result** (mixed) - The result of the installation process.

### Exceptions
- **WireException** - Should throw an Exception on failure to install.

### Usage Example
```php
$result = $fieldtype->install();
```

### Hooking
- Hookable method name: `install`
- Implementation: `___install`
- Hook with: `Fieldtype::install`

#### Hooking Before
```php
$this->addHookBefore('Fieldtype::install', function(HookEvent $event) {
  $fieldtype = $event->object;
  // Your code here
});
```

#### Hooking After
```php
$this->addHookAfter('Fieldtype::install', function(HookEvent $event) {
  $fieldtype = $event->object;
  // Your code here
  // Optionally modify return value
  $return = $event->return;
  $event->return = $return;
});
```
```

--------------------------------

### Example: Get and manage errors with $obj->errors()

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/Wire/method-errors.md

Shows common ways to retrieve errors from a Wire object: get all errors for one object, get the first error, get errors for all Wire objects, or get and clear all errors.

```php
// Get errors for one object
$errors = $obj->errors();

// Get first error in object
$error = $obj->errors('first');

// Get errors for all Wire objects
$errors = $obj->errors('all');

// Get and clear all errors for all Wire objects
$errors = $obj->errors('clear all');
```

--------------------------------

### install(): bool

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/WireDataDB/index.md

Installs the database table. Returns true on success, false on failure.

```APIDOC
## install(): bool

### Description
Install the table.

### Method
install

### Parameters
None.

### Returns
- **bool** - True on success, false on failure.
```

--------------------------------

### Example: Retrieve and Sanitize a GET Variable

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/WireInput/method-get.md

Demonstrates retrieving a 'q' GET variable, sanitizing it as text, and outputting it with entities. Also shows combining $input and $sanitizer in one call using $input->get->text('q').

```php
// Retrieve a "q" GET variable, sanitize and output
// Example request URL: domain.com/path/to/page/?q=TEST
$q = $input->get('q'); // retrieve value
$q = $sanitizer->text($q); // sanitize input as 1-line text
echo $sanitizer->entities($q); // sanitize for output, outputs "TEST"

// You can also combine $input and one $sanitizer call, replacing
// the "text" method call with any $sanitizer method:
$q = $input->get->text('q');

// like the previous example, but specify sanitizer method as second argument (3.0.125+):

```php

```
```

--------------------------------

### install()

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/FileCompilerModule/index.md

Perform any installation procedures specific to this module, if needed. This method is hookable.

```APIDOC
## install()

### Description
Perform any installation procedures specific to this module, if needed. This method is hookable.

### Method
install

### Parameters
None

### Return Value
None
```

--------------------------------

### urlSegment() usage examples

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/WireInput/method-urlsegment.md

Shows how to use $input->urlSegment() to get URL segments, check presence, get index, last segment, next/previous segments, and match with wildcards or regex. Requires PW 3.0.155+ for the advanced features. The examples assume specific URLs as noted in comments. The final example (9) is incomplete in the source and is excluded.

```php
// Get first URL segment and use it to determine output
$action = $input->urlSegment(1);
if($action == 'photos') {
  // display photos
} else if($action == 'map') {
  // display map
} else if(strlen($action)) {
  // unknown action, throw a 404
  throw new Wire404Exception();
} else {
  // default or display main page
}

// All following examples require PW 3.0.155+.

// Examples 1-5 below assume current URL is /path/to/page/foo/bar
// and that /foo/bar is the URL segments portion of the URL.

// 1. Check if URL segment “foo” is present
if($input->urlSegment('foo')) {
  // “foo” is present as a URL segment
}

// 2. Get index of matching URL segment
if($input->urlSegment('foo') === 1) {
  // “foo” is first URL segment
}

// 3. Get last URL segment
if($input->urlSegment(-1) === 'bar') {
  // “bar” is last URL segment
}

// 4. Get next URL segment
$next = $input->urlSegment('foo='); // returns 'bar'

// 5. Get previous URL segment
$prev = $input->urlSegment('=bar'); // returns 'foo'

// Examples 6-8 below assume current URL is /path/to/page/sort-date/
// where /sort-date/ is the URL segment.

// 6. Match URL segment using wildcard
$sort = $input->urlSegment('sort-*');
if($sort === 'sort-title') {
  // sort by title
} else if($sort === 'sort-date') {
  // sort by date
} else if(strlen($sort)) {
  // unknown sort value, throw 404 or fallback to default
} else {
  // no sort specified, use default
}

// 7. Match using wildcard and parenthesis
$sort = $input->urlSegment('sort-(*)');
if($sort === 'title') {
  // sort by title
} else if($sort === 'date') {
  // sort by date
} else if(strlen($sort)) {
  // unknown sort value, throw 404?
} else {
  // no sort specified, use default
}

// 8. Match using regular expression
$sort = $input->urlSegment('/^sort-(.+)$/');
if($sort === 'title') {
  // same if statement as example 5...
}

// 9. Similar goal to above but with URL /path/to/page/sort/date/
// that uses separate segment for sort value, which is a good
// example of using the “next” segment feature:

```php
```
```

--------------------------------

### Basic and full usage of $process->installPage()

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/Process/method-___installpage.md

Shows how to call installPage() with no arguments or with all arguments to create a dedicated page for the Process module. The method returns the created Page object.

```php
// basic usage
$page = $process->installPage();
```

```php
// usage with all arguments
$page = $process->installPage($name = '', $parent = null, $title = '', $template = 'admin', $extras = array());
```

--------------------------------

### get()

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/WireMail/index.md

Retrieves a property value from the WireMail instance.

```APIDOC
## get()

### Description
Retrieves a property value from the WireMail instance.

### Method
get

### Endpoint
get()

### Parameters
#### Request Body
- **key** (string) - Required - The property name to retrieve.

### Request Example
```php
$value = $m->get('property');
```

### Response
#### Success Response
Returns the property value.

#### Response Example
```php
$value = $m->get('property');
```
```

--------------------------------

### install($class, $options = array())

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/Modules/method-___install.md

Installs a given module by class name. Returns a ready-to-use Module object on success, or null if installation fails.

```APIDOC
## install($class, $options = array())

### Description
Installs the given module name. Returns null if unable to install, or a ready-to-use Module object if successfully installed.

### Method
install

### Signature
`$modules->install($class, $options = array())`

### Parameters
- **$class** (string) - Required - Module name (class name)
- **$options** (array|bool) - Optional - Associative array with options:
  - `dependencies` (boolean) - Optional - When true, dependencies will also be installed where possible. Specify false to prevent installation of uninstalled modules. (default=true)
  - `resetCache` (boolean) - Optional - When true, module caches will be reset after installation. (default=true)
  - `force` (boolean) - Optional - Force installation, even if dependencies can't be met.

### Return Value
- `null|Module` - Returns null if unable to install, or ready-to-use Module object if successfully installed.

### Exceptions
- `WireException`

### Hooking
- Hookable method name: `install`
- Implementation: `___install`
- Hook with: `Modules::install`

#### Hooking Before
```php
$this->addHookBefore('Modules::install', function(HookEvent $event) {
  $modules = $event->object;

  // Get arguments
  $class = $event->arguments(0);
  $options = $event->arguments(1);

  // Your code here

  // Optionally change arguments
  $event->arguments(0, $class);
  $event->arguments(1, $options);
});
```

#### Hooking After
```php
$this->addHookAfter('Modules::install', function(HookEvent $event) {
  $modules = $event->object;

  // Get arguments
  $class = $event->arguments(0);
  $options = $event->arguments(1);

  // Your code here

  // Optionally modify return value
  $return = $event->return;
  $event->return = $return;
});
```

### Usage Examples
```php
// basic usage
$modules->install($class);

// usage with all arguments
$modules->install($class, $options = array());
```
```

--------------------------------

### cacher(): WireCacheInterface

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/WireCache/index.md

Get the current WireClassInterface instance.

```APIDOC
## cacher(): WireCacheInterface

### Description
Get the current WireClassInterface instance.

### Method
cacher

### Returns
- **WireCacheInterface** - The current WireCacheInterface instance.
```

--------------------------------

### init()

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/Session/index.md

Start the session. This method is hookable.

```APIDOC
## init()

### Description
Start the session. This method is hookable.

### Method
Method

```

--------------------------------

### renderInitScript(): string

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/modules/Inputfield/InputfieldTinyMCE/InputfieldTinyMCE/index.md

Renders the script to initialize the editor. Returns the script as a string.

```APIDOC
## renderInitScript(): string

### Description
Renders the script to initialize the editor. Returns the script as a string.

### Method
N/A (PHP method)

### Endpoint
N/A

### Parameters
None

### Returns
- **string** - The initialization script.
```

--------------------------------

### Basic Usage of $wireInput->get()

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/WireInput/method-get.md

Shows the simplest call with no arguments to retrieve all GET variables, and the full signature with all arguments.

```php
// basic usage
$wireInput->get();
```

```php
// usage with all arguments
$wireInput->get($key = '', $valid = null, $fallback = null);
```

--------------------------------

### wireSetting(string|array $name = '', string|int|array|float|mixed $value = null)

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/FunctionsWireAPI/index.md

Get or set a runtime site setting.

```APIDOC
## Function: wireSetting

### Description
Get or set a runtime site setting.

### Signature
`wireSetting(string|array $name = '', string|int|array|float|mixed $value = null): array|string|int|bool|mixed|null`

### Parameters
- `$name` (string|array) - Optional - The setting name.
- `$value` (string|int|array|float|mixed) - Optional - The value.

### Returns
- `array|string|int|bool|mixed|null` - The result.
```

--------------------------------

### $wireDataDB->install(): bool

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/WireDataDB/method-install.md

Installs the database table for the WireDataDB instance. Returns a boolean indicating success or failure, and may throw a WireException on error.

```APIDOC
## $wireDataDB->install(): bool

### Description
Installs the database table for the WireDataDB instance. Returns a boolean indicating success or failure, and may throw a WireException on error.

### Method
install()

### Endpoint
$wireDataDB->install()

### Parameters
None

### Request Example
```php
$bool = $wireDataDB->install();
```

### Response
#### Success Response
- **bool** - Returns `true` on success, `false` on failure.

#### Response Example
```php
$bool = true;
```

### Exceptions
- **WireException** - Thrown if installation fails.
```

--------------------------------

### slice(int $start, int $limit = 0): WireArray

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/WireArray/index.md

Gets a slice of the WireArray.

```APIDOC
## slice(int $start, int $limit = 0): WireArray

### Description
Gets a slice of the WireArray.

### Method
slice

### Signature
`slice(int $start, int $limit = 0): WireArray`

### Parameters
- **$start** (int) - Required - The starting index.
- **$limit** (int) - Optional - The number of items to include. Defaults to 0 (all).

### Returns
- **WireArray** - A new WireArray containing the slice.
```

--------------------------------

### Usage: wireSetting() basic and with all arguments

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/FunctionsWireAPI/method-wiresetting.md

Shows basic usage of wireSetting() with no arguments and with all arguments, including defaults.

```php
// basic usage
$array = $functionsWireAPI->wireSetting();
```

```php
// usage with all arguments
$array = $functionsWireAPI->wireSetting($name = '', $value = null);
```

--------------------------------

### getCacheModule(): WireCacheInterface

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/WireCache/index.md

Get WireCache module that is currently being used.

```APIDOC
## getCacheModule(): WireCacheInterface

### Description
Get WireCache module that is currently being used.

### Method
getCacheModule

### Returns
- **WireCacheInterface** - The current WireCache module.
```

--------------------------------

### Set and get a property with $wireData->data()

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/WireData/method-data.md

Shows how to set a property by passing both $key and $value, and how to get a previously set property by omitting $value. The get returns the actual value or null if not set.

```php
// Set a property
$item->data('some_property', 'some value');

// Get the value of a previously set property
$value = $item->data('some_property');
```

--------------------------------

### Hooking after LanguageSupportInstall::install

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/modules/LanguageSupport/LanguageSupportInstall/method-___install.md

Adds a hook after the install method. Can optionally modify the return value.

```php
$this->addHookAfter('LanguageSupportInstall::install', function(HookEvent $event) {
  $languageSupportInstall = $event->object;

  // Your code here

  // Optionally modify return value
  $return = $event->return;
  $event->return = $return;
});
```

--------------------------------

### WireHttp GET request example

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/WireHttp/index.md

Shows how to instantiate WireHttp and send a GET request to a URL. The get() method returns false on failure, and getError() provides the error message. The response is echoed after sanitizing with $sanitizer->entities().

```php
// Get the contents of a URL
$response = $http->get("http://domain.com/path/");
if($response !== false) {
  echo "Successful response: " . $sanitizer->entities($response);
} else {
  echo "HTTP request failed: " . $http->getError();
}
```

--------------------------------

### install()

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/Tfa/method-___install.md

Installs the Tfa module and other assets required to execute it. This method is hookable and can be extended with before/after hooks.

```APIDOC
## install()

### Description
Installs the Tfa module and other assets required to execute it. This method is hookable and can be extended with before/after hooks.

### Method
install()

### Parameters
None

### Return Value
- **mixed** - The result of the installation process.

### Usage Example
```php
// basic usage
$result = $tfa->install();
```

### Hooking
- Hookable method name: `install`
- Implementation: `___install`
- Hook with: `Tfa::install`

#### Hooking Before
```php
$this->addHookBefore('Tfa::install', function(HookEvent $event) {
  $tfa = $event->object;

  // Your code here
});
```

#### Hooking After
```php
$this->addHookAfter('Tfa::install', function(HookEvent $event) {
  $tfa = $event->object;

  // Your code here

  // Optionally modify return value
  $return = $event->return;
  $event->return = $return;
});
```
```

--------------------------------

### Usage with all arguments

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/Functions/method-wirepopulatestringtags.md

Shows basic usage and usage with all arguments, including the optional $options array.

```php
// basic usage
$string = $functions->wirePopulateStringTags($str, $vars);

// usage with all arguments
$string = $functions->wirePopulateStringTags($str, $vars, array $options = array());
```

--------------------------------

### pageNames(): LanguageSupportPageNames|false

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/modules/LanguageSupport/Languages/index.md

Get LanguageSupportPageNames module if installed, false if not.

```APIDOC
## pageNames(): LanguageSupportPageNames|false

### Description
Get LanguageSupportPageNames module if installed, false if not.

### Method
`pageNames`

### Returns
- **LanguageSupportPageNames|false** - The module or false.
```

--------------------------------

### Basic login example

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/Session/method-___login.md

Logs in a user with name and password, then checks the result to display a welcome or error message.

```php
$u = $session->login('bob', 'laj3939$a');
if($u) {
  echo "Welcome Bob";
} else {
  echo "Sorry Bob";
}
```

--------------------------------

### Basic GET request example

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/WireHttp/method-get.md

Sends a GET request with data and checks the response. Returns false on failure or the response string on success. Uses $sanitizer->entities() to escape the response and $http->getError() to retrieve the error message on failure.

```php
$http = new WireHttp();
$response = $http->get("http://domain.com/path/", [
  'foo' => 'bar',
]);
if($response !== false) {
  echo "Successful response: " . $sanitizer->entities($response);
} else {
  echo "HTTP request failed: " . $http->getError();
}
```

--------------------------------

### $selectableOptionManager->install()

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/modules/Fieldtype/FieldtypeOptions/SelectableOptionManager/method-install.md

Installs the SelectableOptionManager module. This method is called to perform installation tasks for the module.

```APIDOC
## $selectableOptionManager->install()

### Description
Installs the SelectableOptionManager module.

### Method
install()

### Endpoint
$selectableOptionManager->install()

### Parameters
None

### Request Example
```php
// basic usage
$result = $selectableOptionManager->install();
```

### Response
#### Success Response
- **$result** (mixed) - The result of the installation process.
```

--------------------------------

### Basic usage of applySetupName

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/Fields/method-___applysetupname.md

Shows basic usage of the applySetupName method with only the required $field argument. If no setupName is provided, the method does nothing but hooks may still run.

```php
// basic usage
$bool = $fields->applySetupName($field);
```

--------------------------------

### Example: Get height and create variation

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/Pageimage/method-height.md

Shows how to get the current image height and create a new variation at a specified height using the $pageimage->height() method.

```php
// Get height of image
$px = $image->height();

// Create a new variation at 200px height
$thumb = $image->height(200);
```

--------------------------------

### substr(string $str, int $start, int|null $length = null): string

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/WireTextTools/index.md

Gets part of a string.

```APIDOC
## substr(string $str, int $start, int|null $length = null): string

### Description
Gets part of a string.

### Method
substr

### Signature
`substr(string $str, int $start, int|null $length = null): string`

### Parameters
- **$str** (string) - Required - The input string.
- **$start** (int) - Required - The starting position.
- **$length** (int|null) - Optional - The length of the substring. Default is null.
```

--------------------------------

### install()

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/Process/index.md

Per the Module interface, installs the module. This method is hookable.

```APIDOC
## install()

### Description
Per the Module interface, installs the module.

### Method
install

### Parameters
None

### Response
No return value.
```

--------------------------------

### serverProtocol()

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/Config/index.md

Get current server protocol (for example: "HTTP/1.1").

```APIDOC
## serverProtocol()

### Description
Get current server protocol (for example: "HTTP/1.1").

### Method
GET

### Endpoint
`serverProtocol(): string`

### Response
#### Success Response (200)
- Returns the server protocol string.

#### Response Example
```json
{
  "protocol": "HTTP/1.1"
}
```
```

--------------------------------

### Usage with all arguments for $fields->initItem()

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/Fields/method-inititem.md

Shows the full signature with both arguments: the raw array by reference and an optional WireArray. This example is the method signature as documented.

```php
// usage with all arguments
$saveable = $fields->initItem(array &$row, ?WireArray $items = null);
```

--------------------------------

### $wireInput->get($key = '', $valid = null, $fallback = null)

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/WireInput/method-get.md

Retrieves a named GET variable value from the URL query string, or all GET variables if no key is provided. Supports optional sanitization, validation, and fallback values as of ProcessWire 3.0.125+.

```APIDOC
## $wireInput->get($key = '', $valid = null, $fallback = null)

### Description
Retrieve a named GET variable value, or all GET variables (from URL query string). Always sanitize (and validate where appropriate) any values from user input.

### Method
Method call on WireInput object

### Endpoint
`$wireInput->get($key = '', $valid = null, $fallback = null)`

### Parameters
#### Arguments
- `$key` (string) - Optional - Name of GET variable you want to retrieve. If populated, returns the value corresponding to the key or NULL if it doesn’t exist. If blank, returns reference to the WireDataInput containing all GET vars.
- `$valid` (array|string|int|callable|null) - Optional - Omit for no validation/sanitization, or provide one of the following (3.0.125+ only):
  - String name of Sanitizer method to sanitize value with before returning it.
  - CSV string of multiple sanitizer names to process the value, in order.
  - Array of allowed values (whitelist), where input value must be one of these, otherwise null (or fallback value) will be returned. Values may be any string or integer.
  - Callback function to sanitize and validate the value.
  - Integer if a specific number is the only allowed value other than fallback value (i.e. like a checkbox toggle).
- `$fallback` (mixed|null) - Optional - Fallback value to return if input value is not present or does not validate (3.0.125+ only).

### Request Example
```php
// basic usage
$wireInput->get();

// usage with all arguments
$wireInput->get($key = '', $valid = null, $fallback = null);
```

### Response
#### Return value
- `null|mixed|WireInputData` - Returns one of the following:
  - If given no `$key` argument, returns `WireInputData` with all unsanitized GET vars.
  - If given no `$valid` argument, returns unsanitized value or NULL if not present.
  - If given a Sanitizer name for `$valid` argument, returns value sanitized with that Sanitizer method (3.0.125+).
  - If given an array of allowed values for `$valid` argument, returns value from that array if it was in the input, or null if not (3.0.125+).
  - If given a callable function for `$valid` argument, returns the value returned by that function (3.0.125+).
  - If given a `$fallback` argument, returns that value when it would otherwise return null (3.0.125+).

#### Response Example
```php
// Retrieve a "q" GET variable, sanitize and output
// Example request URL: domain.com/path/to/page/?q=TEST
$q = $input->get('q'); // retrieve value
$q = $sanitizer->text($q); // sanitize input as 1-line text
echo $sanitizer->entities($q); // sanitize for output, outputs "TEST"

// You can also combine $input and one $sanitizer call, replacing
// the "text" method call with any $sanitizer method:
$q = $input->get->text('q');

// like the previous example, but specify sanitizer method as second argument (3.0.125+):
$q = $input->get('q', 'text');

// if you want more than one sanitizer, specify multiple in a CSV string (3.0.125+):
$q = $input->get('q', 'text,entities');

// you can provide a whitelist array of allowed values instead of a sanitizer method (3.0.125+):
$color = $input->get('color', [ 'red', 'blue', 'green' ]);

// an optional 3rd argument lets you specify a fallback value to use if valid value not present or
// empty in input, and it will return this value rather than null/empty (3.0.125+):
$qty = $input->get('qty', 'int', 1); // return 1 if no qty provided
$color = $input->get('color', [ 'red', 'blue', 'green' ], 'red'); // return red if no color selected

// you may optionally provide a callback function to sanitize/validate with (3.0.125+):
$isActive = $input->get('active', function($val) { return $val ? true : false; });
```

### Exceptions
- `WireException` if given unknown Sanitizer method for $valid argument

```

--------------------------------

### Example: Using $obj->messages() with various options

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/Wire/method-messages.md

Shows how to retrieve messages for one object, get the first message, get messages for all Wire objects, and get and clear all messages. Each call uses a different option string ('first', 'all', 'clear all').

```php
// Get messages for one object
$messages = $obj->messages();

// Get first message in object
$message = $obj->messages('first');

// Get messages for all Wire objects
$messages = $obj->messages('all');

// Get and clear all messages for all Wire objects
$messages = $obj->messages('clear all');
```

--------------------------------

### filename(): string

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/Pageimage/index.md

Returns the full disk path to the image file.

```APIDOC
## filename(): string

### Description
Returns the full disk path to the image file.

### Method
filename

### Returns
- **string** - The full disk path.
```

--------------------------------

### getModuleInstallUrl(string $className): string

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/Modules/index.md

Gets the URL where an administrator can install a given module.

```APIDOC
## getModuleInstallUrl(string $className): string

### Description
Gets the URL where an administrator can install the given module name.

### Method
GET

### Endpoint
`$modules->getModuleInstallUrl($className)`

### Parameters
- **$className** (string) - Required - Module class name.

### Response
#### Success Response
- Returns string - URL to install the module.
```

--------------------------------

### getDefaults(): array

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/WireMarkupFileRegions/index.md

Get default settings for the WireMarkupFileRegions class.

```APIDOC
## getDefaults(): array

### Description
Get default settings for the WireMarkupFileRegions class.

### Method
GET

### Endpoint
`getDefaults()`

### Parameters
None

### Response
#### Success Response (200)
- **array** - Default settings

#### Response Example
```json
{}
```
```

--------------------------------

### multipartBoundary(string|bool $prefix = ''): string

Source: https://github.com/phlppschrr/processwire-api-docs/blob/main/api-docs/wire/core/WireMail/index.md

Gets the multipart boundary string for this email.

```APIDOC
## multipartBoundary(string|bool $prefix = ''): string

### Description
Gets the multipart boundary string for this email.

### Method
multipartBoundary

### Signature
`multipartBoundary(string|bool $prefix = ''): string`

### Parameters
- **$prefix** (string|bool) - Optional - A prefix for the boundary.

### Returns
- **string** - The multipart boundary string.

```
Tokens:
Raw