Statamic

https://statamic.dev
Admin
Statamic is a modern, flat-file CMS designed for building and managing websites. It offers powerful...
Tokens:560,525
Snippets:8,042
Trust Score:8.6
Update:3 months ago
Show doc for...
Tokens:
Raw
### Initialize Addon Development

Source: https://statamic.dev/addons/vite-tooling

Install dependencies and start the Vite development server for your addon.

```bash
cd addons/your/addon
npm install
npm run dev
```

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

### Install Nginx

Source: https://statamic.dev/getting-started/installing/ubuntu

Install the Nginx web server on your Ubuntu system. The service starts automatically after installation.

```shell
sudo apt install nginx -y
```

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

### Post-Install Hook Example

Source: https://statamic.dev/starter-kits/creating-a-starter-kit

Implement a `StarterKitPostInstall.php` file to run custom logic after a starter kit is installed. This class should be non-namespaced and have a `handle` method that accepts a console instance for output.

```php
<?php

class StarterKitPostInstall
{
    public function handle($console)
    {
        $console->line('Thanks for installing!');
    }

}
```

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

### Install New Statamic Site with Starter Kit

Source: https://statamic.dev/starter-kits/installing-a-starter-kit

Use this command to create a new Statamic site and install a starter kit simultaneously. Ensure you have the Statamic CLI Tool installed.

```shell
statamic new my-site vendor/starter-kit
```

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

### User Two-Factor Setup Form Example (Antlers)

Source: https://statamic.dev/tags/user-two_factor_setup_form

This Antlers example demonstrates how to use the user:two_factor_setup_form tag. It includes error handling, QR code display (both SVG and image source), manual secret key entry, and a form submission button.

```antlers
{{ user:two_factor_setup_form redirect="/account/recovery-codes" }}



    {{ if errors }}

        <div class="bg-red-300 text-white p-2">

            {{ errors }}

                {{ value }}<br>

            {{ /errors }}

        </div>

    {{ /if }}



    <h2>Set Up Two-Factor Authentication</h2>



    <p>Scan this QR code with your authenticator app:</p>



    {{# Option 1: Render SVG directly #}}

    <div class="qr-code">

        {{ qr_code }}

    </div>



    {{# Option 2: Use as image source #}}

    <img src="{{ qr_code_url }}" alt="QR Code" width="200" height="200" />



    <p>Or enter this code manually: <code>{{ secret_key }}</code></p>



    <label>

        Enter the 6-digit code from your app to confirm:

        <input type="text" name="code" inputmode="numeric" autocomplete="one-time-code" maxlength="6" />

    </label>



    <button type="submit">Enable Two-Factor Authentication</button>



{{ /user:two_factor_setup_form }}
```

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

### Private Addon Installation Configuration

Source: https://statamic.dev/extending/addons

Example of composer.json configuration for installing a private addon using a path repository. Ensure both 'require' and 'repositories' sections are updated.

```json
{

    ...



    "require": {

        ...

        "acme/example": "*"

    },



    ...



    "repositories": [

        {

            "type": "path",

            "url": "addons/example"

        }

    ]

}
```

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

### Force Clear Site Data During Installation

Source: https://statamic.dev/starter-kits/installing-a-starter-kit

Append the --clear-site option to the starter kit installation command to forcefully clear all existing site data before installation. This is useful for fresh installations or when replacing existing content.

```shell
php please starter-kit:install vendor-name/starter-kit-name --clear-site
```

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

### User Two-Factor Setup Form Example (Blade)

Source: https://statamic.dev/tags/user-two_factor_setup_form

This Blade example shows the equivalent of the Antlers tag for setting up two-factor authentication. It handles errors, displays the QR code, and provides fields for manual code entry and submission.

```blade
<s:user:two_factor_setup_form redirect="/account/recovery-codes">

    @if ($errors)

        <div class="bg-red-300 text-white p-2">

            @foreach ($errors as $error)

                {{ $error }}<br>

            @endforeach

        </div>

    @endif



    <h2>Set Up Two-Factor Authentication</h2>



    <p>Scan this QR code with your authenticator app:</p>



    {{-- Option 1: Render SVG directly --}}

    <div class="qr-code">

        {!! $qr_code !!}

    </div>



    {{-- Option 2: Use as image source --}}

    <img src="{{ $qr_code_url }}" alt="QR Code" width="200" height="200" />



    <p>Or enter this code manually: <code>{{ $secret_key }}</code></p>



    <label>

        Enter the 6-digit code from your app to confirm:

        <input type="text" name="code" inputmode="numeric" autocomplete="one-time-code" maxlength="6" />

    </label>



    <button type="submit">Enable Two-Factor Authentication</button>

</s:user:two_factor_setup_form>
```

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

### Example Sites Configuration

Source: https://statamic.dev/fieldtypes/sites

This is an example of how sites might be configured in your Statamic `content/sites.yaml` file.

```yaml
sites:

  - english

  - french

  - german
```

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

### Install Starter Kit with Configuration

Source: https://statamic.dev/starter-kits/creating-a-starter-kit

Use this command to install a starter kit into a fresh Statamic project, including its configuration file.

```shell
statamic new kung-fury-dev the-hoff/kung-fury-theme --with-config
```

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

### Install Starter Kit Without Dependencies

Source: https://statamic.dev/starter-kits/installing-a-starter-kit

Use the --without-dependencies flag when installing a starter kit to exclude any bundled dependencies. This is useful for modular installations or when you prefer to manage dependencies manually.

```shell
php please starter-kit:install vendor-name/starter-kit-name --without-dependencies
```

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

### Site Configuration Example

Source: https://statamic.dev/variables/site

This is an example of how to configure sites in Statamic's `sites.php` configuration file.

```php
// config/statamic/sites.php


'sites' => [

    'default' => [

        'name' => 'My Statamic Site',

        'locale' => 'en_US',

        'url' => '/',

        'direction' => 'ltr',

        'attributes' => [

            'foo' => 'bar',

        ],

    ]

]

```

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

### Example Input String

Source: https://statamic.dev/modifiers/lower

This is the example input string that will be converted to lowercase.

```text
yelling: I DON'T KNOW WHAT WE'RE YELLING ABOUT
```

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

### Example Asset Path

Source: https://statamic.dev/variables/path

An example of what an asset path might look like.

```html
img/black-bear-cubs.jpg
```

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

### Install First-Party Addon

Source: https://statamic.dev/addons/overview

Some first-party addons have their own dedicated installation commands, which will be noted on their respective pages.

```shell
php please install:ssg
```

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

### Example Output

Source: https://statamic.dev/variables/has_timestamp

This shows an example of how a date might be formatted when the entry is not time-based.

```html
January 1st, 2016 11:30 am
```

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

### Install Eloquent Driver Addon

Source: https://statamic.dev/knowledge-base/tips/storing-content-in-a-database

Run this command to install the Eloquent Driver addon and configure repositories for database storage.

```bash
php please install:eloquent-driver
```

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

### Example Filename Output

Source: https://statamic.dev/variables/filename

This shows an example of what the output might look like for a filename.

```html
black-bear-cubs
```

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

### Example Usage: blog.index

Source: https://statamic.dev/variables/current_template

An example showing the output of `current_template` when the active template is `blog.index`.

```APIDOC
## Example Usage: blog.index

### Description
This example illustrates the output of the `current_template` variable when the active template is `blog.index`.

### Method
Template Variable

### Endpoint
N/A

### Parameters
N/A

### Request Example
```
(Implicitly used within a template)
```

### Response
#### Success Response (200)
- **current_template** (string) - The name of the current template.

#### Response Example
```
html
blog.index
```
```

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

### Example URL Output

Source: https://statamic.dev/variables/url

This is an example of the output you can expect from the `url` tag, which is a relative path.

```html
/posts/bacon
```

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

### Querying Entries - Examples

Source: https://statamic.dev/repositories/entry-repository

Examples of how to query entries using the Entry Repository.

```APIDOC
## Querying
### Examples
#### Get a single entry by its id
```php
Entry::query()->where('id', 123)->first();

// Or with the shorthand method
Entry::find(123);
```
When an entry can't be found, the `Entry::find()` method will return `null`. If you'd prefer an exception be thrown, you may use the `findOrFail` method:
```php
Entry::findOrFail(123);
```
#### Get an entry by its URI
```php
Entry::query()->where('uri', 'blog/my-first-post')->first();

// Or with the shorthand method
Entry::findByUri('/blog/my-first-post');
```
**What is the difference between `URI` and `URL`?** `URL` includes the site root (e.g. `/fr/` in a multisite), if there is one, while `URI` is site agnostic and will not. As you may have surmised, when you only have a single site — they are identical.
#### Get entries by IDs
If you already know the IDs of the entries you want to find, you can call the `whereInId` method. The entries will be returned in the same order you provided them.
```php
Entry::whereInId([3, 1, 2]);
```
#### Get all entries in a collection
```php
Entry::query()
  ->where('collection', 'blog')
  ->get();
```
#### Get an entry from a collection by its slug
```php
Entry::query()
    ->where('collection', 'blog')
    ->where('slug', 'my-first-post')
    ->first();
```
#### Get an entry by its slug in a multi-site install
```php
Entry::query()
    ->where('collection', 'team')
    ->where('slug', 'director')
    ->where('site', 'albuquerque')
    ->get();
```
#### Get all Pre-Y2K news
```php
Entry::query()
    ->where('collection', 'news')
    ->where('date', '<', '2000') 
    ->get();
```
#### Get all of today's news
```php
use Illuminate\support\Carbon;

Entry::query()
    ->where('collection', 'news')
    ->where('date', Carbon::parse('today'))
    ->get();
```
#### Get the last 12 months of news
```php
use Illuminate\support\Carbon;

Entry::query()
    ->where('collection', 'news')
    ->where('date', '>=', Carbon::parse('now')->subYears(1))
    ->get();
```
#### Find all entries authored by Jack
```php
$author = User::findByEmail('jack@statamic.com');

Entry::query()
    ->where('collection', 'news')
    ->where('author', $author->id())
    ->get();
```
#### Get all entries using a specific Blueprint
```php
Entry::query()
    ->where('blueprint', 'editorial')
    ->get();
```
#### Get all published entries
```php
Entry::query()
  ->whereStatus('published')
  ->get();
```
**What is the difference between querying against `published` and `status`?** Read more on date behavior and published status!
#### Get all entries with taxonomy terms
When you want to query all entries with a specific term, you should use the `whereTaxonomy` method:
```php
Entry::query()
  ->where('collection', 'news')
  ->whereTaxonomy('categories::laravel')
  ->get();
```
In the above example, `categories` is the taxonomy's handle and `laravel` is the term's slug.
When you want to query all entries with **multiple** terms, you should instead use the `whereTaxonomyIn` method:
```php
Entry::query()
  ->where('collection', 'news')
  ->whereTaxonomyIn(['categories::laravel', 'categories::statamic'])
  ->get();
```
**This only works when the taxonomy is linked in your collection's config.** If it's not linked in the collection config, you should use the `whereJsonContains` method instead:
```php
Entry::query()
  ->where('collection', 'news')
  ->whereJsonContains('categories_field', ['laravel', 'statamic'])
  ->get();
```
```

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

### Example URI output

Source: https://statamic.dev/variables/current_uri

An example of the value returned by the current_uri variable.

```html
/variables
```

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

### Example HTML Output

Source: https://statamic.dev/fieldtypes/sites

This is an example of the potential HTML output after processing the templating examples, showing content fetched from different sites.

```html
<ul>

  <li>Bonjour!</li>

  <li>Ton tonton tond ton thon</li>

  <li>etc</li>

</ul>
```

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

### Install Statamic Importer Addon

Source: https://statamic.dev/knowledge-base/tips/importing-content

Install the Importer addon using Composer. This is the recommended first step for importing content.

```bash
composer require statamic/importer
```

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

### Get all Users who are not doctors

Source: https://statamic.dev/frontend/content-queries

Use 'not like' with an array of patterns to exclude multiple possibilities. This example excludes names starting with 'Dr.', ending with 'MD', or containing '.M.D.'.

```php
User::query()
    ->where('name', 'not like', ['Dr.%', '%MD', '%M.D.'])
    ->get();
```

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

### Download Composer Installer

Source: https://statamic.dev/getting-started/installing/ubuntu

Downloads the Composer installer script using curl. This is the first step in installing Composer.

```curl
curl -sS https://getcomposer.org/installer | php
```

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

### Install a Starter Kit

Source: https://statamic.dev/starter-kits/creating-a-starter-kit

Install a starter kit into a new Statamic project using its repository path. This command fetches and applies the starter kit's configuration and files.

```php
php please starter-kit:install the-hoff/kung-fury-theme
```

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

### GET /api/collections/{collection}/entries

Source: https://statamic.dev/content-api

Gets entries within a specified collection. Supports filtering by site in multi-site setups.

```APIDOC
## GET /api/collections/{collection}/entries

### Description
Gets entries within a collection. If using Multi-Site, this endpoint serves from all sites at once. You can limit the fetched data to a specific site with a `site` filter.

### Method
GET

### Endpoint
/api/collections/{collection}/entries

### Query Parameters
- **site** (string) - Optional - Filters data to a specific site (e.g., `&filter[site]=fr`).

### Response
#### Success Response (200)
- **data** (array) - An array of entry objects, each containing at least a `title` field.
- **links** (object) - Links for pagination.
- **meta** (object) - Metadata about the response.

### Response Example
```json
{
  "data": [
    {
      "title": "My First Day"
    }
  ],
  "links": {...},
  "meta": {...}
}
```
```

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

### Install Starter Kit Locally

Source: https://statamic.dev/starter-kits/creating-a-starter-kit

Use the Statamic CLI with the `--local` option to install a Starter Kit from a locally configured Composer repository.

```bash
statamic new kung-fury-dev the-hoff/kung-fury-theme --local
```

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

### Install Starter Kit into Existing Site

Source: https://statamic.dev/starter-kits/installing-a-starter-kit

Run this command within an existing Statamic site's root directory to install a starter kit. This command requires PHP to be available in your PATH.

```shell
php please starter-kit:install vendor-name/starter-kit-name
```

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

### Define date variables in YAML

Source: https://statamic.dev/modifiers/is_between

Example setup for date variables used in the is_between modifier.

```yaml
date: November 15 2015

start_date: July 4 2015

end_date: December 1 2015
```

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

### Get Entries in a Collection

Source: https://statamic.dev/rest-api

Retrieves a list of entries within a specified collection. Supports filtering by site for Multi-Site setups.

```http
GET /api/collections/{collection}/entries
```

```json
{

  "data": [

    {

      "title": "My First Day"

    }

  ],

  "links": {...},

  "meta": {...}

}
```

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

### Create Site Example Output

Source: https://statamic.dev/advanced-topics/sites-api

This JSON structure shows the successful creation of a new site, including its assigned key and domains.

```json
{
  "data": {
    "name": "Jurassic World",
    "key": "pwkknrxl6y7z1n9v",
    "domains": [
      "jurassicworld.ca",
      "staging.jurassicworld.ca"
    ],
    "created_at": "2021-11-18 19:45:41"
  }
}
```

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

### Example Output of size_gigabytes

Source: https://statamic.dev/variables/size_gigabytes

This is an example of the output format for the `size_gigabytes` field, representing zero gigabytes.

```html
0.00
```

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

### Retrieve Values from Array in Antlers

Source: https://statamic.dev/modifiers/values

Use the `values` modifier in Antlers to get only the values from an array. No special setup is required.

```antlers
{{ the_team | values }}
```

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

### Export Starter Kit Command

Source: https://statamic.dev/starter-kits/creating-a-starter-kit

Run this command to export your Starter Kit to a specified repository path. This prepares files for distribution on platforms like GitHub.

```shell
php please starter-kit:export {export_repo_path}
```

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

### Create a sandbox project

Source: https://statamic.dev/knowledge-base/contribution-guide

Install a Statamic starter kit into a new directory to serve as a sandbox for testing changes.

```shell
cd sites # [tl! **]
statamic new sandbox # [tl! **]
```

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

### Get Taxonomy Terms

Source: https://statamic.dev/content-api

Retrieves a list of terms within a specified taxonomy. Supports filtering by site in Multi-Site setups.

```json
{

  "data": [

    {

      "title": "Music"

    }

  ],

  "links": {...},

  "meta": {...}

}
```

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

### Get Entries in a Collection

Source: https://statamic.dev/content-api

Retrieves a list of entries within a specified collection. Supports filtering by site for Multi-Site setups.

```json
{

  "data": [

    {

      "title": "My First Day"

    }

  ],

  "links": {...},

  "meta": {...}

}
```

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

### Full Site Configuration Example

Source: https://statamic.dev/control-panel/multi-site

A comprehensive example of a site configuration in `resources/sites.yaml`, including name, URL, locale, language, and custom attributes.

```yaml
# resources/sites.yaml

en:
  name: English
  url: /
  locale: en_US
  lang: en
  attributes:
    theme: standard
```

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

### Default Preferences YAML

Source: https://statamic.dev/control-panel/preferences

Default preferences are stored in a YAML file. This example shows basic locale and start page settings.

```yaml
locale: en

start_page: collections/articles
```

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

### Get URL in Antlers

Source: https://statamic.dev/variables/url

Use the `url` tag within Antlers to output the relative URL of the current content. No setup is required.

```antlers
{{ url }}
```

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

### Sites Fieldtype Configuration

Source: https://statamic.dev/fieldtypes/sites

Configure the Sites fieldtype in your Statamic blueprint. This example shows a basic setup for a field named 'my_sites_field'.

```yaml
fields:

  my_sites_field:

    type: sites
```

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

### Setup Vite for Control Panel

Source: https://statamic.dev/control-panel/css-javascript

Run this command to initialize Vite configuration and dependencies for the Control Panel.

```bash
php please setup-cp-vite
```

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

### Full Example: Artists Dictionary using MusicBrainz API

Source: https://statamic.dev/fieldtypes/dictionaries

A complete example of a custom Dictionary class that fetches artist data from the MusicBrainz API. It implements `options` for search suggestions and `get` for retrieving specific artist details, utilizing caching.

```php
<?php

namespace App\Dictionaries;

use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\Http;
use Statamic\Dictionaries\Dictionary;
use Statamic\Dictionaries\Item;

class Artists extends Dictionary
{
    public function options(?string $search = null): array
    {
        if (! $search) {
            return [];
        }

        $response = Http::get('https://musicbrainz.org/ws/2/artist/?fmt=json&query=artist:'.urlencode($search))->json();

        return collect($response['artists'])->mapWithKeys(function ($artist) {
            $label = $artist['name'];

            if ($disambiguation = $artist['disambiguation'] ?? null) {
                $label .= ' ('.$disambiguation.')';
            }

            return [$artist['id'] => $label];
        })->all();
    }

    public function get(string $key): ?Item
    {
        return Cache::rememberForever('artist-'.$key, function () use ($key) {
            $response = Http::get('https://musicbrainz.org/ws/2/artist/'.$key.'?fmt=json')->json();

            return new Item($key, $response['name'], [
                'name' => $response['name'],
                'disambiguation' => $response['disambiguation'] ?? null,
                'type' => $response['type'],
                'country' => $response['country'],
            ]);
        });
    }

}
```

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

### Initialize a New Starter Kit

Source: https://statamic.dev/starter-kits/creating-a-starter-kit

Use this command to initialize a new starter kit within your Statamic project. This sets up the necessary structure for developing your kit.

```php
php please starter-kit:init
```

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

### Customize Module Prompt Text

Source: https://statamic.dev/starter-kits/creating-a-starter-kit

Customize the user prompt text for a module installation. This allows for more engaging or specific questions during the setup process.

```yaml
modules:
  seo:
    prompt: 'Would you like some awesome SEO with that!?''
    dependencies:
      - statamic/seo-pro
```

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

### Install AWS Flysystem Adapter

Source: https://statamic.dev/knowledge-base/tips/digital-ocean-spaces-for-asset-container

Install the AWS Flysystem adapter using Composer. This is the first step to integrating S3-compatible storage.

```shell
composer require league/flysystem-aws-s3-v3
```

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

### Access URL Segment in Blade

Source: https://statamic.dev/variables/segment_x

Use `$segment_x` to get the value of the specified URL segment in Blade. For example, `$segment_3` retrieves the third segment.

```blade
{{ $segment_3 }}
```

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

### Access URL Segment in Antlers

Source: https://statamic.dev/variables/segment_x

Use `segment_x` to get the value of the specified URL segment in Antlers. For example, `segment_3` retrieves the third segment.

```antlers
{{ segment_3 }}
```

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

### Configure Path Repository for Updatable Starter Kits

Source: https://statamic.dev/starter-kits/creating-a-starter-kit

To make your Starter Kit updatable, configure your `composer.json` to use a path repository pointing to your `package` directory. This example also shows how to require a theme.

```json
  {

      "name": "statamic/statamic",

      "require": [

 +        "the-hoff/kung-fury-theme": "dev-master"

      ],

 +    "repositories": [

 +        {

 +            "type": "path",

 +            "url": "package"

 +        }

 +    ]

 }
```

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

### Querying Assets with Blueprint Fragments

Source: https://statamic.dev/frontend/graphql

Use fragments to query blueprint-specific fields for assets. This example shows how to get the 'alt' field from an 'Asset_Images' implementation.

```graphql
{

    entries {

        path

        ... on Asset_Images {

            alt

        }

    }

}
```

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

### Create and Configure Asset Container

Source: https://statamic.dev/backend-apis/resource-apis/asset-container-repository

Initialize a new container instance and apply configuration settings before saving.

```php
$container = AssetContainer::make('assets');
```

```php
$container
  ->title('Assets')
  ->allowDownloading(true)
  ->allowMoving(true)
  ->allowRenaming(true)
  ->allowUploads(true)
  ->createFolders(true)
  ->searchIndex('assets');
```

```php
$container->save();
```

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

### Get Entry Timestamp in Antlers

Source: https://statamic.dev/variables/timestamp

Use the timestamp tag within Antlers templates to output the entry's integer timestamp. No setup is required.

```antlers
{{ timestamp }}
```

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

### Example Input and Output

Source: https://statamic.dev/modifiers/ascii

Demonstrates the input string and the expected output after applying the ascii modifier.

```text
lemoñade
```

```html
lemonade
```

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

### Get URL in Blade

Source: https://statamic.dev/variables/url

Use the `url` tag within Blade, prefixed with a dollar sign, to output the relative URL of the current content. No setup is required.

```blade
{{ $url }}
```

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

### Product Entry Example

Source: https://statamic.dev/content-modeling/relationships

This is an example of a product entry's frontmatter, demonstrating how relationships like 'photo', 'author', and 'related_products' are stored.

```yaml
# /content/products/wayne-gretzky-pog-collection.md

title: Wayne Gretzky Pog Collection

price: 2495.00

template: products.show

id: 123-1234-12-4321

photo: products/gretzky-pogs-FINAL-(2).jpg

author: abc-abcd-ab-dcba

related_products:

  - 789-7890-78-0987

  - abc-1234-bc-4eba

```

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

### Get Absolute URL in Antlers

Source: https://statamic.dev/variables/permalink

Use the `permalink` tag within Antlers templates to output the absolute URL of the current content. No additional setup is required.

```antlers
{{ permalink }}
```

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

### Get Last URL Segment in Antlers

Source: https://statamic.dev/variables/last_segment

Use the `last_segment` tag within Antlers templates to output the last segment of the current URL. No setup is required.

```antlers
{{ last_segment }}
```

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

### Configure Export Paths in starter-kit.yaml

Source: https://statamic.dev/starter-kits/creating-a-starter-kit

Define which files and directories should be included in the export by listing them under `export_paths` in your `starter-kit.yaml`. Only listed items will be exported.

```yaml
export_paths:
  - content
  - config/filesystems.php
  - config/statamic/assets.php
  - resources/blueprints
  - resources/css/site.css
  - resources/views
  - public/assets
  - public/css
  - package.json
  - tailwind.config.js
  - webpack.mix.js
```

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

### Export Starter Kit Files

Source: https://statamic.dev/starter-kits/creating-a-starter-kit

Export the files and directories relevant to your starter kit to a separate location. This directory will become the package for redistribution.

```php
php please starter-kit:export ../kung-fury-theme
```

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

### Get Entry Date as String (Antlers)

Source: https://statamic.dev/variables/datestring

Use the `date` variable in Antlers to output the entry's pre-formatted date string. No additional setup is required.

```antlers
{{ date }}
```

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

### Check if Composer Package is Installed (Antlers)

Source: https://statamic.dev/tags/installed

Use this tag within an 'if' statement to conditionally display content. Requires no specific setup beyond the tag itself.

```antlers
{{ if {installed:statamic/seo-pro} }}

    {{ seo_pro:meta }}

{{ else }}

    {{ partial:seo }}

{{ /if }}
```

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

### Create New User Account (Artisan vs Please)

Source: https://statamic.dev/cli

Demonstrates the equivalent commands for creating a new user account using both the 'artisan' and 'please' aliases.

```shell
php please make:user
```

```shell
php artisan statamic:make:user
```

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

### Filter Indexed Items with a Closure

Source: https://statamic.dev/extending/search

Use a closure to define custom logic for filtering which items get indexed. This example only indexes published entries that do not have 'exclude_from_search' enabled.

```php
'searchables' => ['collection:blog'],

'filter' => function ($item) {

    return $item->status() === 'published' && ! $item->exclude_from_search;

}
```

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

### Get Asset Basename in Antlers

Source: https://statamic.dev/variables/basename

Use the `basename` tag within Antlers templates to output the filename with its extension. No specific setup is required beyond having an asset context.

```antlers
{{ basename }}
```

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

### Include Composer Dependencies in starter-kit.yaml

Source: https://statamic.dev/starter-kits/creating-a-starter-kit

List any Composer dependencies you want to bundle with your Starter Kit under the `dependencies` array in `starter-kit.yaml`. The exporter will manage their versions.

```yaml
dependencies:
  - statamic/ssg
```

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

### User Passkey Form Tag Example (Antlers)

Source: https://statamic.dev/tags/user-passkey_form

Use this Antlers tag to generate the necessary URLs for passkey setup. The JavaScript then uses these URLs to register the passkey.

```html
{{ user:passkey_form }}

    <input type="text" id="passkey-name" placeholder="Passkey name (e.g., My Laptop)">

    <button type="button" id="create-passkey">Create Passkey</button>



    <script>

        document.getElementById('create-passkey').addEventListener('click', () => {

            const name = document.getElementById('passkey-name').value || 'My Passkey';



            Statamic.$passkeys.register({

                optionsUrl: '{{ passkey_option_url }}',

                verifyUrl: '{{ passkey_verify_url }}',

                name: name,

                onSuccess: () => location.reload(),

                onError: (error) => alert(error.message),

                // csrfToken (optional)

            });

        });

    </script>

{{ /user:passkey_form }}
```

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

### Create a New Entry Instance

Source: https://statamic.dev/backend-apis/resource-apis/entry-repository

Initialize a new entry using `Entry::make()`. You must provide at least a collection handle and a slug before saving.

```php
$entry = Entry::make()->collection('blog')->slug('my-entry');
```

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

### Make Authenticated GraphQL API Request

Source: https://statamic.dev/graphql

Include the authentication token in the `Authorization` header when making requests to the GraphQL API. This example uses `curl` to send a GET request.

```curl
curl -X GET "https://example.com/graphql" \
  -H "Authorization: Bearer a-long-random-string" \
  -H "Accept: application/json" \
  -d '{"query": "{ping}"}'
```

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

### Example Partial Directory Structure

Source: https://statamic.dev/fieldtypes/bard

This shows the expected directory structure for storing Bard set partials. Each file name should correspond to a set type.

```files
resources/views/partials/sets/

  gallery.antlers.html
  hero_image.antlers.html
  poll.antlers.html
  text.antlers.html
  video.antlers.html
```

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

### Get Entry Timestamp in Blade

Source: https://statamic.dev/variables/timestamp

Use the timestamp tag within Blade templates, prefixed with a dollar sign, to output the entry's integer timestamp. No setup is required.

```blade
{{ $timestamp }}
```

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

### Example Output

Source: https://statamic.dev/modifiers/str_pad_left

This snippet shows the expected output after applying the string padding.

```html
01
```

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

### Composer Update Output Example

Source: https://statamic.dev/knowledge-base/contribution-guide

This output shows the Composer process of updating Statamic CMS, including removing the old version and installing the new one via a symlink from your local path.

```text
./composer.json has been updated
Running composer update statamic/cms
> Statamic\Console\Composer\Scripts::preUpdateCmd
Loading composer repositories with package information
Updating dependencies
Lock file operations: 0 installs, 1 update, 0 removals
  - Upgrading statamic/cms (v5.7.3 => 6.x-dev) 
Writing lock file
Installing dependencies from lock file (including require-dev)
Package operations: 0 installs, 1 update, 0 removals
  - Removing statamic/cms (v5.7.3)
  - Installing statamic/cms (6.x-dev): Symlinking from /path/to/cms  
  - Downloading statamic/cms (dist)
    Failed to download
Generating optimized autoload files
> Illuminate\Foundation\ComposerScripts::postAutoloadDump
> @php artisan package:discover --ansi
Discovered Package: ajthinking/archetype
Discovered Package: barryvdh/laravel-debugbar
Discovered Package: intervention/image
Discovered Package: laravel/sail
Discovered Package: laravel/tinker
Discovered Package: nesbot/carbon
Discovered Package: nunomaduro/collision
Discovered Package: nunomaduro/termwind
Discovered Package: rebing/graphql-laravel
Discovered Package: spatie/laravel-ignition
Discovered Package: statamic/cms
Discovered Package: wilderborn/partyline
> @php artisan statamic:install --ansi
Discovering addons.
Publishing [statamic] assets.
Publishing [statamic-cp] assets.
Publishing [statamic-frontend] assets.
Compiled views cleared successfully.
Application cache cleared successfully.
97 packages you are using are looking for funding.
Use the `composer fund` command to find out more!
```

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

### Get Single Variable from Parent Page

Source: https://statamic.dev/tags/parent

Fetch a specific variable from the parent entry by providing the variable name as the second argument to the Parent tag. For example, `{{ parent:title }}` retrieves the parent's title.

```antlers
{{ parent:title }}

// Would return "Tags"
```

```blade
<s:parent:title />

{{-- Using Fluent Tags --}}

{{ Statamic::tag('parent:title') }}
```

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

### Create a New Statamic Project

Source: https://statamic.dev/getting-started/installing/local

Navigate to your desired parent directory and run this command to start a new Statamic project. You will be prompted to choose between a blank site or a Starter Kit.

```shell
statamic new project_name
```

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

### Count Entries Using Collection Tag and Count Modifier (Blade)

Source: https://statamic.dev/tags/collection-count

Shows how to get the count of entries within a collection tag using Blade syntax. It includes examples of both calling the ->count() method on a Collection instance and using the count modifier.

```blade
<statamic:collection:blog

  as="entries"

>
{{-- This example calls the ->count() method on a Collection instance. --}}
There are {{ $entries->count() }} pogs in this site.

{{-- This example uses the count modifier. --}}
There are {{ Statamic::modify($entries)->count()->fetch() }} pogs in this site.

</statamic:collection:blog>
```

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

### Example Output of Site Iteration

Source: https://statamic.dev/variables/sites

Demonstrates the expected HTML output when iterating over the configured sites.

```html
english

English Site

en_US

en

http://mysite.com/

ltr

bar



french

French Site

fr_FR

fr

http://mysite.com.fr/

ltr

baz

```

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

### Accessing GET variables with Blade

Source: https://statamic.dev/variables/get

In Blade, you can access GET parameters using the `$get` array or the `request()->get()` helper. The `?? ''` provides a default empty string if the parameter is not set.

```blade
{{ $get['show'] ?? '' }}



-- or --



{{ request()->get('show') }}
```

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

### Serve Local Statamic Site

Source: https://statamic.dev/getting-started/installing/local

If you don't have a server environment like Valet set up, use this command to start a local development server. The provided URL is where you can access your site.

```cli
php artisan serve

Starting Laravel development server: http://127.0.0.1:8000
```

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

### Example Asset File Extension

Source: https://statamic.dev/variables/extension

This shows an example of what the output might look like when accessing an asset's file extension.

```html
jpg
```

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

### Accessing GET variables with Antlers

Source: https://statamic.dev/variables/get

Use the `get` tag to access query string parameters. You can access individual parameters like `get:show` or iterate over all parameters within a `get` tag pair.

```antlers
{{ get:show }}



{{ get }}

  {{ show }}

  {{ hide }}

{{ /get }}
```

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

### GET /api/forms

Source: https://statamic.dev/content-api

Gets all forms.

```APIDOC
## GET /api/forms

### Description
Gets all forms.

### Method
GET

### Endpoint
/api/forms

### Response
#### Success Response (200)
- **data** (array) - An array of form objects.
  - **handle** (string) - The handle of the form.
  - **title** (string) - The title of the form.
  - **fields** (object) - An object containing form fields.
  - **api_url** (string) - The API URL for the form.

### Response Example
```json
{
  "data": [
    {
      "handle": "contact",
      "title": "Contact",
      "fields": {
        "name": {...},
        "email": {...},
        "inquiry": {...}
      },
      "api_url": "http://example.com/api/forms/contact"
    },
    {
      "handle": "newsletter",
      "title": "Subscribe to Newsletter",
      "fields": {
        "email": {...}
      },
      "api_url": "http://example.com/api/forms/newsletter"
    }
  ]
}
```
```

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

### Starter Kit Package Directory Structure

Source: https://statamic.dev/starter-kits/creating-a-starter-kit

The `package` directory is the root of your Starter Kit repository. It must contain at least `composer.json` and `starter-kit.yaml`.

```files
 app/

 content/

 config/

+package/ 
+  composer.json 
+  starter-kit.yaml 
 public/

 resources/

 composer.json
```

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

### Example Layout File Name

Source: https://statamic.dev/variables/current_layout

This example shows a typical layout file name. The `current_layout` variable will output this string when this layout is active.

```html
layouts.blog
```

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

### Install FFmpeg for Video Thumbnails

Source: https://statamic.dev/assets

Install FFmpeg, a requirement for Statamic to generate video thumbnails. Installation commands are provided for macOS (Homebrew) and Ubuntu/Debian.

```shell
# macOS (Homebrew)

brew install ffmpeg
```

```shell
# Ubuntu/Debian

sudo apt install ffmpeg
```

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

### Define example variable

Source: https://statamic.dev/modifiers/rawurlencode_except_slashes

Example input string for the modifier.

```yaml
example: please and thank you/Mommy
```

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

### Create and Save Assets

Source: https://statamic.dev/backend-apis/resource-apis/asset-repository

Initialize an asset instance, add metadata, and save it to the repository.

```php
$asset = Asset::make()->container('assets')->path('images/hat.jpg');
```

```php
$asset = $container->makeAsset('images/hat.jpg');
```

```php
$asset->data(['foo' => 'bar']);
```

```php
$asset->save(); // true or false
```

```php
$file = $request->file('file');
$asset->upload($file);
```

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

### Create New User Instance

Source: https://statamic.dev/backend-apis/resource-apis/user-repository

Start creating a new user instance. An email is required before saving.

```php
$user = User::make()->email('john@smith.com');
```

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

### Enable Updatable Starter Kit

Source: https://statamic.dev/starter-kits/creating-a-starter-kit

Add `updatable: true` to your `starter-kit.yaml` file to keep the starter kit as a Composer dependency for future updates.

```yaml
+updatable: true 
 export_paths: ...
```

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

### Execute post-install commands

Source: https://statamic.dev/addons/building-an-addon

Use the afterInstalled method within bootAddon to trigger custom commands after the addon installation process.

```php
public function bootAddon()
{
    Statamic::afterInstalled(function ($command) {
        $command->call('some:command');
    });
}
```

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

### Creating and Using a Custom Markdown Parser

Source: https://statamic.dev/extending/markdown

Demonstrates how to create a new parser instance with custom configurations and extensions, then use it to parse Markdown content.

```php
Markdown::makeParser($config)
    ->withAutoLinks()
    ->addExtensions(...)
    ->parse('# Heading');
```

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

### Define Pi Variable

Source: https://statamic.dev/modifiers/round

Example variable definition for the round modifier examples.

```yaml
pi: 3.14159265359
```

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

### Example CDATA Output

Source: https://statamic.dev/modifiers/cdata

This is an example of how content wrapped in CDATA tags will appear.

```html
<![CDATA[My Very Own Podcast]]>
```

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

### Static HTML Example

Source: https://statamic.dev/fieldtypes/users

This is a static HTML example showing how user data might be displayed, including a placeholder avatar and hardcoded name and email.

```html
<div class="bg-white p-4 shadow flex items-center">

  <img class="w-10 h-10 rounded-full" src="/img/avatars/david.jpg" alt="Avatar of David Hasselhoff">

    <div class="text-sm ml-4">

      <p class="text-gray-900 leading-none">David Hasselhoff</p>

      <p class="text-gray-600">thehoff@statamic.com</p>

    </div>

</div>
```

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

### Basic Usage

Source: https://statamic.dev/backend-apis/blink-cache

Demonstrates how to put and get values from the Blink Cache.

```APIDOC
## Basic Usage

### Description
Use `Blink::put()` to store a value with a given key and `Blink::get()` to retrieve it.

### Method
`put(string $key, mixed $value)`
`get(string $key, mixed $default = null)`

### Example
```php
use Statamic\Facades\Blink;

Blink::put('key', 'value');
$value = Blink::get('key'); // 'value'
```
```

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

### Example SVG Icon

Source: https://statamic.dev/fieldtypes/icon

This is an example of an SVG icon that the fieldtype might return.

```html
<svg viewBox="0 0 24 24"><path fill="currentColor" d="M11.983 0a12.206 12.206 0 0 0-8.51 3.653A11.8 11.8 0 0 0 0 12.207C-.008 18.712 5.26 23.992 11.765 24h.249c6.678-.069 12.04-5.531 11.986-12.209C24.015 5.293 18.76.013 12.262-.003L11.983 0zM10.5 16.542a1.475 1.475 0 0 1 1.421-1.529l.028-.001h.027c.82.002 1.492.651 1.523 1.47a1.475 1.475 0 0 1-1.419 1.529l-.03.001h-.027a1.53 1.53 0 0 1-1.523-1.47zM11 12.5v-6a1 1 0 0 1 2 0v6a1 1 0 0 1-2 0z"></path></svg>
```

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

### Initial Search Index Update

Source: https://statamic.dev/extending/search

Run this command to create and sync your search indexes when you first set up search.

```bash
php please search:update
```

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

### Example Partial Directory Structure (Blade)

Source: https://statamic.dev/fieldtypes/bard

This illustrates the directory structure for Blade partials used with Bard sets. Each file name should match a set type for dynamic inclusion.

```files
resources/views/partials/sets/

  gallery.blade.php
  hero_image.blade.php
  poll.blade.php
  text.blade.php
  video.blade.php
```

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

### GET /api/globals/{handle}

Source: https://statamic.dev/content-api

Gets a single global set's variables by its handle.

```APIDOC
## GET /api/globals/{handle}

### Description
Gets a single global set's variables.

### Method
GET

### Endpoint
/api/globals/{handle}

### Response
#### Success Response (200)
- **data** (object) - The global set object.
  - **handle** (string) - The handle of the global set.
  - **api_url** (string) - The API URL for the global set.
  - **foo** (string) - Example field.

### Response Example
```json
{
  "data": {
    "handle": "global",
    "api_url": "http://example.com/api/globals/global",
    "foo": "bar"
  }
}
```
```

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

### GET /api/taxonomies/{taxonomy}/terms/{slug}

Source: https://statamic.dev/content-api

Gets a single taxonomy term by its slug.

```APIDOC
## GET /api/taxonomies/{taxonomy}/terms/{slug}

### Description
Gets a single taxonomy term.

### Method
GET

### Endpoint
/api/taxonomies/{taxonomy}/terms/{slug}

### Response
#### Success Response (200)
- **data** (object) - The taxonomy term object.
  - **title** (string) - The title of the term.

### Response Example
```json
{
  "data": {
    "title": "My First Day"
  }
}
```
```

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

### Install spatie/fork for Fork Concurrency Driver

Source: https://statamic.dev/stache

Install the spatie/fork package using Composer to enable the 'fork' concurrency driver for parallel warming.

```shell
composer require spatie/fork
```

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

### Creating a New Asset Container

Source: https://statamic.dev/backend-apis/resource-apis/asset-container-repository

Step-by-step guide on creating and configuring a new asset container.

```APIDOC
## Creating a New Asset Container

### Description
Create and configure a new AssetContainer instance.

### Method
`make()`

### Endpoint
N/A (Method chaining on AssetContainer object)

### Request Body Example
```php
// Make a new container instance
$container = AssetContainer::make('assets');

// Customize the container
$container
  ->title('Assets')
  ->allowDownloading(true)
  ->allowMoving(true)
  ->allowRenaming(true)
  ->allowUploads(true)
  ->createFolders(true)
  ->searchIndex('assets');

// Save the container
$container->save();
```

### Response Example
(Returns the saved AssetContainer object upon successful creation)
```

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

### Example Output

Source: https://statamic.dev/modifiers/ensure_left

This HTML demonstrates the expected output after applying the Ensure Left modifier to the provided links.

```html
<li>http://statamic.com</li>

<li>http://wilderborn.com</li>
```

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

### Translation File Example

Source: https://statamic.dev/tags/trans

Example of a PHP language file containing translation strings.

```php
<?php

return [

    'bar' => 'Bar!',

    'welcome' => 'Welcome, :name!',

    'apples' => 'There is one apple|There are :count apples',

];
```

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

### Initialize Git Remote and Track Branch

Source: https://statamic.dev/git-automation

Manually set up a Git remote and upstream branch for pushing. This example initializes a repository, adds an 'origin' remote, fetches, and tracks the 'master' branch.

```shell
git init

git remote add origin git@github.com:your/remote-repository.git

git fetch

git branch --track master origin/master

git reset HEAD
```

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

### Word Count Output Example

Source: https://statamic.dev/modifiers/word_count

Example output for a string containing eight words.

```html
8
```

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

### Configure an Opt-in SEO Module

Source: https://statamic.dev/starter-kits/creating-a-starter-kit

Use this to configure an opt-in 'seo' module with its dependencies. This presents a choice to the user during installation.

```yaml
modules:
  seo:
    dependencies:
      - statamic/seo-pro
```

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

### Custom Protection Driver Example

Source: https://statamic.dev/protecting-content

Create a custom protection driver by extending the Protector class and implementing the protect method. This example randomly allows or denies access.

```php
<?php

use Statamic\Auth\Protect\Protectors\Protector;

class CoinFlip extends Protector
{
    public function protect()
    {
        $heads = (bool) random_int(0, 1);

        abort_if($heads, 403);

    }
n}
```

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

### GET /api/globals

Source: https://statamic.dev/content-api

Gets all globals. If using Multi-Site, you can select the site using the `site` parameter.

```APIDOC
## GET /api/globals

### Description
Gets all globals.

### Method
GET

### Endpoint
/api/globals

### Query Parameters
- **site** (string) - Optional - Used with Multi-Site to select the site.

### Response
#### Success Response (200)
- **data** (array) - An array of global set objects.
  - **handle** (string) - The handle of the global set.
  - **api_url** (string) - The API URL for the global set.
  - **foo** (string) - Example field.
  - **baz** (string) - Example field.

### Response Example
```json
{
  "data": [
    {
      "handle": "global",
      "api_url": "http://example.com/api/globals/global",
      "foo": "bar"
    },
    {
      "handle": "another",
      "api_url": "http://example.com/api/globals/another",
      "baz": "qux"
    }
  ]
}
```
```

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

### Create a Statamic Sandbox Project

Source: https://statamic.dev/contribution-guide

Set up a local Statamic project by installing a Starter Kit. This creates a runnable Laravel application where you can integrate your CMS modifications.

```shell
cd sites 
statamic new sandbox 
Creating a statamic/statamic project at ./sandbox

[✔] Statamic has been successfully installed into the sandbox directory.

Build something rad!
```
Tokens:
Raw