### Fluent interface example with output

Source: https://processwire.com/docs/start/api

Shows a fluent interface chain that finds a page, filters by selector, gets the first result, and outputs its URL. The output is a sample URL path.

```php
echo $pages->get("/products/2010/")
  ->find("template=faq, body*=Tobiko")
  ->first()
  ->url;
```

```text
/products/2010/sushi-knives/faq/
```

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

### Chaining example: resize image and output URL

Source: https://processwire.com/docs/start/api

Demonstrates chaining method calls on a page field to get the first image, resize it to 200px width, and output the URL in an img tag. This is a fluent interface example similar to jQuery chaining.

```php
<img src='<?=$page->images->first->width(200)->url?>' alt='Example'>
```

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

### Get a specific page and print its title

Source: https://processwire.com/docs/start/variables/pages

Retrieves a page by its path and outputs its title. This example uses the skyscrapers demo site.

```php
echo $pages->get("/cities/chicago/sears-tower/")->title;
```

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

### Example: route based on URL segment

Source: https://processwire.com/docs/front-end/how-to-use-url-segments

Example template logic that checks the first URL segment to display a photo gallery, a map, or main content.

```php
if($input->urlSegment1 == 'photos') {
  // display photo gallery
} else if($input->urlSegment1 == 'map') {
  // display map
} else {
  // display main content
}
```

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

### Example output of sitemap.sh

Source: https://processwire.com/docs/front-end/include

Example output from running the sitemap.sh script, showing an indented list of page titles.

```text
Home
    About
        What's Unique?
        Why ProcessWire?
        Background
        Requirements
        License
    Developer API
        Concept
        What is the API?
        Directories
        Template Files
        Variables
            $page
            $pages
            $input
            $sanitizer
        Selectors
        Syntax
        Plugin Modules
    Download
    Demo
    Videos
    Contact
```

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

### Example URL with page number

Source: https://processwire.com/docs/start/variables/input

An example of a URL structure that populates the $input->pageNum variable with the value 4.

```text
/path/to/some-page/page4
```

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

### Example class demonstrating ProcessWire coding style

Source: https://processwire.com/docs/more/coding-style-guide

This example class `Sample` extends `WireData` and implements `Module`, showcasing the recommended naming conventions, visibility declarations, PHPDoc usage, and control structure formatting. It includes a constant, a property, a regular method, and a hookable method (prefixed with `___`).

```php
<?php

/**
 * Class Sample
 *
 * Description of what the class does.
 *
 * @method int hookableMethod($a, $b)
 *
 */
class Sample extends WireData implements Module {

    /**
     * Description of sampleConstant
     *
     */
    const sampleConstant = 1;

    /**
     * Description of sampleProperty
     *
     * @var bool
     *
     */
    protected $sampleProperty = true;

    /**
     * Description of sampleFunction
     *
     * @param int $a Description of a
     * @param int|null $b Description of b
     *
     */
    public function sampleFunction($a, $b = null) {
        if($a === $b) {
            bar();
        } else if($a > $b) {
            $foo->bar($arg1);
        } else {
            BazClass::bar($arg2, $arg3);
        }
    }

    /**
     * Description of hookableMethod
     *
     * @param int $a Description of a
     * @param int $b Description of b
     * @return string Description of return value
     *
     */
    public function ___hookableMethod($a, $b) {
        $result = $a + $b;
        return sprintf($this->_('The result is %s'), $result);
    }
}
```

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

### Install Seo Maestro with Composer

Source: https://processwire.com/modules/seo-maestro

Command to install the Seo Maestro module via Composer. Requires ProcessWire 3.0 or newer and PHP 7.0 or newer.

```bash
composer require wanze/seo-maestro
```

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

### Install ProcessWire with Composer

Source: https://processwire.com/docs/start/install/new

Use Composer to create a new project or add ProcessWire to an existing project.

```bash
composer create-project processwire/processwire
```

```bash
composer require processwire/processwire
```

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

### Namespace Declaration Example

Source: https://processwire.com/docs/more/coding-style-guide

Recommended structure for namespace and use declarations in PHP files.

```php
<?php namespace SampleNamespace;

use FooClass;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;

// ... additional PHP code ...
```

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

### Combined conditional hook example

Source: https://processwire.com/docs/modules/hooks

A complex example demonstrating the combination of field name, template, and return value label selectors in a single hook definition.

```php
<?php namespace ProcessWire;

$wire->addHookAfter('Field(name!=title)::getInputfield(template=product):(label*=description)',
  function(HookEvent $event) {
    $field = $event->object; // Field object not named 'title'
    $page = $event->arguments(0); // Page object using template 'product'
    $inputfield = $event->return; // Inputfield for product page with 'description' in label
    $event->message(
      "We hooked getInputfield for field '$field' that does not have the name 'title' and " .
      "for page '$page' that is using the template 'product', so long as the returned " .
      "Inputfield 'label' ($inputfield->label) contains 'description' somewhere in it. "
    );
  });
```

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

### Find pages by template

Source: https://processwire.com/docs/selectors

A basic example of finding all pages that use the 'skyscraper' template.

```php
$pages->find("template=skyscraper");
```

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

### Render placeholders in _main.php

Source: https://processwire.com/docs/front-end/output/delayed

Example of a main template file that handles markup generation for the $subnav placeholder.

```php
<DOCTYPE html>
<html>
  <head>
    <title><?php echo $headline; ?></title>
  </head>
  <body>
    <div id='bodycopy'>
      <h1><?php echo $headline; ?></h1>
      <?php echo $bodycopy; ?>
    </div>
    <div id='sidebar'>
      <?php
      echo $sidebar
      if(count($subnav)) {
        echo "<ul class='nav'>";
        foreach($subnav as $child) {
          echo "<li><a href='$child->url'>$child->title</a></li>";
        }
        echo "</ul>";
      }
      ?>
    </div>
  </body>
</html>
```

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

### Simplified template file /site/templates/basic-page.php

Source: https://processwire.com/docs/front-end/output/delayed

Example of a template file reduced to only the necessary content when using automatic inclusions.

```php
<?php 
$bodycopy .= $page->comments->render();
```

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

### Web-Based Sitemap Script

Source: https://processwire.com/docs/front-end/include

Example of a PHP script that includes ProcessWire and generates an HTML sitemap with links.

```APIDOC
## Web-Based Sitemap Script

### Description
A PHP script that includes ProcessWire and generates an HTML sitemap with links to all pages.

### Method
Script execution

### Endpoint
./sitemap.php

### Parameters
None

### Request Example
<!DOCTYPE html>
<html lang="en">
<head>
    <meta http-equiv="content-type" content="text/html; charset=utf-8" />
    <title>Site Map</title>
</head>
<body>
    <h1>Site Map</h1>
    <?php
    include("./index.php"); // bootstrap ProcessWire
    function listPage($page, $level = 0) {
        echo "<li><a href='$page->url'>$page->title</a>";
        if($page->numChildren) {
            echo "<ul>";
            foreach($page->children as $child) listPage($child, $level+1);
            echo "</ul>";
        }
        echo "</li>";
    }
    ?>
    <ul>
      <?php listPage($pages->get("/")); ?>
    </ul>
    </body>
</html>

### Response
Outputs an HTML page with a nested list of links to all pages.
```

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

### Example Debug Output

Source: https://processwire.com/docs/front-end/output/markup-regions

This is the format of the debugging information generated when the debug comment is present.

```text
3. replace => #content-head ... <h1 id='content-head'>
6. replace => #sidebar ... <aside id='sidebar'>
26. replace => #content-body ... <div class='uk-margin-top' id='content-body'>
```

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

### Create planet.php template with plain HTML

Source: https://processwire.com/docs/tutorials/hello-worlds

Create a new file /site/templates/planet.php and paste this HTML as the starting point. It is plain HTML with no ProcessWire-specific code yet; you will modify it later in the tutorial.

```html
<html>
  <head>
    <title>Earth</title>
  </head>
  <body>
    <h1>Earth</h1>
    <h2>Type: Happy planet, Age: Millions of years</h2>
    <p>Earth (or the Earth) is the third planet from the Sun,
    and the densest and fifth-largest of the eight planets
    in the Solar System. It is also the largest of the Solar
    System's four terrestrial planets. It is sometimes
    referred to as the World, the Blue Planet, or by its
    Latin name, Terra.</p>
  </body>
</html>
```

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

### Insecure user input handling

Source: https://processwire.com/docs/security/template-files

An example of insecure code that passes a GET variable directly to a selector without sanitization or validation.

```php
// do not do this
$text = $input->get('text');
$items = $pages->find("body%=$text");
```

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

### Access common Field properties

Source: https://processwire.com/docs/start/variables/fields

Shows how to retrieve a Field object and access its properties such as name, label, type class name, and flags string. The example uses $fields->get('body') and echoes the property values.

```php
$field = $fields->get('body');
echo $field->name;         // "body"
echo $field->label;        // "Body"
echo $field->type->className(); // "FieldtypeTextarea"
echo $field->flagsStr;     // "autojoin" (if autojoin flag set)
```

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

### Apply resize options array

Source: https://processwire.com/docs/fields/images

Demonstrates how to define an options array to control image quality, upscaling behavior, and cropping direction.

```php
$options = array(
  'quality' => 90,
  'upscaling' => false,
  'cropping' => 'southeast'
);
$img = $image->size($x, $y, $options);
```

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

### Limit results with a start offset

Source: https://processwire.com/docs/selectors

Returns 50 results starting from the 51st result.

```text
start=50, limit=50
```

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

### Get log file path with $log->getFilename()

Source: https://processwire.com/docs/start/variables/log

Get the full filesystem path to a log file.

```php
$path = $log->getFilename('errors');
// e.g. /var/www/html/site/assets/logs/errors.txt
```

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

### Include init.inc and main.inc in a template file

Source: https://processwire.com/docs/tutorials/how-to-structure-your-template-files

Manually include the initialization and main template files within a specific template file like basic-page.php.

```php
<?php
include("./init.inc");
$bodycopy .= $page->comments->render();
include("./main.inc");
```

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

### Instantiating a custom Event class

Source: https://processwire.com/docs/tutorials/using-custom-page-types-in-processwire

Demonstrates creating a new Event object and using the custom 'startsToday' method.

```php
$event = new Event();
$event->startdate = time();
$event->startsToday();
```

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

### $fields->get($name)

Source: https://processwire.com/docs/start/variables/fields

Get a single field by name or ID. Returns a Field object or null if not found.

```APIDOC
## $fields->get($name)

### Description
Get a single field by name or ID. Returns a Field object or null if not found.

### Method
GET

### Endpoint
$fields->get($name)

### Parameters
#### Arguments
- **$name** (string|int) - Required - Field name or ID.

### Returns
- **Field|null** - The Field object or null if not found.

### Request Example
```php
$field = $fields->get('title');
$field = $fields->get('body');
$field = $fields->get(123); // by ID
```

### Response
#### Success Response
Returns a Field object or null.

#### Response Example
```php
$field = $fields->get('title');
```
```

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

### Region definition for outer HTML example

Source: https://processwire.com/docs/front-end/output/markup-regions

The target region definition in _main.php for the preceding action attribute examples.

```html
<div id="hello">
  <h2>Hello World</h2>
</div>
```

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

### Create fields with $fields->new()

Source: https://processwire.com/docs/start/variables/fields

Demonstrates creating fields using different argument styles, including short names, options arrays, and all-in-one configuration arrays.

```php
// Create a text field (TextField object)
$field = $fields->new('text', 'my_text', 'My Text Field');

// Create new textarea field with options array (TextareaField object)
$field = $fields->new('textarea', 'body', [
    'label'          => 'Body',
    'textformatters' => ['TextformatterEntities'],
    'columnWidth'    => 100,
]);

// Using an array as first argument (all-in-one TextField)
$field = $fields->new([
    'type'  => 'text',
    'name'  => 'summary',
    'label' => 'Summary',
]);
```

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

### Display featured pages with date and summary

Source: https://processwire.com/docs/start/templates

A complete example showing how to iterate through found pages and output multiple fields including date and summary.

```php
<ul><?php
$features = $pages->find("template=press_release, featured=1, limit=3, sort=-date");
foreach($features as $feature) {
   echo "<li>" .
        "<h3><a href='$feature->url'>$feature->title</a></h3>" .
        "<span class='date'>$feature->date</span>" .
        "<p>$feature->summary</p>" .
        "</li>";
}
?></ul>
```

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

### Iterate over GET variables

Source: https://processwire.com/docs/start/variables/input

Iterates through all GET variables, echoing each key-value pair with HTML entities encoded for safe output.

```php
foreach($input->get as $key => $value) {
  echo $sanitizer->entities("$key = $value") . "<br />";
}
```

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

### Define a basic module class

Source: https://processwire.com/docs/modules/development

Create a class that extends WireData and implements the Module interface. Save this in a file named Foo.module or Foo.module.php within /site/modules/.

```php
<?php namespace ProcessWire;
class Foo extends WireData implements Module {
  // nothing here yet
}
```

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

### Custom renderPager options example

Source: https://processwire.com/docs/front-end/markup-pager-nav

Example of passing an options array to renderPager to modify markup. The values shown are the defaults.

```php
<?php
echo $results->renderPager(array(
  'nextItemLabel' => "Next",
  'previousItemLabel' => "Prev",
  'listMarkup' => "<ul class='MarkupPagerNav'>{out}</ul>",
  'itemMarkup' => "<li class='{class}'>{out}</li>",
  'linkMarkup' => "<a href='{url}'><span>{out}</span></a>"
));
```

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

### Nested sub-selector example

Source: https://processwire.com/docs/selectors

An example of using nested sub-selectors in ProcessWire 3.x to filter by invoice status and nested product color.

```text
template=member, invoice=[status=paid, invoice_row!=[product.color=Red]]
```

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

### Hookable Method Implementation

Source: https://processwire.com/docs/more/coding-style-guide

Example of a hookable method using the triple-underscore prefix, extending Wire, and including required PHPDoc annotations.

```php
/**
 * Class SampleClass
 *
 * Description of SampleClass
 *
 * @method int fooBarBaz(int $arg1, int $arg2) Add two integers
 *
 */
class SampleClass extends Wire {

    /**
     * Description of fooBarBaz
     *
     * @param int $arg1 Description of arg1
     * @param int $arg2 Description of arg2
     * @return int
     *
     */
    public function ___fooBarBaz($arg1, $arg2) {
        return $arg1 + $arg2;
    }
}
```

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

### Prerequisites: enable markup regions in config.php

Source: https://processwire.com/docs/front-end/output/markup-regions

Add these lines to /site/config.php to enable markup regions and append _main.php on every request. The first line enables the strategy, the second sets the template file to append.

```php
$config->useMarkupRegions = true;
$config->appendTemplateFile = '_main.php';
```

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

### Define placeholder variables with default values in _init.php

Source: https://processwire.com/docs/tutorials/default-site-profile

Shows how to define placeholder variables with static or dynamic default values in _init.php.

```php
$content = "<p>Hello World</p>"; // assign static value…
$content = $page->body; // …or assign dynamic value from $page
```

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

### Output headline with fallback to title using $page->get()

Source: https://processwire.com/docs/tutorials/a-beginners-guide-to-processwire

Use $page->get("headline|title") to output the 'Headline' field if it has content, otherwise fall back to the 'Title' field.

```php
echo $page->get("headline|title");

```

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

### Retrieve GET variable 'name' using three access methods

Source: https://processwire.com/docs/start/variables/input

Shows three equivalent ways to access a GET variable: as object property, array index, and function call. All return the same value.

```php
$value = $input->get->name;   // access as object property
$value = $input->get['name']; // access as array index
$value = $input->get('name'); // access as function
```

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

### Standard Method and Function Calls

Source: https://processwire.com/docs/more/coding-style-guide

Demonstrates the required spacing for function and method calls, including argument lists.

```php
bar();
$foo->bar($arg1);
Foo::bar($arg2, $arg3);
```

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

### $fields->getFieldtype()

Source: https://processwire.com/docs/start/variables/fields

Get a Fieldtype.

```APIDOC
## $fields->getFieldtype()

### Description
Get a Fieldtype.

### Method
getFieldtype(string $name)

### Parameters
- **$name** (string) - Required - The name of the Fieldtype.

### Return
Fieldtype|null

```

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

### $sanitizer->getTextTools()

Source: https://processwire.com/docs/start/variables/sanitizer

Get instance of WireTextTools.

```APIDOC
## $sanitizer->getTextTools()

### Description
Get instance of WireTextTools.

### Method Signature
$sanitizer->getTextTools()

### Return Type
WireTextTools
```

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

### Include ProcessWire index.php

Source: https://processwire.com/docs/front-end/include

Include ProcessWire's index.php file from any other PHP script to bootstrap the API. Works for both HTTP and command-line contexts.

```php
include("/path/to/processwire/index.php");
```

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

### Example #1: Basic pagination with render()

Source: https://processwire.com/docs/front-end/markup-pager-nav

Retrieves all pages with ID greater than 1, limits to 10 results, sorts by title, and renders the list. The render() method automatically outputs pagination links when more results exist than the limit.

```php
<?php
$results = $pages->find("id>1, limit=10, sort=title");
echo $results->render();

```

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

### $sanitizer->getNumberTools()

Source: https://processwire.com/docs/start/variables/sanitizer

Gets an instance of WireNumberTools.

```APIDOC
## $sanitizer->getNumberTools()

### Description
Get instance of WireNumberTools.

### Method
$sanitizer->getNumberTools()

### Parameters
None.

### Return
- **WireNumberTools** - The number tools instance.
```

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

### $fields->getAllNames()

Source: https://processwire.com/docs/start/variables/fields

Get all field names.

```APIDOC
## $fields->getAllNames()

### Description
Get all field names.

### Method
getAllNames(string $indexType = '')

### Parameters
- **$indexType** (string) - Optional - Index type for the returned array.

### Return
array

```

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

### Examples of accidentally overwriting API variables

Source: https://processwire.com/docs/start/api-access

Shows three common mistakes where API variables like $page, $user, and $files are overwritten in loops or assignments, which can break the site. These examples illustrate why using functions like pages() is safer.

```php
// oops, we just overwrote the $page API variable
foreach($pages->find("template=basic-page") as $page) { … }

// oops, we just overwrote the $user API variable
foreach($users->find("role.name=editor") as $user) { … }

// oops, we just overwrote the $files API var
$files = new \DirectoryIterator("/path/");
```

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

### Populating placeholders with additional content

Source: https://processwire.com/docs/front-end/output/delayed

Demonstrates how to append complex content like comments and sub-navigation to placeholder variables before including the main layout file.

```php
<?php 
$headline = $page->get("headline|title");

// bodycopy is body text plus comments
$bodycopy = $page->body . $page->comments->render();
$sidebar = $page->sidebar;

// check if this page has any children
if(count($page->children)) {
  // render sub-navigation in sidebar
  $sidebar .= "<ul class='nav'>";
  foreach($page->children as $child) {
    $sidebar .= "<li><a href='$child->url'>$child->title</a></li>";
  }
  $sidebar .= "</ul>";
}

include("./_main.php");
```

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

### $fields->getCacheItemName()

Source: https://processwire.com/docs/start/variables/fields

Get the cache item name.

```APIDOC
## $fields->getCacheItemName()

### Description
Get the cache item name.

### Method
getCacheItemName()

### Parameters
None

### Return
None

```

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

### $fields->getTags()

Source: https://processwire.com/docs/start/variables/fields

Get list of all tags used by fields.

```APIDOC
## $fields->getTags()

### Description
Get list of all tags used by fields.

### Method
getTags($getFieldNames = false)

### Parameters
- **$getFieldNames** - Optional - If true, return field names instead of tags.

### Return
array

```

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

### Clone ProcessWire from GitHub

Source: https://processwire.com/docs/start/install/new

Use the git clone command to download the ProcessWire repository to your server.

```bash
git clone https://github.com/processwire/processwire.git
```

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

### $fields->getWireArray()

Source: https://processwire.com/docs/start/variables/fields

Get WireArray container that items are stored in.

```APIDOC
## $fields->getWireArray()

### Description
Get WireArray container that items are stored in.

### Method
getWireArray()

### Parameters
None

### Return
WireArray

```

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

### $log->getLogs($sortNewest)

Source: https://processwire.com/docs/start/variables/log

Get an array of all available logs.

```APIDOC
## $log->getLogs($sortNewest)

### Description
Get an array of all available logs.

### Arguments
- **$sortNewest** (bool) - Optional - Sort by most recently modified. Default false.

### Returns
- **array** - Indexed by log name, each value is an associative array with:
  - **name** (string) - Log name without extension.
  - **file** (string) - Full path to log file.
  - **size** (int) - File size in bytes.
  - **modified** (int) - Last-modified unix timestamp.

### Example
```php
foreach($log->getLogs() as $name => $info) {
    echo "$name: " . number_format($info['size']) . " bytes\n";
}

// Sort by most recently modified
$logs = $log->getLogs(true);
```
```

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

### Populate $content with image and body in template file

Source: https://processwire.com/docs/tutorials/default-site-profile

Shows how to prepend an image to the body copy when populating the $content placeholder variable.

```php
$content = "<img src='/photo.jpg'>" . $page->body;
```

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

### $fields->getAllIds()

Source: https://processwire.com/docs/start/variables/fields

Get all field IDs indexed by their field name.

```APIDOC
## $fields->getAllIds()

### Description
Get all field IDs indexed by their field name.

### Method
GET

### Endpoint
$fields->getAllIds()

### Parameters
None.

### Returns
- **array** - Associative array of field names to IDs.

### Request Example
```php
$ids = $fields->getAllIds(); // ['title' => 1, 'body' => 2, ...]
```

### Response
#### Success Response
Returns an associative array of field names to IDs.

#### Response Example
```php
$ids = $fields->getAllIds(); // ['title' => 1, 'body' => 2, ...]
```
```

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

### $log->getTotalEntries($name)

Source: https://processwire.com/docs/start/variables/log

Get the total number of entries in a log.

```APIDOC
## $log->getTotalEntries($name)

### Description
Get the total number of entries in a log.

### Arguments
- **$name** (string) - Required - The log name.

### Returns
- **int** - Total number of entries.

### Example
```php
$total = $log->getTotalEntries('errors');
```
```

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

### Closure examples with arguments and use variables

Source: https://processwire.com/docs/more/coding-style-guide

Shows four closure patterns: with arguments, with arguments and use variables, in an argument list, and in a multi-line argument list. The 'use' keyword must be preceded by a single space and no whitespace after it.

```PHP
// closure with arguments
$foo = function($arg1, $arg2) {
    // body
};

// closure with arguments and use vars
$bar = function($arg1, $arg2) use($var1, $var2) {
    // body
};

// closure in argument list
$foo->bar($arg1, function($arg2) use($var1) {
    // body
});

// closure in multi-line argument list
$foo->bar(
    $arg1,
    function($arg2) use($var1) {
        // body
    },
    $arg3
);
```

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

### Create a new skyscraper page and save with image

Source: https://processwire.com/docs/start/variables/pages

Creates a new skyscraper page in Atlanta, saves it, adds an image, and saves again.

```php
$skyscraper = new Page();
$skyscraper->template = $templates->get("skyscraper");
$skyscraper->parent = $pages->get("/cities/atlanta/");
$skyscraper->title = "W-Hotel Tower";
$skyscraper->height = 400;
$skyscraper->year = 2009;
$skyscraper->body = "This is a nice hotel and it has a helicopter landing pad on top of it."
$skyscraper->save();
$skyscraper->images->add("http://starwoodhotels.com/w-atlanta.jpg");
$skyscraper->save();
```