Thank you!
{{ /if }} {{ if errors }} {{ errors }}{{ value }}
{{ /errors }} {{ /if }} ... {{ /form:contact }} ``` ### AJAX Form Submission Submit forms via AJAX by posting to `POST /!/forms/{form-handle}`. Include the `X-Requested-With: XMLHttpRequest` header. The request body must include `_token` (CSRF token) and `_params` fields alongside the form data. The endpoint returns JSON with success/error status and any validation messages. Example JavaScript submission: ```javascript fetch('/!/forms/contact', { method: 'POST', headers: { 'X-Requested-With': 'XMLHttpRequest', 'Content-Type': 'application/json', }, body: JSON.stringify({ _token: document.querySelector('meta[name="csrf-token"]').content, name: 'John', email: '[email protected]', message: 'Hello', }), }); ``` ### Form Submissions Storage Submissions are stored as YAML files in `storage/forms/{handle}/`. Each submission gets a timestamped filename. Access submissions programmatically via the `Form` facade or view them in the Control Panel under Forms. ## Search ### Configuration Configure search indexes in `config/statamic/search.php`: ```php 'default' => [ 'driver' => 'local', // or 'algolia' 'searchables' => 'content', // or ['collection:blog', 'taxonomy:tags', 'users'] 'fields' => ['title', 'content'], 'transformers' => [...], ], ``` Set `searchables` to `'content'` to index everything, or pass an array of specific collections, taxonomies, or `'users'`. The `fields` array controls which fields are indexed for searching. Use `transformers` to modify field values before indexing (e.g., stripping HTML tags from content fields). Define multiple named indexes for different search contexts (e.g., a `blog` index and a `docs` index with different searchable content and field weights). ### Drivers **Local (Comb)** -- JSON-based index with configurable scoring and stemming. No external dependencies. Suitable for small to medium sites. **Algolia** -- Requires `algolia/algoliasearch-client-php:^3.4`. Set `driver` to `algolia` and configure API credentials in `.env`: ```env ALGOLIA_APP_ID=your-app-id ALGOLIA_SECRET=your-secret-key ``` ### CLI Commands ```bash php please search:update # Interactive index update php please search:update default # Update a specific index php please search:update --all # Update all indexes ``` ## REST API (Pro Feature) Enable the REST API by setting `STATAMIC_API_ENABLED=true` in `.env`. All endpoints are prefixed with `/api/`. See `references/api-endpoints.md` for the full endpoint table with methods, paths, and descriptions. ### Filtering ``` /api/collections/blog/entries?filter[title:contains]=awesome&filter[status]=published ``` Filter operators include `contains`, `is`, `not`, and field-specific operators. ### Sorting ``` ?sort=-date,title ``` Prefix with `-` for descending order. Comma-separate multiple sort fields. ### Field Selection ``` ?fields=id,title,content ``` Limit response payload to specific fields. ### Pagination ``` ?limit=10&page=2 ``` Response includes pagination metadata with `total`, `count`, `per_page`, `current_page`, `total_pages`, and navigation links. ### API Configuration Customize API behavior in `config/statamic/api.php`. Configure allowed resources, enable or disable specific endpoints, set default pagination limits, and define custom middleware. Restrict API access with authentication middleware or Laravel Sanctum for token-based auth. ## GraphQL API (Pro Feature) Enable with `STATAMIC_GRAPHQL_ENABLED=true` in `.env`. Access GraphiQL from the Control Panel. Key queries: `entries`, `entry(id:)`, `collections`, `collection(handle:)`, `terms`, `term(id:)`, `assets`, `asset`, `globalSets`, `globalSet(handle:)`, `navs`, `nav(handle:)`, `users`, `user`, `forms`, `form(handle:)`. Use blueprint-specific types via fragments: ```graphql { entries(collection: "blog") { data { title ... on Entry_Blog_Post { intro content } } } } ``` See `references/api-endpoints.md` for full GraphQL query reference. ## Multi-site (Pro Feature) Enable multi-site by setting `'multisite' => true` in `config/statamic/system.php`, then run: ```bash php please multisite ``` Define sites in `resources/sites.yaml`: ```yaml en: name: English url: / locale: en_US fr: name: French url: /fr/ locale: fr_FR lang: fr ``` Each site can have its own URL prefix, locale, and language. Content can be localized per site with origin-based entry linking. The origin entry is the default locale version; localized entries reference it and override specific fields. Configure per-site content in collections by setting `sites` in the collection YAML to control which sites a collection is available on. Taxonomy terms and global sets can also be localized per site. ## Git Automation (Pro Feature) Enable automatic git commits for content changes: ```env STATAMIC_GIT_ENABLED=true STATAMIC_GIT_AUTOMATIC=true STATAMIC_GIT_PUSH=true ``` Configure tracked paths in `config/statamic/git.php`. By default, Statamic tracks `content/`, `users/`, and `resources/` directories. Customize tracked paths to include or exclude specific directories. When `STATAMIC_GIT_AUTOMATIC=true`, Statamic commits after every content change in the Control Panel. When `STATAMIC_GIT_PUSH=true`, it also pushes to the remote. Trigger a manual commit: ```bash php please git:commit ``` Set commit message format and author in the git config. Use queue workers for async git operations to avoid blocking CP responses. ## Live Preview Configure in `config/statamic/live_preview.php` -- set device sizes, toolbar inputs, and hot reload behavior. Define preview targets per collection in the collection YAML: ```yaml preview_targets: - label: Entry url: /blog/{slug} - label: Index url: /blog ``` ## Control Panel Access the CP at `/cp`. Open the Command Palette with `Cmd+K` (macOS) or `Ctrl+K` (Linux/Windows). Statamic v6 uses Vue 3 + Pinia architecture. Create users via `php please make:user` or through CP invitations. ### Permissions (Pro) Role-based permissions stored in `resources/users/roles.yaml`. Assign roles to users or user groups for granular access control. Permissions cover collections, taxonomies, globals, assets, users, forms, and utilities. Define custom roles with fine-grained permissions (e.g., allow editing blog entries but not deleting them, or restrict access to specific asset containers). ### Conditional Fields in Blueprints ```yaml - handle: venue field: type: text if: event_type: in_person validate: [sometimes, required] - handle: stream_url field: type: text unless: event_type: in_person ``` **Operators**: `is`/`equals`/`==`, `not`/`isnt`/`!=`, `===`, `!==`, `>`, `>=`, `<`, `<=`, `contains`, `contains_any`, `empty`, `not empty`, `null`, `true`, `false`. **Logic**: Multiple conditions default to AND. Use `if_any` / `unless_any` for OR logic. Access nested fields with dot notation (`address.country`), parent context with `$parent.field`, root context with `$root.field`.