20 | ```
21 |
--------------------------------------------------------------------------------
/content/collections/modifiers/ol.md:
--------------------------------------------------------------------------------
1 | ---
2 | types:
3 | - array
4 | - markup
5 | id: 327f4a3b-04d4-4069-881a-fe50ddb9be23
6 | ---
7 | Turn an array into an HTML ordered list element.
8 |
9 | ```.language-yaml
10 | food:
11 | - sushi
12 | - broccoli
13 | - kale
14 | ```
15 |
16 | ```
17 | {{ food | ol }}
18 | ```
19 |
20 | ```.language-output
21 |
7 |
10 |
11 |
--------------------------------------------------------------------------------
/content/collections/events/asset-container-saved.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: AssetContainerSaved
3 | class: Statamic\Events\Data\AssetContainerSaved
4 | id: 2f2863f2-d32f-42d2-bd95-ed53760bfa1c
5 | ---
6 | This is a [data event](/addons/events#data-events) that is dispatched when an asset container has been saved.
7 |
8 | ```
9 | public function handle(AssetContainerSaved $event)
10 | {
11 | // In addition to data event methods, you get:
12 | $event->container; // The asset container object.
13 | }
14 | ```
15 |
--------------------------------------------------------------------------------
/content/collections/fieldtypes/section.md:
--------------------------------------------------------------------------------
1 | title: Section
2 | description: A simple visual header to help organize long publish forms.
3 | overview: "The Section fieldtype is perfect for giving your fields some breathing room and organization. It serves as a visual break in the publish form as a section header allowing you to group your fields into various sections. You'd be surprised how much this can help your content managers."
4 | image: /assets/fieldtypes/section.jpg
5 | id: 88b0d4a4-e81a-4e84-8a01-fc90f54202a5
6 |
--------------------------------------------------------------------------------
/content/collections/modifiers/explode.md:
--------------------------------------------------------------------------------
1 | ---
2 | types:
3 | - string
4 | - array
5 | id: c3d3e2c4-218e-4841-a594-647f10863866
6 | ---
7 | Breaks a string into an array of strings split on a given delimiter.
8 |
9 | ```.language-yaml
10 | places: Scotland, England, Switzerland, Italy
11 | ```
12 |
13 | ```
14 | {{ places | explode:, | ul }}
15 | ```
16 |
17 | ```.language-html
18 | -
19 |
- Scotland 20 |
- England 21 |
- Switzerland 22 |
- Italy 23 |
Ode To Bacon
20 |Bacon. Mmm, bacon.
21 | ``` 22 | -------------------------------------------------------------------------------- /content/collections/classes/pagefactory.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: PageFactory 3 | class: Statamic\Data\Pages\PageFactory 4 | id: d64d4654-939e-47f4-90a1-b44a4978f0aa 5 | --- 6 | Inheritance: [ContentFactory](/addons/api/contentfactory) 7 | 8 | ## Usage 9 | 10 | Create a `PageFactory` using the API class. You should pass the URI into the `create` method. 11 | 12 | ``` 13 | $factory = Statamic\API\Page::create('/about'); 14 | ``` 15 | 16 | ## Available Methods 17 | 18 | There are no additional methods on this class. 19 | -------------------------------------------------------------------------------- /content/collections/modifiers/add.md: -------------------------------------------------------------------------------- 1 | --- 2 | types: 3 | - math 4 | id: 53debd55-5d53-4254-ad86-49a26cb09594 5 | --- 6 | Add a value or another variable to your variable. Pass an integer or the name of a second variable as the parameter. Also supports `+` as shorthand. 7 | 8 | ```.language-yaml 9 | books: 5 10 | magazines: 10 11 | ``` 12 | 13 | ``` 14 | {{ books | add:5 }} 15 | {{ books | add:magazines }} 16 | {{ books | +:magazines }} 17 | ``` 18 | 19 | ```.language-output 20 | 10 21 | 15 22 | 15 23 | ``` 24 | -------------------------------------------------------------------------------- /content/collections/modifiers/ensure_right.md: -------------------------------------------------------------------------------- 1 | --- 2 | types: 3 | - string 4 | - utility 5 | id: 6854539a-4661-483b-bb1f-2d28df0db76e 6 | --- 7 | Ensures that the string ends with a specified string. If it doesn't, it will now. 8 | 9 | ```.language-yaml 10 | links: 11 | - statamic 12 | - wilderborn.com 13 | ``` 14 | 15 | ``` 16 | {{ links }} 17 |{{ title }}
18 |{{ content | read_time:180 }} min
19 | ``` 20 | 21 | ```.language-output 22 |A long post
23 |10 min
24 | ``` 25 | -------------------------------------------------------------------------------- /content/collections/modifiers/seconds_ago.md: -------------------------------------------------------------------------------- 1 | --- 2 | types: 3 | - date 4 | id: 603701ba-5da7-4ec8-abe5-5bc9fe6861ea 5 | parse_content: true 6 | --- 7 | Returns the number of seconds since a given date variable. Statamic will attempt to parse any string as a date, but try to keep it in the least ambiguous date format possible. 8 | 9 | ```.language-yaml 10 | date: October 1 2015 8:30:am 11 | ``` 12 | 13 | {{ noparse }} 14 | ``` 15 | {{ date | seconds_ago }} 16 | ``` 17 | {{ /noparse }} 18 | 19 | ```.language-output 20 | {{ test_date | seconds_ago }} 21 | ``` 22 | -------------------------------------------------------------------------------- /content/collections/modifiers/shuffle.md: -------------------------------------------------------------------------------- 1 | --- 2 | types: 3 | - array 4 | - markup 5 | id: 63acdaa6-9724-4179-b210-ea5d507672e9 6 | --- 7 | Shuffles a string or an array to make it all random. 8 | 9 | ```.language-yaml 10 | string: Mr. Roboto was the original hipster. 11 | array: 12 | - Sonic 13 | - Knuckles 14 | - Tails 15 | ``` 16 | 17 | ``` 18 | {{ string | shuffle }} 19 | {{ array | shuffle }} 20 | ``` 21 | 22 | ```.language-yaml 23 | string: a nhglRsws.oMtiotr hprriao eeo.b ti 24 | array: 25 | - Tails 26 | - Knuckles 27 | - Sonic 28 | ``` 29 | -------------------------------------------------------------------------------- /content/collections/modifiers/subtract.md: -------------------------------------------------------------------------------- 1 | --- 2 | types: 3 | - math 4 | id: baad70cf-0af2-48bc-b102-b0da0293baf4 5 | --- 6 | Subtract a value or another variable to your variable. Pass an integer or the name of a second variable as the parameter. Also supports `-` as shorthand. 7 | 8 | ```.language-yaml 9 | capacity: 2500 10 | reservations: 1900 11 | ``` 12 | 13 | ``` 14 | {{ capacity | subtract:1900 }} 15 | {{ capacity | subtract:reservations }} 16 | {{ capacity | -:reservations }} 17 | ``` 18 | 19 | ```.language-output 20 | 600 21 | 600 22 | 600 23 | ``` 24 | -------------------------------------------------------------------------------- /content/collections/tags/session-dump.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Session:Dump 3 | overview: The session:dump tag is used to inspect the user session for debugging purposes. 4 | id: d1ef36ac-7d21-40b2-a7fc-b53a0be3c79c 5 | --- 6 | ## Usage 7 | 8 | You can dump the contents of the user session to aid with development. 9 | ``` 10 | {{ session:dump }} 11 | ``` 12 | 13 | It will be injected into the rendered page in your browser. 14 | 15 |
16 | 
18 |
19 |
--------------------------------------------------------------------------------
/content/collections/classes/api-role.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Role
3 | class: Statamic\API\Role
4 | id: 795ff9b8-7395-4547-ad72-9d4426711da9
5 | ---
6 | ## Get all roles.
7 |
8 | ``` php
9 | Role::all(); // Returns \Illuminate\Support\Collection
10 | ```
11 |
12 | ## Get a role by ID.
13 |
14 | ``` php
15 | Role::find($id); // Returns Role
16 | ```
17 |
18 | ## Check if a role exists.
19 |
20 | ``` php
21 | Role::exists($id); // Returns a boolean
22 | ```
23 |
24 | ## Get a role by handle.
25 |
26 | ``` php
27 | Role::whereHandle($handle); // Returns Role
28 | ```
29 |
--------------------------------------------------------------------------------
/content/collections/events/statamic-updated.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: StatamicUpdated
3 | class: Statamic\Events\StatamicUpdated
4 | id: 5c71e252-9482-4344-87fb-662dba64a5b0
5 | ---
6 | Fired when the Updater has completed, either through the Control Panel or the command line.
7 |
8 | ```
9 | public $events = [StatamicUpdated::class => 'handle'];
10 |
11 | public function handle(StatamicUpdated $event)
12 | {
13 | $event->version; // The current/new version of Statamic.
14 | $event->previousVersion; // The version Statamic was updated from.
15 | }
16 | ```
17 |
--------------------------------------------------------------------------------
/content/collections/modifiers/gravatar.md:
--------------------------------------------------------------------------------
1 | ---
2 | types:
3 | - string
4 | - utility
5 | id: c0a376c1-1ade-447b-8a2d-18722a5446ba
6 | ---
7 | Converts an email string to a Gravatar image URL. The size can be specified by a parameter.
8 |
9 | ```.language-yaml
10 | email: rswanson@inpra.org
11 | ```
12 |
13 | ```
14 | {{ email | gravatar }}
15 | {{ email | gravatar:80 }}
16 | ```
17 |
18 | ```.language-output
19 | https://www.gravatar.com/avatar/f4650388367dc01cf2acf16b412b3966
20 | https://www.gravatar.com/avatar/f4650388367dc01cf2acf16b412b3966?s=80
21 | ```
22 |
--------------------------------------------------------------------------------
/content/collections/modifiers/is_alpha.md:
--------------------------------------------------------------------------------
1 | ---
2 | types:
3 | - string
4 | - conditions
5 | id: a6aaac80-19b7-4400-af21-9147aff064c4
6 | ---
7 | Returns `true` if string contains **only** alphabetic characters. Numbers, punctuation, whitespace, and another other special characters will cause a `false`.
8 |
9 | ```.language-yaml
10 | secret_phrase: abcdefg
11 | even_more_secret_phrase: abc123
12 | ```
13 |
14 | ```
15 | {{ if secret_phrase | is_alpha }}
16 | {{ if even_more_secret_phrase | is_alpha }}
17 | ```
18 |
19 | ```.language-output
20 | true
21 | false
22 | ```
--------------------------------------------------------------------------------
/content/collections/modifiers/underscored.md:
--------------------------------------------------------------------------------
1 | ---
2 | types:
3 | - string
4 | - utility
5 | id: 61a30026-8f98-454e-bcf2-fa7ec1435438
6 | ---
7 | Returns a lowercase and trimmed string separated by underscores.
8 | Underscores are inserted before uppercase characters (with the exception
9 | of the first character of the string), and in place of spaces as well as dashes.
10 |
11 |
12 | ```.language-yaml
13 | string: Please and thank you
14 | ```
15 |
16 | ```
17 | {{ string | underscored }}
18 | ```
19 |
20 | ```.language-output
21 | please_and_thank_you
22 | ```
23 |
--------------------------------------------------------------------------------
/content/collections/tags/form.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Form
3 | is_parent_tag: true
4 | overview: Create and display submissions grouped into different sections.
5 | id: e4f4f91e-a442-4e15-9e16-3b9880a25522
6 | ---
7 | For information on how to best use these tags, visit the [Trail Guide](/forms).
8 |
9 | There are multiple form tags you may be interested in:
10 |
11 | - [form:create](/tags/form-create)
12 | - [form:errors](/tags/form-errors)
13 | - [form:set](/tags/form-set)
14 | - [form:submission](/tags/form-submission)
15 | - [form:submissions](/tags/form-submissions)
16 |
--------------------------------------------------------------------------------
/content/collections/modifiers/camelize.md:
--------------------------------------------------------------------------------
1 | ---
2 | types:
3 | - string
4 | id: fe6dbf39-7870-4aa4-9acb-23b4cbf4bf87
5 | ---
6 | Returns a camelCase version of a string. Trims surrounding spaces, capitalizes letters following digits, spaces, dashes and underscores, and removes spaces, dashes and underscores. It's a programmer-type thing, great for converting between code styles.
7 |
8 | ```.language-yaml
9 | method: make_everything_better
10 | ```
11 |
12 | ```
13 | {{ method | camelize }}
14 | ```
15 |
16 | ```.language-output
17 | makeEverythingBetter
18 | ```
19 |
20 |
--------------------------------------------------------------------------------
/content/collections/modifiers/pad.md:
--------------------------------------------------------------------------------
1 | ---
2 | types:
3 | - array
4 | id: 0a1595bc-5b41-401c-bb9c-45c35e8e5d7c
5 | ---
6 | Pad an array to a given number of items with a value. By default the value is null, but you can specify it as the second parameter.
7 |
8 | ```.language-yaml
9 | epic_meal_time:
10 | - jack daniels
11 | - bacon strips
12 | ```
13 |
14 | ```
15 | {{ epic_meal_time pad="4:bacon strips" }}
16 | {{ value }}
17 | {{ /epic_meal_time }}
18 | ```
19 |
20 | ```.language-output
21 | jack daniels
22 | bacon strips
23 | bacon strips
24 | bacon strips
25 | ```
26 |
--------------------------------------------------------------------------------
/content/collections/modifiers/textile.md:
--------------------------------------------------------------------------------
1 | ---
2 | types:
3 | - markup
4 | attributes: true
5 | id: 53a0c177-ce45-43e6-a166-d21f8baeffab
6 | ---
7 | Transform a string with [Textile][textile].
8 |
9 | ```.language-yaml
10 | quote: You can't wait for inspiration. *You have to go after it with a club.*
11 |
12 | ```
13 |
14 | ```
15 | {{ quote | textile }}
16 | ```
17 |
18 | ```.language-output
19 | Preview
17 |
18 | 20 | You can't wait for inspiration. You have to go after it with a club. 21 |
22 | ``` 23 | 24 | [textile]: http://demo.textilewiki.com/theme-default/ 25 | -------------------------------------------------------------------------------- /content/collections/classes/termfactory.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: TermFactory 3 | class: Statamic\Data\Taxonomies\TermFactory 4 | id: fa4bfc78-cc0d-4bc1-888a-3ae5d6181954 5 | --- 6 | Inheritance: [ContentFactory](/addons/api/contentfactory) 7 | 8 | ## Usage 9 | 10 | Create a `TermFactory` using the API class. You should pass the slug into the `create` method. 11 | 12 | ``` 13 | $factory = Statamic\API\Term::create('my-term'); 14 | ``` 15 | 16 | ## Available Methods 17 | 18 | ### taxonomy 19 | 20 | Specify the taxonomy, as a string. 21 | 22 | ``` 23 | $factory->taxonomy('tags'); 24 | ``` 25 | -------------------------------------------------------------------------------- /content/collections/modifiers/is_alphanumeric.md: -------------------------------------------------------------------------------- 1 | --- 2 | types: 3 | - string 4 | - conditions 5 | id: 923f34bd-d17d-4353-821f-48e986bdce3b 6 | --- 7 | Returns `true` if string contains **only** alphanumeric characters. Punctuation, whitespace, and another other special characters will cause a `false`. 8 | 9 | ```.language-yaml 10 | secret_phrase: abc123 11 | even_more_secret_phrase: abc123!@# 12 | ``` 13 | 14 | ``` 15 | {{ if secret_phrase | is_alphanumeric }} 16 | {{ if even_more_secret_phrase | is_alphanumeric }} 17 | ``` 18 | 19 | ```.language-output 20 | true 21 | false 22 | ``` -------------------------------------------------------------------------------- /content/collections/modifiers/dump.md: -------------------------------------------------------------------------------- 1 | --- 2 | types: 3 | - utility 4 | id: 12de1a6c-e8be-4703-81a3-fc270311bc84 5 | --- 6 | Dump a variable to the browser and see under the hood with data types and array exportation. Definitely just for debugging when in development. 7 | 8 | ```.language-yaml 9 | food: 10 | delicious: 11 | - bacon 12 | - sushi 13 | ``` 14 | 15 | ``` 16 | {{ food | dump }} 17 | ``` 18 | 19 | ```.language-output 20 | array:2 [▼ 21 | "delicious" => array:2 [▶] 22 | ] 23 | ``` 24 | 25 | You can also use the [dump tag](/tags/dump) to achieve a similar effect. 26 | -------------------------------------------------------------------------------- /content/collections/modifiers/markdown.md: -------------------------------------------------------------------------------- 1 | --- 2 | types: 3 | - markup 4 | attributes: true 5 | id: 39dcb2b1-a319-4a0b-b7d0-5c7a1b8aa31b 6 | --- 7 | Transform a string with [Markdown][markdown]. 8 | 9 | ```.language-yaml 10 | quote: You can't wait for inspiration. **You have to go after it with a club.** 11 | 12 | ``` 13 | 14 | ``` 15 | {{ quote | markdown }} 16 | ``` 17 | 18 | ```.language-output 19 |20 | You can't wait for inspiration. You have to go after it with a club. 21 |
22 | ``` 23 | 24 | [markdown]: https://daringfireball.net/projects/markdown/ 25 | -------------------------------------------------------------------------------- /content/collections/modifiers/is_after.md: -------------------------------------------------------------------------------- 1 | --- 2 | types: 3 | - date 4 | - conditions 5 | id: 3c167645-5ad1-45b4-b6df-22b0d2c95abf 6 | --- 7 | Returns `true` if a date variable is after another date. That second date can be the name of another variable or a literal date string. 8 | 9 | ```.language-yaml 10 | start_date: January 17 2015 11 | end_date: December 1 2015 12 | ``` 13 | 14 | ``` 15 | {{ if end_date | is_after:start_date }} 16 | {{ if start_date | is_after:2014 }} 17 | {{ if start_date | is_after:end_date }} 18 | ``` 19 | 20 | ```.language-output 21 | true 22 | true 23 | false 24 | ``` -------------------------------------------------------------------------------- /content/collections/modifiers/minutes_ago.md: -------------------------------------------------------------------------------- 1 | --- 2 | types: 3 | - date 4 | id: 06027289-825e-4205-bd3a-f375e26ab81e 5 | parse_content: true 6 | date: October 1 2015 8:30:am 7 | --- 8 | Returns the number of minutes since a given date variable. Statamic will attempt to parse any string as a date, but try to keep it in the least ambiguous date format possible. 9 | 10 | ```.language-yaml 11 | date: October 1 2015 8:30:am 12 | ``` 13 | 14 | {{ noparse }} 15 | ``` 16 | {{ date | minutes_ago }} 17 | ``` 18 | {{ /noparse }} 19 | 20 | ```.language-output 21 | {{ test_date | minutes_ago }} 22 | ``` 23 | -------------------------------------------------------------------------------- /content/collections/variables/edit_url.md: -------------------------------------------------------------------------------- 1 | --- 2 | id: 4b4bd7a7-6fc8-4457-b030-56d4474e20b0 3 | types: 4 | - content 5 | --- 6 | Get the URL to edit a the current page or entry in the Control Panel, if there is one (for example, there is no `edit_url` for a template route). 7 | 8 | The user will need to login and have permissions, so it's probably best if used in conjunction with [permissions checks](/tags/user-can). 9 | 10 | ``` 11 | Edit this page 12 | ``` 13 | 14 | ``` .language-output 15 | Edit this page 16 | ``` 17 | -------------------------------------------------------------------------------- /content/collections/fieldtypes/toggle.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Toggle 3 | overview: A tactile on/off switch. It's used to create boolean settings. True and false. Nice, simple, and uncomplicated. 4 | image: /assets/fieldtypes/toggle.gif 5 | id: ac5f8f98-616f-4621-a7ee-dbc8bbc15525 6 | --- 7 | ## Data Structure {#data-structure} 8 | 9 | Flicking the toggle to the right sets to the value to `true`, left to `false`. 10 | 11 | ## Templating {#templating} 12 | 13 | Toggle is used for boolean logic, so you can do something like this: 14 | 15 | ``` 16 | {{ if switchy_thing }} Do that thing {{ /if }} 17 | ``` 18 | -------------------------------------------------------------------------------- /content/collections/modifiers/join.md: -------------------------------------------------------------------------------- 1 | --- 2 | types: 3 | - string 4 | - array 5 | - utility 6 | id: 9dfc5020-3d14-4774-a1f6-d82d051cb964 7 | --- 8 | Turn an array into a string by gluing together all the data with any specified delimiter. It uses a comma by default. 9 | 10 | ```.language-yaml 11 | tasks: 12 | - take a shower 13 | - brush hair 14 | - clip toenails 15 | ``` 16 | 17 | ``` 18 | {{ tasks | join }} 19 | {{ tasks join=" + " }} = ready 20 | ``` 21 | 22 | ```.language-output 23 | take a shower, brush hair, clip toenails 24 | take a shower + brush hair + clip toenails = ready 25 | ``` -------------------------------------------------------------------------------- /content/collections/modifiers/title.md: -------------------------------------------------------------------------------- 1 | --- 2 | types: 3 | - string 4 | id: 2293d024-32ad-4bb6-a7ff-46ec2e1d9f2f 5 | --- 6 | Returns a trimmed string with the first letter of each word capitalized, ignoring articles, coordinating conjunctions, and short propositions: `a`, `an`, `the`, `at`, `by`, `for`, `in`, `of`, `on`, `to`, `up`, `and`, `as`, `but`, `or`, and `nor`. 7 | 8 | ```.language-yaml 9 | string: It was one of the best adventures of my life 10 | ``` 11 | 12 | ``` 13 | {{ string | title }} 14 | ``` 15 | 16 | ```.language-output 17 | It Was One of the Best Adventures of My Life 18 | ``` 19 | -------------------------------------------------------------------------------- /content/collections/modifiers/slugify.md: -------------------------------------------------------------------------------- 1 | --- 2 | types: 3 | - string 4 | - utility 5 | id: 15ab735c-a877-423a-8e7f-c61e3f68744b 6 | --- 7 | Converts the string into an URL slug. This includes replacing non-ASCII characters with their closest ASCII equivalents, removing remaining non-ASCII 8 | and non-alphanumeric characters, and replacing whitespace with dashes. And then everything is lowercased. 9 | 10 | 11 | ```.language-yaml 12 | string: Please, have some lemoñade. 13 | ``` 14 | 15 | ``` 16 | {{ string | slugify }} 17 | ``` 18 | 19 | ```.language-output 20 | please-have-some-lemonade 21 | ``` 22 | -------------------------------------------------------------------------------- /content/collections/modifiers/to_json.md: -------------------------------------------------------------------------------- 1 | --- 2 | types: 3 | - utility 4 | id: c3214196-3d0d-4a3d-b6c3-1ee4960cfe5d 5 | --- 6 | Converts any variable into JSON. 7 | 8 | ```.language-yaml 9 | stats: 10 | - player: Luke Skywalker 11 | score: 750 12 | - player: Wedge Antilles 13 | score: 688 14 | - player: Jar Jar Binks 15 | score: 1425 16 | ``` 17 | 18 | ``` 19 | {{ stats | to_json }} 20 | ``` 21 | 22 | ```.language-output 23 | [ 24 | {"player":"Luke Skywalker","score":750}, 25 | {"player":"Wedge Antilles","score":688}, 26 | {"player":"Jar Jar Binks","score":1425} 27 | ] 28 | ``` 29 | -------------------------------------------------------------------------------- /content/collections/modifiers/entities.md: -------------------------------------------------------------------------------- 1 | --- 2 | types: 3 | - string 4 | - utility 5 | id: 50c06e32-9b94-4129-85ba-7cc4201b9e3f 6 | --- 7 | Encode a string with HTML entities via PHP's [htmlentities()][entities] function. This is the opposite of the [decode][decode] modifier. 8 | 9 | ```.language-yaml 10 | string: "The 'bacon' is crispy"; 11 | ``` 12 | 13 | ``` 14 | {{ string | entities }} 15 | ``` 16 | 17 | ```.language-output 18 | The 'bacon' is <b>crispy</b> 19 | ``` 20 | 21 | [entities]: http://php.net/manual/en/function.htmlentities.php 22 | [decode]: /modifiers/decode 23 | -------------------------------------------------------------------------------- /content/collections/modifiers/format_number.md: -------------------------------------------------------------------------------- 1 | --- 2 | types: 3 | - math 4 | - number 5 | id: 63b56419-6556-4174-8d26-e941460b82a4 6 | --- 7 | Format a number with grouped thousands and decimal points. In other words, make it look nice. 8 | 9 | - Parameter 1: precision (number of decimal places before rounding) 10 | - Parameter 2: Decimal point (default `.`) 11 | - Parameter 3: Thousands separator (default: `,`) 12 | 13 | ```.language-yaml 14 | lucky_number: 130134.109 15 | ``` 16 | 17 | ``` 18 | {{ lucky_number format_number="1|,|," }} 19 | ``` 20 | 21 | ```.language-output 22 | 130,134,1 23 | ``` 24 | -------------------------------------------------------------------------------- /content/collections/modifiers/sum.md: -------------------------------------------------------------------------------- 1 | --- 2 | types: 3 | - array 4 | - math 5 | id: ee2da74a-0788-400f-804f-c85ad9b635c0 6 | --- 7 | Returns the sum of all items in an array, optionally specified by a specific key. 8 | 9 | ```.language-yaml 10 | numbers: 11 | - 5 12 | - 10 13 | - 20 14 | - 40 15 | stats: 16 | - player: Luke Skywalker 17 | score: 750 18 | - player: Wedge Antilles 19 | score: 688 20 | - player: Jar Jar Binks 21 | score: 1425 22 | ``` 23 | 24 | ``` 25 | {{ numbers | sum }} 26 | {{ stats | sum:score }} 27 | ``` 28 | 29 | ```.language-output 30 | 75 31 | 2863 32 | ``` 33 | -------------------------------------------------------------------------------- /content/collections/modifiers/group_by.md: -------------------------------------------------------------------------------- 1 | --- 2 | types: 3 | - array 4 | id: a070fabe-c413-4b31-9cb4-ad14bbe1aa4d 5 | --- 6 | Group an array's items by a given key. 7 | 8 | ```.language-yaml 9 | sponsors: 10 | - 11 | sport: basketball 12 | team: Jazz 13 | - 14 | sport: baseball 15 | team: Yankees 16 | - 17 | sport: basketball 18 | team: Bulls 19 | ``` 20 | 21 | ``` 22 | {{ sponsors group_by="sport" }} 23 | {{ basketball }} 24 |{{ team }}
25 | {{ /basketball 26 | {{ /sponsors }} 27 | ``` 28 | 29 | ```.language-output 30 |Jazz
31 |Bulls
32 | ``` 33 | -------------------------------------------------------------------------------- /content/collections/modifiers/is_empty.md: -------------------------------------------------------------------------------- 1 | --- 2 | types: 3 | - array 4 | id: a94a24ce-500d-4194-85db-85fcbb552e06 5 | --- 6 | Checks to see if an array is empty without any set values. Works with numeric indexes, associative, and string keyed arrays of all depths. It's pretty smart, as these things go. 7 | 8 | ```.language-yaml 9 | some_data: 10 | - is living here 11 | more_data: 12 | with: 13 | hopes: 14 | and: 15 | dreams: 16 | - 17 | ``` 18 | 19 | ``` 20 | {{ if some_data | is_empty }} 21 | {{ if more_data | is_empty }} 22 | 23 | ``` 24 | 25 | ```.language-output 26 | false 27 | true 28 | ``` 29 | -------------------------------------------------------------------------------- /content/collections/modifiers/obfuscate.md: -------------------------------------------------------------------------------- 1 | --- 2 | types: 3 | - markup 4 | - utility 5 | attributes: true 6 | id: 84aca464-65b1-4cc9-8bc9-e64b33797579 7 | --- 8 | Obfuscates a string with special characters making it hard for spam bots to sniff out and scrape off your site. Still appears like the same string to the reader. This is usually used for email addresses. 9 | 10 | ```.language-yaml 11 | magic_word: Abracadabra 12 | ``` 13 | 14 | ``` 15 | {{ magic_word | obfuscate }} 16 | ``` 17 | 18 | ```.language-output 19 | # visibly appears as Abracadabra 20 | Abracadabra 21 | ``` 22 | -------------------------------------------------------------------------------- /content/collections/modifiers/spaceless.md: -------------------------------------------------------------------------------- 1 | --- 2 | types: 3 | - string 4 | - utility 5 | added_in: 2.8.4 6 | id: 3bcdbffa-8020-4364-8c2a-1fe1a9ff0a5c 7 | --- 8 | Removes excess whitespace and line breaks from a string. A definite OCD pleaser. 9 | 10 | ``` 11 | html: | 12 |I copy & pasted 13 | this link 14 | for you!
15 | ``` 16 | 17 | ``` 18 | {{ html | spaceless }} 19 | ``` 20 | 21 | ```.language-output 22 |I copy & pasted this link for you!
23 | ``` 24 | -------------------------------------------------------------------------------- /content/collections/modifiers/dl.md: -------------------------------------------------------------------------------- 1 | --- 2 | types: 3 | - array 4 | - markup 5 | id: fbdb7bf5-ac19-444c-9536-57332ffff388 6 | --- 7 | Turn a key/value array, otherwise known as a YAML mapping, into an HTML definition list. 8 | 9 | ```.language-yaml 10 | food: 11 | Delicious: 12 | - bacon 13 | - sushi 14 | Green: 15 | - broccoli 16 | - kale 17 | ``` 18 | 19 | ``` 20 | {{ food | dl }} 21 | ``` 22 | 23 | ```.language-output 24 |-
25 |
- Delicious 26 |
- bacon 27 |
- sushi 28 | 29 |
- Green 30 |
- broccoli 31 |
- kale 32 |
17 | {{ title }}
18 |
19 | {{ /stories }}
20 |
21 | {{ /pages:previous }}
22 | ```
23 |
--------------------------------------------------------------------------------
/content/collections/modifiers/format.md:
--------------------------------------------------------------------------------
1 | ---
2 | types:
3 | - date
4 | - string
5 | id: 756d23b4-209c-457c-b9f5-d69347bbe8fe
6 | ---
7 | Given a date string, or anything that sort of looks like a date string, `format` will convert it to a [Carbon][carbon] instance and allow you to format it with PHP's [datetime format][datetime] variables.
8 |
9 | ```.language-yaml
10 | event_date: April 15 2016
11 | ```
12 |
13 | ```
14 | {{ event_date format="Y-m-d" }}
15 | ```
16 |
17 | ```.language-output
18 | 2016-04-15
19 | ```
20 |
21 | [carbon]: http://carbon.nesbot.com
22 | [datetime]: http://php.net/manual/en/function.date.php
23 |
--------------------------------------------------------------------------------
/.github/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | # Contributing to Statamic Docs
2 |
3 | :+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
4 |
5 | ## Issues vs Pull Requests
6 |
7 | Please send a **Pull Request** for any and all content changes.
8 |
9 | If you're unclear about the documentation and need some clarification, or if there are visual/layout/style problems, an **Issue** is appropriate.
10 |
11 | ## Grammar and Writing Style
12 |
13 | 1. Respect the Oxford Coma.
14 | 2. See number one.
15 |
16 | 
17 |
--------------------------------------------------------------------------------
/content/collections/kb/yaml-error.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: "YAML Error"
3 | kb_categories:
4 | - Troubleshooting Common Scenarios
5 | id: 7300a8ee-0d0e-491c-bb39-b1ebf26eaf58
6 | ---
7 | If you're getting a `Array to string` error when saving/creating content:
8 | ```
9 | ErrorException: Array to string conversion in /home/site/statamic/core/API/YAML.php:68
10 | ```
11 |
12 | Check to see if you have any `content` fields that aren't just strings, like `Grid`, `Replicator`, `Bard`.
13 |
14 | `content` is a reserved word and Statamic assumes it only has textual data, so you'll have to rename your existing field(s) to something else.
15 |
--------------------------------------------------------------------------------
/content/collections/modifiers/obfuscate_email.md:
--------------------------------------------------------------------------------
1 | ---
2 | types:
3 | - markup
4 | attributes: true
5 | id: 536ac4b3-bfc7-4ced-8c83-d389fb94a262
6 | ---
7 | Obfuscates an email address with special characters making it hard for spam bots to sniff out and scrape off your site. Still reads like an email address as far as readers are concerned.
8 |
9 | ```.language-yaml
10 | holler: holler@example.com
11 | ```
12 |
13 | ```
14 | {{ holler | obfuscate_email }}
15 | ```
16 |
17 | ```.language-output
18 | # output appears as holler@example.com
19 | holler@example.com
20 | ```
21 |
--------------------------------------------------------------------------------
/content/collections/fieldtypes/yaml.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: YAML
3 | overview: >
4 | A code editor set to YAML mode to help you write and store raw data as, you guessed it, YAML. Want to [learn more about YAML?](/yaml) Want us to say YAML again?
5 | image: /assets/fieldtypes/yaml.jpg
6 | options:
7 | -
8 | name: rows
9 | type: integer
10 | description: >
11 | The number of rows of text to display.
12 | Controls the initial height of the
13 | field.
14 | id: 25155800-8fd7-46c7-aad0-5daaf07543da
15 | ---
16 | This field is essentially a [Textarea fieldtype](/fieldtypes/textarea) that gets saved as YAML instead of a string.
17 |
--------------------------------------------------------------------------------
/content/collections/tags/search-form.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Form
3 | description: How to create a search form.
4 | id: 1ab4aca4-1add-4b41-b40c-4f3e8170fd98
5 | ---
6 | There's no special search form tag that you need to use. Simply create a form that performs a GET request to where your results will be listed.
7 |
8 | ```
9 |
13 | ```
14 |
15 | Assuming that the `{{ search:results }}` tag is on `/search-results`, and that you searched for `majestic stags`, submitting this form will take you to `/search-results?q=majestic+stags`.
16 |
--------------------------------------------------------------------------------
/content/collections/classes/api-taxonomy.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Taxonomy
3 | class: Statamic\API\Taxonomy
4 | id: b109a335-e262-4313-9f9a-1507ba31a22c
5 | ---
6 | ## Get all taxonomies.
7 |
8 | ``` php
9 | Taxonomy::all(); // Returns \Illuminate\Support\Collection
10 | ```
11 |
12 | ## Get the handles of all taxonomies.
13 |
14 | ``` php
15 | Taxonomy::handles(); // Returns an array of strings
16 | ```
17 |
18 | ## Get a taxonomy by handle.
19 |
20 | ``` php
21 | Taxonomy::whereHandle($handle); // Returns TaxonomyFolder
22 | ```
23 |
24 | ## Check if a taxonomy exists.
25 |
26 | ``` php
27 | Taxonomy::handleExists($handle); // Returns a boolean
28 | ```
29 |
--------------------------------------------------------------------------------
/content/collections/tags/redirect.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Redirect
3 | overview: Redirect to another page.
4 | parameters:
5 | -
6 | name: url
7 | type: string
8 | description: Destination URL
9 | -
10 | name: to
11 | type: string
12 | description: Alias of `url`
13 | -
14 | name: response
15 | type: 'integer *302*'
16 | description: The HTTP response code to use.
17 | id: 444d1109-ed96-4162-b86d-24b39f569220
18 | ---
19 | ## Example {#example}
20 |
21 | ```
22 | {{ if !open }}
23 | {{ redirect to="/" }}
24 | {{ /if }}
25 | ```
26 |
27 | If the `open` tag is not true, this will forward the visitors to the homepage.
28 |
--------------------------------------------------------------------------------
/content/collections/events/page-moved.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: PageMoved
3 | class: Statamic\Events\Data\PageMoved
4 | id: 48e9334d-be29-4980-b421-cda4b91b25a5
5 | ---
6 | This is a [data event](/addons/events/#data-events) that is dispatched when a page is moved.
7 |
8 | Typically, this happens when reordering through the control panel. This event is dispatched once for every page that was affected
9 | when reordering through the control panel. There is a [PagesMoved event](/addons/events/pages-moved) that will be dispatched
10 | once for the entire operation that contains all affected pages.
11 |
12 | ```
13 | public function handle(PageMoved $event);
14 | ```
15 |
--------------------------------------------------------------------------------
/content/collections/events/response-created.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: response.created
3 | class: response.created
4 | id: 0bd05051-f84c-4422-b26d-98f5c7a92605
5 | ---
6 | Fired just after the response has been created for front-end requests, and just before it gets sent.
7 |
8 | This is a perfect time for you to modify the response by adding headers, adjusting the output, etc.
9 |
10 | An `Illuminate\Http\Response` instance will be passed through. Simply modify it and don't return anything.
11 |
12 | ```
13 | use Illuminate\Http\Response;
14 |
15 | public $events = ['response.created' => 'handle'];
16 |
17 | public function handle(Response $response);
18 | ```
19 |
--------------------------------------------------------------------------------
/content/collections/modifiers/decode.md:
--------------------------------------------------------------------------------
1 | ---
2 | types:
3 | - utility
4 | id: 1fd780fd-ae92-4e73-9513-2b9c845976e9
5 | ---
6 | Convert all HTML entities to their applicable characters via PHP's [html_entity_decode()][decode] function. Will convert both double and single quotes. This is the opposite of the [entities][entities] modifier.
7 |
8 | ```.language-yaml
9 | string: "I'll \"eat\" the bacon now";
10 | ```
11 |
12 | ```
13 | {{ string | decode }}
14 | ```
15 |
16 | ```.language-output
17 | I'll "eat" the bacon now
18 | ```
19 |
20 | [decode]: http://php.net/manual/en/function.html-entity-decode.php
21 | [entities]: /modifiers/entities
22 |
--------------------------------------------------------------------------------
/content/collections/modifiers/where.md:
--------------------------------------------------------------------------------
1 | ---
2 | types:
3 | - condition
4 | - array
5 | id: c36a6f62-aaf4-478b-a469-29cdb1eab8dc
6 | ---
7 | Filter an array (such as a Replicator field's data) to items where a `key` has a specific `value`.
8 |
9 | ```.language-yaml
10 | games:
11 | -
12 | feeling: love
13 | title: Dominion
14 | -
15 | feeling: love
16 | title: Netrunner
17 | -
18 | feeling: hate
19 | title: Chutes and Ladders
20 | ```
21 |
22 | ```
23 | I love...
24 | {{ games where="feeling:love" }} 25 | {{ title }}26 | {{ /games }} 27 | ``` 28 | 29 | ```.language-output 30 | Dominion 31 | Netrunner 32 | ``` 33 | -------------------------------------------------------------------------------- /content/collections/modifiers/get.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Get 3 | types: 4 | - asset 5 | - utility 6 | - relationship 7 | id: c6311d04-364d-4086-8b6b-2a58e88c6cb8 8 | --- 9 | Gets a value from a relationship based on its ID. This is like a nicer-to-read single tag version of the 10 | [Relate Tag](/tags/relate). 11 | 12 | ``` .language-yaml 13 | featured_post: 4e82a520-275f-11e6-bdf4-0800200c9a66 14 | ``` 15 | 16 | ``` 17 | {{ featured_post | get:title }} 18 | ``` 19 | 20 | ``` .language-output 21 | Featured Post Title 22 | ``` 23 | 24 | The above is equivalent to doing this: 25 | 26 | ``` 27 | {{ relate:featured_post }}{{ title }}{{ /relate:featured_post }} 28 | ``` 29 | -------------------------------------------------------------------------------- /content/collections/modifiers/yes_no.md: -------------------------------------------------------------------------------- 1 | --- 2 | types: 3 | - string 4 | - utility 5 | - conditions 6 | id: 3773fc46-e5f2-4a87-8f68-4ac906bca50d 7 | --- 8 | A ternary-esque syntax for outputting `yes` if true, `no` if false. Both values can be customized by passing additional parameters. Also supports `?` as shorthand. 9 | 10 | ```.language-yaml 11 | foo: true 12 | bar: false 13 | ``` 14 | 15 | ``` 16 | {{ foo | yes_no }} 17 | {{ bar | yes_no }} 18 | {{ foo | yes_no:yep:nah }} 19 | {{ bar | yes_no:yep:nah }} 20 | {{ foo | ?:yep:nah }} 21 | {{ bar | ?:yep:nah }} 22 | ``` 23 | 24 | ```.language-output 25 | yes 26 | no 27 | yep 28 | nah 29 | yep 30 | nah 31 | ``` 32 | -------------------------------------------------------------------------------- /content/collections/tags/collection-previous.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Previous 3 | overview: Grab the previous entries relative to current entry in a Collection. 4 | id: 741cf972-c0bd-4e3c-81e2-8cc8bea60737 5 | --- 6 | This Tag functions the same way as the [`collection:next`](/tags/collection-next) tag, but in the opposite direction. 7 | 8 | ``` 9 | {{ collection:previous in="blog" as="posts" limit="2" sort="date:asc" }} 10 | 11 | {{ if no_results }} 12 | No more posts to read! 13 | {{ /if }} 14 | 15 | {{ posts }} 16 |
17 | {{ title }}
18 |
19 | {{ /posts }}
20 |
21 | {{ /collection:previous }}
22 | ```
23 |
--------------------------------------------------------------------------------
/content/collections/events/cp-published.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: cp.published
3 | class: cp.published
4 | id: 2a170192-f4b2-4f63-8ccd-45fd2c423002
5 | ---
6 | Fired when any Page, Entry, Taxonomy Term, Global, or User is saved **through the Control Panel**. The respective class will be passed through.
7 |
8 | ```
9 | public $events = ['cp.published' => 'handle'];
10 |
11 | public function handle(Data $data);
12 | ```
13 |
14 | If you require listening for more a more specific version, an event for the respective type will also be dispatched:
15 |
16 | - `cp.page.published`
17 | - `cp.entry.published`
18 | - `cp.term.published`
19 | - `cp.globals.published`
20 | - `cp.user.published`
21 |
--------------------------------------------------------------------------------
/content/collections/events/finding-fieldset.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: FindingFieldset
3 | class: Statamic\Events\Data\FindingFieldset
4 | id: 386f3e48-85f9-45d3-b8a0-ac586b5879ab
5 | ---
6 | This is dispatched when Statamic attemps to find a fieldset for a specific content object.
7 |
8 | ```
9 | public function handle(FindingFieldset $event)
10 | {
11 | $event->data; // The content object. The Page, Entry, etc
12 | $event->fieldset; // The fieldset.
13 | }
14 | ```
15 |
16 | You may modify the fieldset here and it will be reflected in whatever was requesting it.
17 |
18 | An example of when this would be useful is to add a section to a fieldset in the publish page on the fly.
19 |
--------------------------------------------------------------------------------
/content/pages/3.modifiers/index.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Modifiers
3 | mount: modifiers
4 | id: 199357e4-3eea-4939-9757-0e3f6f88083b
5 | template: modifiers
6 | overview: Modifiers give you the ability to manipulate the data of your variables on the fly. They can manipulate strings, filter arrays and lists, help you compare things, do basic math, simplify your markup, and even help you debug.
7 | video: https://www.youtube.com/watch?v=V27N3Jh4APs
8 | ---
9 | We've organized the modifiers by type of data they're designed to manipulate or the type of function they perform. Some modifiers (like `shuffle` and `count`) work on multiple data types and will be repeated in more than one section.
10 |
--------------------------------------------------------------------------------
/content/collections/modifiers/flatten.md:
--------------------------------------------------------------------------------
1 | ---
2 | types:
3 | - array
4 | - utility
5 | id: e893345c-03f7-466b-a400-bbd2545bd780
6 | ---
7 | Flattens a multi-dimensional array (a Grid or Replicator field for example) into a single dimension.
8 |
9 | ```.language-yaml
10 | ingredients:
11 | spices: [garlic, cumin, ginger, turmeric, paprika, curry powder]
12 | vegetables: [tomatoes, onion]
13 | meat: [chicken]
14 | ```
15 |
16 | ```
17 | {{ ingredients | flatten }}
18 | ```
19 |
20 | ```.language-yaml
21 | ingredients:
22 | - garlic
23 | - cumin
24 | - ginger
25 | - turmeric
26 | - paprika
27 | - curry powder
28 | - tomatoes
29 | - onion
30 | - chicken
31 | ```
--------------------------------------------------------------------------------
/content/collections/variables/focus.md:
--------------------------------------------------------------------------------
1 | ---
2 | types:
3 | - asset
4 | id: d61d8f8c-4e7e-4933-8f34-0cdba2a3ee82
5 | ---
6 | The focal point of the asset, defaulting to center (`50-50`).
7 |
8 | ```
9 | {{ focus }}
10 | ```
11 |
12 | ``` .language-output
13 | 50-30
14 | ```
15 |
16 | You may want to use this in CSS with either the [background_position](/modifiers/background_position) modifier, or just by using the [focus_css](/variables/focus_css) variable.
17 |
18 | ```
19 | background-position: {{ focus | background_position }};
20 | background-position: {{ focus_css }};
21 | ```
22 |
23 | ``` .language-output
24 | background-position: 50% 30%;
25 | background-position: 50% 30%;
26 | ```
27 |
--------------------------------------------------------------------------------
/content/collections/modifiers/is_embeddable.md:
--------------------------------------------------------------------------------
1 | ---
2 | types:
3 | - string
4 | id: d3ab4cb6-2aeb-4a15-93b9-79e56ad82223
5 | ---
6 | Checks to see if a video URL is embeddable. ie. If it is a YouTube or Vimeo URL.
7 |
8 | Plays nicely with the [Video fieldtype](/fieldtypes/video) and the [embed_url modifier](/modifiers/embed_url).
9 |
10 | ``` .language-yaml
11 | youtube: https://www.youtube.com/watch?v=s9F5fhJQo34
12 | vimeo: https://vimeo.com/22439234
13 | other: http://example.com/video.mp4
14 | ```
15 |
16 | ```
17 | {{ youtube | is_embeddable }}
18 | {{ vimeo | is_embeddable }}
19 | {{ other | is_embeddable }}
20 | ```
21 |
22 | ``` .language-output
23 | true
24 | true
25 | false
26 | ```
27 |
--------------------------------------------------------------------------------
/content/collections/tags/section.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Section
3 | overview: 'Extract a section of template that can be retrieved in a [Yield Tag](/tags/yield).'
4 | id: 21481d1a-ee1b-4acd-b5ad-65dc7fcec976
5 | ---
6 |
7 | ## Example {#example}
8 |
9 | Here's an example template:
10 |
11 | ```
12 | {{ title }}
13 |
14 | {{ content }}
15 |
16 |
17 | {{ section:sidebar }}
18 | Some sidebar stuff!
19 | {{ /section:sidebar }}
20 | ```
21 |
22 | Everything within the `section:sidebar` tag pair will _not_ be rendered in this template. It will be rendered
23 | in your layout (or partials within a layout) in the `{{ yield:sidebar }}` tag.
24 |
25 | [yield_tag]: /tags/yield
26 |
--------------------------------------------------------------------------------
/content/collections/modifiers/count_substring.md:
--------------------------------------------------------------------------------
1 | ---
2 | types:
3 | - string
4 | id: 84c6f375-10ca-4296-89a8-a22b9652b5d5
5 | ---
6 | Returns the number of occurrences of search term in a given string. By default,
7 | the comparison is case-insensitive, but can be made sensitive by setting the second parameter to `true`.
8 |
9 | ```.language-yaml
10 | quote: |
11 | Dude! You got a tattoo!
12 | So do you, dude! Dude, what does my tattoo say?
13 | Sweet! What about mine?
14 | Dude! What does mine say?
15 | Sweet! What about mine?
16 | Dude! What does mine say?
17 | ```
18 |
19 | ```
20 | {{ quote count_substring="dude" }}
21 | ```
22 |
23 | ```.language-output
24 | 5
25 | ```
26 |
27 |
28 |
--------------------------------------------------------------------------------
/content/collections/tags/env.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Env
3 | overview: Output environment variable values.
4 | parameters:
5 | -
6 | name: default|fallback
7 | type: string
8 | description: "In the event that the requested variable doesn't exist, this will be used a fallback."
9 | id: 967d4bad-34a0-4a6a-8af1-6e88c6b900ed
10 | ---
11 | ## Example
12 |
13 | This tag is a nice simple way to output values from your environment variables.
14 |
15 | In your environment file (`.env`):
16 |
17 | ```
18 | FOO=bar
19 | ```
20 |
21 | ```
22 | 1. {{ env:FOO }}
23 | 2. {{ env:HELLO }}
24 | 3. {{ env:HELLO default="world" }}
25 | ```
26 |
27 | ``` .language-output
28 | 1. bar
29 | 2.
30 | 3. world
31 | ```
32 |
--------------------------------------------------------------------------------
/content/collections/fieldtypes/fieldset.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Fieldset
3 | id: 7db4b1f2-5840-46b0-b9db-fdfcafd91269
4 | overview: |
5 | A select field pre-filled with your site's fieldsets. Pretty simple!
6 | image: /assets/fieldtypes/fieldset.png
7 | options:
8 | -
9 | name: hidden
10 | type: boolean *false*
11 | description: Show hidden fieldsets.
12 | ---
13 | It'll let you create them on the fly, too. Click the + button and type away. A barebones fieldset will be created
14 | that you can use immediately. Then simply go and edit the fieldset later.
15 |
16 | If you've created a fieldset in another tab while you've had this page open, you can click the refresh button to see
17 | any additions.
18 |
--------------------------------------------------------------------------------
/content/collections/modifiers/merge.md:
--------------------------------------------------------------------------------
1 | ---
2 | types:
3 | - array
4 | id: d15bda69-36ee-4871-82b2-e66447868643
5 | ---
6 |
7 | Merge an array variable with another array variable.
8 |
9 | ```.language-yaml
10 | fruit:
11 | - apples
12 | - bananas
13 | - bacon
14 | meat:
15 | - pork
16 | - beef
17 | - chicken
18 | ```
19 |
20 | ```
21 | {{ fruit }}
22 | ```
23 |
24 | ```.language-output
25 | apples bannanas bacon
26 | ```
27 |
28 | ```
29 | {{ meat }}
30 | ```
31 |
32 | ```.language-output
33 | pork beef chicken
34 | ```
35 |
36 | ```
37 | {{ fruit merge="meat" }}
38 | {{ value }}
39 | {{ /fruit }}
40 | ```
41 |
42 | ```.langauge-output
43 | apples bananas bacon pork beef chicken
44 | ```
--------------------------------------------------------------------------------
/content/collections/modifiers/widont.md:
--------------------------------------------------------------------------------
1 | ---
2 | types:
3 | - string
4 | - utility
5 | id: cbb290f3-ffd0-4dc1-8989-1d10a92ff17d
6 | ---
7 | Attempts to prevent widows (a line with a single word) in a string by adding non-breaking spaces between the last two words of each paragraph.
8 |
9 | The first parameter allows you to customize the number of words to add non-breaking spaces to.
10 |
11 | ```.language-yaml
12 | string: I Just Want Pretty Headlines and Sentences
13 | ```
14 |
15 | ```
16 | {{ string | widont }}
17 | {{ string | widont:4 }}
18 | ```
19 |
20 | ```.language-output
21 | I Just Want Pretty Headlines and Sentences
22 | I Just Want Pretty Headlines and Sentences
23 | ```
24 |
--------------------------------------------------------------------------------
/content/collections/modifiers/wrap.md:
--------------------------------------------------------------------------------
1 | ---
2 | types:
3 | - markup
4 | - string
5 | id: ee9e1c05-8b5d-47f9-b476-3d108a9c14af
6 | ---
7 | Wraps a string with a given HTML tag. Has the nice benefit of returning null if there is no data, eliminating the need for simple `{{ if }}` wrappers.
8 |
9 | ```.language-yaml
10 | title: As the World Turns
11 | ```
12 |
13 | ```
14 | {{ title | wrap:h1 }}
15 | ```
16 |
17 | ```.language-output
18 | As the World Turns
19 | ``` 20 | 21 | You may also use Emmet-style CSS classes to be added to the tag. 22 | 23 | ``` 24 | {{ title | wrap:h1.fast.furious }} 25 | ``` 26 | 27 | ``` .language-output 28 |As the World Turns
29 | ``` 30 | -------------------------------------------------------------------------------- /content/collections/modifiers/full_urls.md: -------------------------------------------------------------------------------- 1 | --- 2 | types: 3 | - string 4 | - utility 5 | id: 44cb7965-877e-49b3-92fe-a24970b542a2 6 | --- 7 | Replaces root-relative URLs with absolute URLs. This is generally used in RSS feeds and other places where markup may be used off the main site. 8 | 9 | ```.language-markdown 10 | --- 11 | I had this totally [crazy dream](/dream-journal/spiders-with-ramen-legs) 12 | last night and I know you want to hear all about it! 13 | ``` 14 | 15 | ``` 16 | {{ content | full_urls }} 17 | ``` 18 | 19 | ```.language-output 20 | I had this totally [crazy dream](http://example.com/dream-journal/spiders-with-ramen-legs) 21 | last night and I know you want to hear all about it! 22 | ``` 23 | -------------------------------------------------------------------------------- /content/collections/tags/markdown-indent.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Indent 3 | id: d26ec250-460e-11e7-9598-0800200c9a66 4 | overview: Convert content between the tags into markdown, ignoring indentation. 5 | --- 6 | Similar to the [`{{ markdown }}`](/tags/markdown) tag, `{{ markdown:indent }}` is a tag-pair version of the [markdown modifier](/modifiers/markdown). However, it additionally ignores indentation so everything isn't simply rendered in a `` block.
7 |
8 | ## Example {#example}
9 |
10 | ```
11 | {{ markdown:indent }}
12 | ## Ode To Bacon
13 |
14 | Bacon. Mmm, bacon.
15 | {{ /markdown:indent }}
16 | ```
17 |
18 | ``` .language-output
19 | Ode To Bacon
20 | Bacon. Mmm, bacon.
21 | ```
22 |
--------------------------------------------------------------------------------
/content/collections/events/stache-updated.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: StacheUpdated
3 | class: Statamic\Events\StacheUpdated
4 | id: cfe23989-068f-46e6-9616-7a8b20697a80
5 | ---
6 | Fired when the Stache is updated (ie. when content, assets, or users are created/modified) this will be fired.
7 |
8 | ```
9 | public $events = [StacheUpdated::class => 'handle'];
10 |
11 | public function handle(StacheUpdated $event)
12 | {
13 | $event->stache; // Statamic\Contracts\Stache\Cache
14 | $event->updates; // \Illuminate\Support\Collection of repos that were updated
15 | $event->updated($repo); // Check if a given repo was updated
16 | $event->updatedAny($repos); // Check if any given repos were updated
17 | }
18 | ```
19 |
--------------------------------------------------------------------------------
/content/collections/tags/session-forget.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Session:Forget
3 | overview: The session:forget tag is used to remove data from the user session.
4 | id: be024503-9796-4f2f-9c75-548e2ea09cec
5 | ---
6 | ## Usage
7 |
8 | Data set in the session will be available in all requests until such time that the session is cleared, either over time (sessions eventually expire) or intentionally.
9 |
10 | Remove variables from the session by passing a collection of keys into the tag.
11 | ```
12 | {{ session:forget keys="likes|referral" }}
13 | ```
14 |
15 | Or you can wipe the entire session with the flush tag. Keep in mind this will also sign a user out if they're signed in.
16 |
17 | ```
18 | {{ session:flush }}
19 | ```
20 |
--------------------------------------------------------------------------------
/content/collections/tags/session-flash.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Session:Flash
3 | overview: The session:flash tag is used to store data for a single request.
4 | id: 29957a36-a15a-4fd0-9342-b829b6235fea
5 | ---
6 | ## Usage
7 |
8 | Flash data is only kept for a single request. It is generally used for success/failure messages that remove themselves automatically.
9 |
10 | Setting and retrieving flash data works in exactly the same fashion as regular session data.
11 | ```
12 | {{ session:flash success="true" message="You did it!" }}
13 | ```
14 |
15 | The next (and only next) request will then have those variables available for you.
16 |
17 | ```
18 | {{ session:success }} ~> true
19 | {{ session:message }} ~> You did it!
20 | ```
21 |
--------------------------------------------------------------------------------
/content/collections/modifiers/partial.md:
--------------------------------------------------------------------------------
1 | ---
2 | types:
3 | - utility
4 | - string
5 | - array
6 | id: 23d51738-5043-49e3-8ca3-d5848427216f
7 | ---
8 | Inject a variable's data into a partial and render it without any page scopes whatsoever. This is really just syntactical sugar, but it _is_ delicious.
9 |
10 | ```.language-yaml
11 | data:
12 | title: Bubble Guppies
13 | content: Science died a little bit today.
14 | ```
15 |
16 | ```
17 |
18 | {{ title }}
19 | {{ content | markdown }}
20 |
21 |
22 | {{ data | partial:demo }}
23 | ```
24 |
25 | ```.language-output
26 | Bubble Guppies
27 | Science died a little bit today.
28 | ```
29 |
--------------------------------------------------------------------------------
/content/collections/kb/forge.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Deploying Statamic sites with Laravel Forge
3 | id: 351f546c-fcf1-4443-8947-8ac3d297d4cb
4 | kb_categories:
5 | - Tips, Tricks, and How-Tos
6 | ---
7 | [Laravel Forge](https://forge.laravel.com) is an awesome tool/service that can spin up cloud servers and manage all your deployments with Git. We highly recommend it. Watch how easy it is:
8 |
9 |
10 | Deployments with Forge from Statamic on Vimeo.
11 |
--------------------------------------------------------------------------------
/content/collections/tags/user-logout.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Logout
3 | overview: Log a user out immediately and redirect them elsewhere.
4 | parameters:
5 | -
6 | name: redirect
7 | type: string
8 | description: >
9 | Where the user should be redirected
10 | after logging out. Defaults to the home
11 | page.
12 | id: 3604bfe9-89be-42af-8163-4b378279026a
13 | ---
14 |
15 | ## Example {#example}
16 |
17 | ```
18 | {{ if should_logout_for_whatever_reason }}
19 | {{ user:logout redirect="/somewhere" }}
20 | {{ /if }}
21 | ```
22 |
23 | This will immediately log a user out and redirect to `/somewhere` if the condition is met.
24 |
25 | If you'd like to just output a link, use the [`user:logout_url`](/tags/user-logout_url) tag.
26 |
--------------------------------------------------------------------------------
/content/collections/modifiers/embed_url.md:
--------------------------------------------------------------------------------
1 | ---
2 | types:
3 | - string
4 | id: 45310885-fbd3-438d-85d5-076dda1646e0
5 | ---
6 | Converts a Youtube or Vimeo link to their embed URLs.
7 |
8 | Plays nicely with the [Video fieldtype](/fieldtypes/video) and the [is_embeddable modifier](/modifiers/is_embeddable).
9 |
10 | ``` .language-yaml
11 | youtube: https://www.youtube.com/watch?v=s9F5fhJQo34
12 | vimeo: https://vimeo.com/22439234
13 | other: http://example.com/video.mp4
14 | ```
15 |
16 | ```
17 | {{ youtube | embed_url }}
18 | {{ vimeo | embed_url }}
19 | {{ other | embed_url }}
20 | ```
21 |
22 | ``` .language-output
23 | https://www.youtube.com/embed/s9F5fhJQo34
24 | https://player.vimeo.com/video/22439234
25 | http://example.com/video.mp4
26 | ```
27 |
--------------------------------------------------------------------------------
/content/collections/modifiers/flip.md:
--------------------------------------------------------------------------------
1 | ---
2 | types:
3 | - array
4 | id: f874e969-d579-4501-9140-e4005945d302
5 | ---
6 | Swaps the keys with their corresponding values. The old switcharoo.
7 |
8 | ```.language-yaml
9 | favorites:
10 | chicken: nuggets
11 | nuggets: Denver
12 | ```
13 |
14 | ```
15 | {{ favorites }}
16 | My favorite {{ key }} is {{ value }}.
17 | {{ /favoites }}
18 |
19 | {{ favorites | flip }}
20 | My favorite {{ key }} is {{ value }}.
21 | {{ /favoites }}
22 | ```
23 |
24 | ```.language-output
25 | My favorite chicken is nuggets.
26 | My favorite nuggets is Denver
27 |
28 | My favorite nuggets is chicken
29 | My favorite Denver is nuggets.
30 | ```
31 |
32 | It's a weird example with bad grammer. Hopefully you're okay with it.
--------------------------------------------------------------------------------
/content/collections/modifiers/format_localized.md:
--------------------------------------------------------------------------------
1 | ---
2 | types:
3 | - date
4 | - string
5 | id: 1d181ecf-69ad-4dbe-ae78-bb3b21547a8d
6 | ---
7 | Given a date string, or anything that sort of looks like a date string, `format` will convert it to a [Carbon][carbon] instance and allow you to format it with PHP's [strftime format][strftime] variables. It will use the current locale defined in your system settings.
8 |
9 | ```.language-yaml
10 | event_date: April 15 2016
11 | ```
12 |
13 | ```
14 | {{ event_date format_localized="%A %d %B %Y" }}
15 | ```
16 |
17 | Assuming your locale is `fr_FR`:
18 |
19 | ```.language-output
20 | Vendredi 15 avril 2016
21 | ```
22 |
23 |
24 | [carbon]: http://carbon.nesbot.com
25 | [strftime]: http://php.net/strftime
26 |
--------------------------------------------------------------------------------
/content/collections/tags/widont.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Widont
3 | parse_content: false
4 | overview: >
5 | Attempts to prevent widows (a line with a single word) in a string by adding non-breaking spaces
6 | between the last two words of each paragraph.
7 | description: Prevent widows in your content.
8 | id: c56974d4-70cf-45da-82d9-e25c1f4078a8
9 | parameters:
10 | -
11 | name: words
12 | type: 'integer *2*'
13 | description: >
14 | The number of words to add non-breaking spaces to at the end of the string.
15 | ---
16 | ## Usage {#usage}
17 |
18 | ```
19 | {{ widont }}
20 | I Just Want Pretty Headlines and Sentences
21 | {{ /widont }}
22 | ```
23 |
24 | ```.language-output
25 | I Just Want Pretty Headlines and Sentences
26 | ```
27 |
--------------------------------------------------------------------------------
/content/collections/modifiers/limit.md:
--------------------------------------------------------------------------------
1 | ---
2 | types:
3 | - array
4 | - utility
5 | id: a3c9e1c5-10ec-44da-b8d8-fdc603fce5a3
6 | ---
7 | Limits the number of items returned in an array.
8 |
9 | ```.language-yaml
10 | playlist:
11 | - Emancipator
12 | - Gong Gong
13 | - Possom Posse
14 | - Justin Bieber
15 | ```
16 |
17 | Use with the pipe syntax to continue chaining in a single tag like so:
18 |
19 | ```
20 | {{ playlist | limit:2 | join }}
21 | ```
22 |
23 | ```.language-output
24 | Emancipator, Gong Gong
25 | ```
26 |
27 | Or using the parameter syntax:
28 |
29 | ```
30 | {{ playlist limit="2" }}
31 | {{ value }}
32 | {{ /playlist }}
33 | ```
34 |
35 | ```.language-output
36 | Emancipator
37 | Gong Gong
38 | ```
39 |
--------------------------------------------------------------------------------
/content/collections/modifiers/safe_truncate.md:
--------------------------------------------------------------------------------
1 | ---
2 | types:
3 | - string
4 | id: 1267d7b0-8a07-4103-9570-86327fb8e250
5 | ---
6 | Truncates the string to a given length (parameter 1), while ensuring that
7 | it does not split words. You can append a string with parameter 2, and if truncating occurs the string is further truncated so that it may be appended without exceeding the desired length.
8 |
9 | ```.language-yaml
10 | advice: >
11 | So, here’s some advice I wish I woulda got when I was your age:
12 | Live every week like it’s Shark Week.
13 | ```
14 |
15 | ```
16 | {{ advice | safe_truncate:90:... }}
17 | ```
18 |
19 | ```.language-output
20 | So, here’s some advice I wish I woulda got when I was your age:
21 | Live every week like...
22 | ```
23 |
--------------------------------------------------------------------------------
/content/collections/kb/clear-cache.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: How do I clear the cache?
3 | kb_categories:
4 | - Tips, Tricks, and How-Tos
5 | id: fa5809bf-79e4-48cc-906f-625214391eaa
6 | ---
7 | If you have command line access, the easiest way to clear the cache is to use `please` command.
8 |
9 | ``` .language-bash
10 | php please clear:cache
11 | ```
12 |
13 | If that's not working for some reason, and you are using the File cache driver (if you don't know what that means, then
14 | you are), you can manually delete the contents of `local/storage/framework/cache`. This is where Laravel stores any cached
15 | items. Clear this folder out, and the cache is gone.
16 |
17 | You can also clear the cache from the Control Panel by going to any settings area and hitting save.
18 |
--------------------------------------------------------------------------------
/content/collections/variables/post.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: dc9c535d-59ac-475d-af4f-a0204a71f31b
3 | types:
4 | - global
5 | ---
6 | An array of sanitized `POST` variables that come from any form data present for a POST to the current URL. It can be used as a tag pair with access to all your data or as a single tag to access variables directly. A counterpart to `{{ get }}`.
7 |
8 | ```
9 |
13 | ```
14 |
15 | ```
16 | {{ post }}
17 | {{ first_name }} {{ last_name }}
18 | {{ /post }}
19 |
20 | Mr. {{ post:last_name }}
21 | ```
22 |
23 | ``` .language-output
24 | Niles Peppertrout
25 |
26 | Mr. Peppertrout
27 | ```
28 |
--------------------------------------------------------------------------------
/content/collections/kb/mixed-content.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: "Mixed Content Error"
3 | kb_categories:
4 | - Troubleshooting Common Scenarios
5 | id: 61f2d69c-9aee-4b02-a7be-3b9cae1a5a2d
6 | ---
7 | If you're getting a `Mixed Content` error:
8 | ```
9 | Mixed Content: The page at 'https://yoursite.com/cp/collections/entries/stores' was loaded over HTTPS, but requested an insecure XMLHttpRequest endpoint 'http://yoursite/cp/collections/entries/stores/get?sort=title&order=asc&page=1'. This request has been blocked; the content must be served over HTTPS.
10 | ```
11 |
12 | when accessing your control panel, add `use_https: true` to your `system.yaml`. Also ensure your site url has `https` in it.
13 |
14 | If your assets have absolute URLs, `HTTPS=on` should be added to `.env`.
15 |
--------------------------------------------------------------------------------
/content/collections/classes/api-globalset.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: GlobalSet
3 | class: Statamic\API\GlobalSet
4 | id: a53ff28d-8421-4bde-bfdf-7288942cc6d3
5 | ---
6 | We'd call this class `Global` if PHP was cool with it. But it isn't.
7 |
8 | ## Get all global sets.
9 |
10 | ``` php
11 | GlobalSet::all(); // Returns GlobalCollection
12 | ```
13 |
14 | ## Get a global by ID.
15 |
16 | ``` php
17 | GlobalSet::find($id); // Returns GlobalSet
18 | ```
19 |
20 | ## Get a global by handle.
21 |
22 | ``` php
23 | GlobalSet::whereHandle($handle); // Returns GlobalSet
24 | ```
25 |
26 | ## Create a global.
27 |
28 | This returns an instance of a `GlobalFactory` to allow you to chain and build your global.
29 |
30 | ```
31 | GlobalSet::create($handle); // Returns GlobalFactory
32 | ```
33 |
--------------------------------------------------------------------------------
/content/collections/kb/wrong-domain.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: My license belongs to another domain
3 | kb_categories:
4 | - Troubleshooting Common Scenarios
5 | id: 33984e54-475e-4a19-86af-05a0abe00192
6 | ---
7 | You've logged into the control panel and you're being told that your license belongs to another domain.
8 |
9 | You changed it. Great! But the message is still there.
10 |
11 | Just [clear your cache](/knowledge-base/clear-cache).
12 |
13 | Statamic only "calls home" once an hour and caches the response to prevent your site slowing down more than it needs to.
14 | When you update the domain in your Statamic license area, your Statamic site doesn't know anything changed. Clearing
15 | your cache will force your site to "call home" again, where it will notice your domain change.
16 |
--------------------------------------------------------------------------------
/content/collections/tags/404.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Not Found (404)
3 | overview: Trigger a 404 response.
4 | id: 89f254ef-0312-429c-80bf-0a30a19edd0c
5 | canonical_url: https://statamic.dev/tags/404
6 | ---
7 | This tag will trigger a 404 status code and show your 404 template, without changing the URL.
8 |
9 | For performing a redirect, use the [Redirect Tag][redirect_tag].
10 |
11 | ## Example {#example}
12 |
13 | In this example, we will trigger a 404 if there are no results in a collection.
14 |
15 | ```
16 | {{ collection:blog as="posts" }}
17 | {{ if no_results }}
18 | {{ 404 }}
19 | {{ /if }}
20 |
21 | {{ posts }}
22 | {{ title }}
23 | {{ /posts }}
24 | {{ /collection:blog }}
25 | ```
26 |
27 | [redirect_tag]: /tags/redirect
28 |
--------------------------------------------------------------------------------
/content/collections/classes/userfactory.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: UserFactory
3 | class: Statamic\Data\Users\UserFactory
4 | id: f45eafd5-9d59-4df6-ba88-fd49d0267fcc
5 | ---
6 | ## Usage
7 |
8 | Create a `UserFactory` using the API class.
9 |
10 | ```
11 | $factory = Statamic\API\User::create();
12 | ```
13 |
14 | ## Available Methods
15 |
16 | ### with
17 |
18 | Add an array of data to the object. "Create an object _with_ this data."
19 |
20 | ```
21 | $factory->with(['foo' => 'bar', 'baz' => 'qux']);
22 | ```
23 |
24 | ### username
25 |
26 | Specify the username.
27 |
28 | ```
29 | $factory->username('ron');
30 | ```
31 |
32 | ### email
33 |
34 | Specify the email address. This is an alias for passing the email in `with` data.
35 |
36 | ```
37 | $factory->email('ron@swanson.com');
38 | ```
39 |
--------------------------------------------------------------------------------
/content/collections/kb/duplicate-content.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: "There's duplicate content on my site"
3 | kb_categories:
4 | - Troubleshooting Common Scenarios
5 | id: 4d1c5fe8-1b58-4384-931f-aaee97677c05
6 | ---
7 | Are you seeing two of the same entries? (or pages, assets, etc) If so, there may have been two files with the same
8 | ID in the front matter.
9 |
10 | This is fairly common to see when people copy/paste files and forget to remove the IDs.
11 |
12 | The solution is usually to just remove the duplicate ID and [clear your cache][clear_cache].
13 |
14 | If it wasn't a duplicate ID causing the problem, it may just have been a glitch in the matrix. Let us know what went
15 | wrong and what you were doing, and we'll get that fixed up.
16 |
17 | [clear_cache]: /knowledge-base/clear-cache
18 |
--------------------------------------------------------------------------------
/content/collections/tags/obfuscate.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Obfuscate
3 | id: 161f6255-465d-41bd-8028-d6aba01cebbf
4 | parse_content: false
5 | overview: |
6 | Obfuscation is a method of encoding content so that the source code is hard or impossible to understand. This is generally used on email addresses to prevent spambots from recognizing it as an email address and keeping you safe from unwanted emails.
7 | description: Obfuscate content (usually email addresses) to prevent screenscraping.
8 | ---
9 | ## Usage {#usage}
10 |
11 | ```
12 | {{ obfuscate }}
13 | heisenberg@example.com
14 | {{ /obfuscate }}
15 | ```
16 |
17 | ```.language-output
18 | # output appears as heisenberg@example.com
19 | heisenberg@example.com
20 | ```
21 |
--------------------------------------------------------------------------------
/content/collections/tags/user-not_in.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Not In (Group)
3 | overview: Check if a user is not in a specific user group.
4 | parameters:
5 | -
6 | name: group|groups
7 | type: string
8 | description: 'The groups(s) to check against. You may specify multiple groups by pipe separating them. eg. `{{ user:not_in group="foo" }}` or `{{ user:not_in groups="foo|bar" }}`'
9 | id: 4758a5ba-4b74-4031-8af7-6d165b1624d4
10 | ---
11 | ## Example {#example}
12 |
13 | We want to show a picture of delicious bacon if the user is not in the `vegans` group.
14 |
15 | ```
16 | {{ user:not_in group="vegans" }}
17 | 
18 | {{ /user:not_in }}
19 | ```
20 |
21 | If the user is in the `vegans` group, the content between the tags simply won't be rendered.
22 |
--------------------------------------------------------------------------------
/content/collections/modifiers/offset.md:
--------------------------------------------------------------------------------
1 | ---
2 | types:
3 | - array
4 | - utility
5 | id: 9433b8cd-b2e0-4fbf-85bd-85edf317efa4
6 | ---
7 | Offsets the items returned in an array.
8 |
9 | ```.language-yaml
10 | playlist:
11 | - Emancipator
12 | - Gong Gong
13 | - Possom Posse
14 | - Justin Bieber
15 | ```
16 |
17 | Use with the pipe syntax to continue chaining in a single tag like so:
18 |
19 | ```
20 | {{ playlist | offset:1 | join }}
21 | ```
22 |
23 | ```.language-output
24 | Gong Gong, Possom Posse, Justin Bieber
25 | ```
26 |
27 | Or using the parameter syntax:
28 |
29 | ```
30 | {{ playlist offset="1" }}
31 | {{ value }}
32 | {{ /playlist }}
33 | ```
34 |
35 | ```.language-output
36 | Gong Gong
37 | Possom Posse
38 | Justin Bieber
39 | ```
40 |
--------------------------------------------------------------------------------
/content/collections/kb/homepage-only.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Why can I only see the homepage?
3 | kb_categories:
4 | - Troubleshooting Common Scenarios
5 | id: 3365a1e0-4a1c-4cc5-8ed3-aada1ee81e2d
6 | ---
7 | The number 1 reason for this is because you don't have your URL rewrites set up.
8 |
9 | Out of the box, Statamic will omit `index.php` from URLs, because it's the "right" way to do things. That also means
10 | we assume you will have URL rewrites set up in one way or another.
11 |
12 | If you're running Apache, you're probably missing an `.htaccess` file. If you're running Nginx, you haven't set up
13 | rules in your `nginx.conf.` Statamic comes bundled with sample versions of these files.
14 |
15 | For more details, check out the [URL rewrite manual page](https://docs.statamic.com/installing#rewrites)
16 |
--------------------------------------------------------------------------------
/content/collections/kb/trial-mode.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: "What's Trial Mode?"
3 | kb_categories:
4 | - Tips, Tricks, and How-Tos
5 | id: 1791b60f-878c-4741-a2bf-a4997ad92a15
6 | ---
7 | Statamic will run in _Trial Mode_ (previously _Developer Mode_) if you're running on a non-public domain (like `.local` or `.test`). Our [article about how licensing works][licensing] explains how we define a public domain.
8 |
9 | This allows you to try out Statamic and even develop the site until you're ready to purchase licenses.
10 |
11 | Trial mode applies to the Statamic core as well as any commercial addons.
12 |
13 | What we recommend is to run Statamic locally on a `mysite.test` domain. Then, when you're ready: purchase your licenses,
14 | drop in the keys, and deploy your site.
15 |
16 | [licensing]: /licensing
17 |
--------------------------------------------------------------------------------
/content/collections/tags/collection-count.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Count
3 | overview: Get the number of entries in a collection.
4 | parameters:
5 | -
6 | name: from|folder|use|in|collection
7 | type: string
8 | description: >
9 | The collection in which to count entries. All the parameters do the same thing - use whatever feels most natural
10 | in your templates.
11 | -
12 | name: collection params
13 | type: inheritance
14 | description: 'All parameters available on the [collection tag](/tags/collection) are also available here.'
15 | id: b888a242-ca4c-4a96-81ca-518bc5e3b085
16 | ---
17 |
18 | ## Example {#example}
19 |
20 | ```
21 | There are {{ collection:count in="blog" }} blog posts.
22 | ```
23 |
24 | ``` .language-output
25 | There are 10 blog posts.
26 | ```
27 |
--------------------------------------------------------------------------------
/content/collections/events/content-deleted.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: ContentDeleted
3 | class: Statamic\Events\Data\ContentDeleted
4 | id: 3a226dda-2a67-41b6-904b-4471a558500b
5 | ---
6 | This is a [data event](/addons/events#data-events) that is dispatched when any Page, Entry, Taxonomy Term, or Global is deleted.
7 |
8 | ```
9 | public function handle(ContentDeleted $event)
10 | {
11 | // In addition to data event methods, you get:
12 | $event->id; // The ID of the object that was deleted.
13 | }
14 | ```
15 |
16 | If you require listening for more a more specific version, an event for the respective content type will also be dispatched:
17 |
18 | - `Statamic\Events\Data\PageDeleted`
19 | - `Statamic\Events\Data\EntryDeleted`
20 | - `Statamic\Events\Data\TermDeleted`
21 | - `Statamic\Events\Data\GlobalsDeleted`
22 |
--------------------------------------------------------------------------------
/content/collections/classes/term.md:
--------------------------------------------------------------------------------
1 | ---
2 | class: Statamic\Data\Taxonomies\Term
3 | title: Term
4 | id: 1ec6a8eb-3e90-4302-8cc2-5048dd663e6d
5 | ---
6 | Inheritance: [Content](/addons/api/content) > [Data](/addons/api/data)
7 |
8 | ## taxonomy
9 |
10 | Get or set the associated taxonomy. You can pass either a string or a `Taxonomy`.
11 |
12 | ```
13 | $term->taxonomy(); // Returns Taxonomy
14 | ```
15 | ```
16 | $term->taxonomy($taxonomy); // Returns null
17 | ```
18 |
19 | ## taxonomyName
20 |
21 | Get or set the associated taxonomy.
22 |
23 | ```
24 | $term->taxonomy(); // Returns a string, eg. 'tags'
25 | ```
26 | ```
27 | $term->taxonomy('tags'); // Returns null
28 | ```
29 |
30 | ## count
31 |
32 | Get the number of content objects that use this term.
33 |
34 | ```
35 | $term->count(); // Returns an integer
36 | ```
37 |
--------------------------------------------------------------------------------
/content/collections/modifiers/as.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: ada24ec2-1b6e-4759-b2c0-06d9d464f3f9
3 | types:
4 | - array
5 | - utility
6 | ---
7 | Alias an array variable with a key, giving you some useful markup/iteration options.
8 |
9 | ```.language-yaml
10 | blocks:
11 | -
12 | type: text
13 | content: I love to eat tacos in the bathroom.
14 | -
15 | type: photo
16 | photo: /assets/img/baño-tacos.jpg
17 | ```
18 |
19 | ```
20 | {{ blocks as="block" }}
21 | {{ block | partial:type }}
22 | {{ /blocks }}
23 | ```
24 |
25 | ```.language-output
26 |
27 |
28 |
29 | I like to eat tacos in the bathroom.
30 |
31 |
32 | 
33 |
34 | ```
35 |
--------------------------------------------------------------------------------
/content/pages/index.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Statamic 2 Documentation
3 | template: home
4 | id: db0ae4e3-4f10-4802-bc40-0b880cbf02c7
5 | overview: |
6 | Statamic cuts out the database to create a faster, more productive way to build, manage, and version control beautifully creative, bespoke websites.
7 | ---
8 | By eliminating the rigid, relational database, we unlock the ability to create and support any data structures you can imagine, and provide you with a Control Panel that is flexible in ways you may assume are impossible. Statamic can scale to heights not possible with a MySQL database.
9 |
10 | Out of the box, Statamic runs on a flat file engine based on Markdown and YAML files and a smart caching system. As your site grows, you can take advantage of other storage mechanisms to scale up to sites as large as [spiegel.de](https://spiegel.de).
11 |
--------------------------------------------------------------------------------
/content/collections/modifiers/modify_date.md:
--------------------------------------------------------------------------------
1 | ---
2 | types:
3 | - date
4 | id: 18596c62-5535-41a8-91c4-b5769fb11085
5 | parse_content: true
6 | ---
7 | Alters a timestamp by incrementing or decrementing in a format accepted by PHP's native [`strtotime()`](http://php.net/manual/en/function.strtotime.php) method.
8 |
9 |
10 | ```.language-yaml
11 | date: {{ now }}
12 | ```
13 |
14 | {{ noparse }}
15 | ```
16 | {{ date | modify_date:last Sunday }}
17 | {{ date | modify_date:+3 months }}
18 | {{ date | modify_date:-2 weeks }}
19 | ```
20 | {{ /noparse }}
21 |
22 | ```.language-output
23 | {{ now | modify_date:last Sunday }}
24 | {{ now | modify_date:+3 months }}
25 | {{ now | modify_date:-2 weeks }}
26 | ```
27 |
28 | > This modifier **modifies the variable directly** which will carry over to subsequent modifications, as shown in the above example.
29 |
--------------------------------------------------------------------------------
/content/collections/modifiers/plural.md:
--------------------------------------------------------------------------------
1 | ---
2 | types:
3 | - array
4 | - utility
5 | id: d464d979-7e57-40a6-8892-a08d08bd7ccf
6 | ---
7 | Get the plural form of an English word. Accepts a numerical parameter, either as a literal value or a variable, to control plurality. It's important to note that you should use the singular form of the word to ensure the best results.
8 |
9 | ```.language-yaml
10 | shopping_list:
11 | - item: pickle
12 | quantity: 1
13 | - item: apple
14 | quantity: 12
15 | - item: donut
16 | quantity: 500
17 | ```
18 |
19 | ```
20 | Please pick up the following items:
21 | {{ shopping_list }}
22 | - {{ quantity }} {{ item | plural:quantity }}.
23 | {{ /shopping_list }}
24 | ```
25 |
26 | ```.language-output
27 | Please pick up the following items:
28 | - 1 pickle
29 | - 3 apples
30 | - 500 donuts
31 | ```
32 |
--------------------------------------------------------------------------------
/content/collections/classes/api-page.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Page
3 | class: Statamic\API\Page
4 | id: f871b95e-3861-43d2-957b-9002601eb52b
5 | ---
6 | ## Get all pages.
7 |
8 | ``` php
9 | Page::all(); // Returns PageCollection
10 | ```
11 |
12 | ## Get a page by ID.
13 |
14 | ``` php
15 | Page::find($id); // Returns Page
16 | ```
17 |
18 | ## Get a page by URI.
19 |
20 | ``` php
21 | Page::whereUri($uri); // Returns Page
22 | ```
23 |
24 | ## Check if a page exists.
25 |
26 | ``` php
27 | Page::exists($id); // Returns a boolean
28 | ```
29 |
30 | ## Check if a page exists by URI.
31 |
32 | ``` php
33 | Page::uriExists($uri); // Returns a boolean
34 | ```
35 |
36 | ## Create a page.
37 |
38 | This returns an instance of a `PageFactory` to allow you to chain and build your page.
39 |
40 | ```
41 | Page::create($uri); // Returns PageFactory
42 | ```
43 |
--------------------------------------------------------------------------------
/content/collections/modifiers/truncate.md:
--------------------------------------------------------------------------------
1 | ---
2 | types:
3 | - string
4 | id: cc80cc58-f73a-47fd-8f4d-e1cfc23c5d56
5 | ---
6 | Truncates the string to a given length (parameter 1). You can append a string with parameter 2, and if truncating occurs the string is further truncated so that it may be appended without exceeding the desired length.
7 |
8 | This differs from [safe_truncate][safe_truncate] in that it _may_ truncate in the middle of a word.
9 |
10 | ```.language-yaml
11 | advice: >
12 | So, here’s some advice I wish I woulda got when I was your age:
13 | Live every week like it’s Shark Week.
14 | ```
15 |
16 | ```
17 | {{ advice | truncate:90:... }}
18 | ```
19 |
20 | ```.language-output
21 | So, here’s some advice I wish I woulda got when I was your age:
22 | Live every week like i...
23 | ```
24 |
25 | [safe_truncate]: /modifiers/safe_truncate
26 |
--------------------------------------------------------------------------------
/content/collections/variables/get.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: 546c4334-df40-4e9a-aff4-a56c43e839d8
3 | types:
4 | - global
5 | ---
6 | An array of `GET` variables that come from any query strings present in the current URL. It can be used as a tag pair with access to all your parameters or as a single tag to access parameters directly. A counterpart to `{{ post }}`.
7 |
8 |
9 | Example URL: `/about?show=pants&hide=jeggings`
10 |
11 | ```
12 | {{ get:show }}
13 |
14 | {{ get }}
15 | {{ show }}
16 | {{ hide }}
17 | {{ /get }}
18 |
19 | ```
20 |
21 | ``` .language-output
22 | pants
23 |
24 | pants
25 | jeggings
26 | ```
27 |
28 | Be sure to escape these values with the `sanitize` modifier if you plan to use them in output in production.
29 |
30 | ```
31 |
32 | {{ get:jeggings | sanitize }}
33 | ```
--------------------------------------------------------------------------------
/content/collections/modifiers/table.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Table
3 | types:
4 | - string
5 | - markup
6 | - utility
7 | id: 4d8e0392-af96-4b46-a73a-d3a47b57ccbe
8 | ---
9 | Takes an array generated by the [Table Fieldtype](/fieldtypes/table), and converts into a basic HTML ``.
10 |
11 | ``` .language-yaml
12 | my_table:
13 | -
14 | cells:
15 | - One
16 | - Two
17 | -
18 | cells:
19 | - Three
20 | - Four
21 | ```
22 |
23 | ```
24 | {{ my_table | table }}
25 | ```
26 |
27 | ``` .language-output
28 |
29 |
30 | One
31 | Two
32 |
33 |
34 | Three
35 | Four
36 |
37 |
38 | ```
39 |
40 | You can pass `true` as an argument to parse the cell data as markdown.
41 |
42 | ```
43 | {{ my_table | table:true }}
44 | ```
45 |
--------------------------------------------------------------------------------
/content/pages/7.addons/9.api/index.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: API Reference
3 | id: 0bf69591-dd53-4bde-9bd7-0683ce5623de
4 | template: api
5 | overview: |
6 | Within your addons you will be able to access and manipulate content, data, and whatever else you can think of. In here, we explain all the classes you might care about and how to use them.
7 | ---
8 | Generally speaking, you should use the classes in the `Statamic\API` namespace as entry points to the API.
9 |
10 | However, methods in those classes, as well as other areas may return classes outside of the `Statamic\API` namespace. You will usually not need to create or instantiate these directly.
11 |
12 | For example, want to create an entry? You will use `Statamic\API\Entry::create()`, which returns an `Statamic\Data\Entries\EntryFactory`, which will eventually return
13 | a `Statamic\Data\Entries\Entry`. You wouldn't do `new Entry`.
--------------------------------------------------------------------------------
/content/collections/classes/api-term.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Term
3 | class: Statamic\API\Term
4 | id: 7c3b86e0-f993-4eb4-8e36-1486b8e27937
5 | ---
6 | ## Get all terms.
7 |
8 | ``` php
9 | Term::all(); // Returns TermCollection
10 | ```
11 |
12 | ## Get a term by ID.
13 |
14 | ``` php
15 | Term::find($id); // Returns Term
16 | ```
17 |
18 | ## Get a term by slug (and taxonomy).
19 |
20 | ``` php
21 | Term::whereSlug($slug, $taxonomy); // Returns Term
22 | ```
23 |
24 | ## Get a term by URI.
25 |
26 | ``` php
27 | Term::whereUri($uri); // Returns Term
28 | ```
29 |
30 | ## Get all terms in a taxonomy.
31 |
32 | ``` php
33 | Term::whereTaxonomy($taxonomy); // Returns TermCollection
34 | ```
35 |
36 | ## Create a term.
37 |
38 | This returns an instance of a `TermFactory` to allow you to chain and build your term.
39 |
40 | ```
41 | Term::create($slug); // Returns TermFactory
42 | ```
43 |
--------------------------------------------------------------------------------