Skip to content

Commit c8fbf2a

Browse files
committed
Merge branch 'main' of https://github.com/craftcms/docs
2 parents 2306ed6 + 1810513 commit c8fbf2a

File tree

9 files changed

+77
-315
lines changed

9 files changed

+77
-315
lines changed

docs/.artifacts/cms/5.x/config-general.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ Defined by
132132

133133
Whether Craft should allow system and plugin updates in the control panel, and plugin installation from the Plugin Store.
134134

135-
This setting will automatically be disabled if <config4:allowAdminChanges> is disabled.
135+
This setting will automatically be disabled if <config5:allowAdminChanges> is disabled.
136136

137137
::: code
138138
```php Static Config
@@ -387,7 +387,7 @@ Since
387387
The default locale the control panel should use for date/number formatting, for users who haven’t set
388388
a preferred language or formatting locale.
389389

390-
If this is `null`, the <config4:defaultCpLanguage> config setting will determine which locale is used for date/number formatting by default.
390+
If this is `null`, the <config5:defaultCpLanguage> config setting will determine which locale is used for date/number formatting by default.
391391

392392
::: code
393393
```php Static Config
@@ -784,7 +784,7 @@ Defined by
784784

785785
</div>
786786

787-
List of file extensions that will be merged into the <config4:allowedFileExtensions> config setting.
787+
List of file extensions that will be merged into the <config5:allowedFileExtensions> config setting.
788788

789789
::: code
790790
```php Static Config
@@ -877,11 +877,11 @@ When this is enabled, the following changes will take place:
877877
- Front-end routing will skip checks for element and template requests.
878878
- Front-end responses will be JSON-formatted rather than HTML by default.
879879
- Twig will be configured to escape unsafe strings for JavaScript/JSON rather than HTML by default for front-end requests.
880-
- The <config4:loginPath>, <config4:logoutPath>, <config4:setPasswordPath>, and <config4:verifyEmailPath> settings will be ignored.
880+
- The <config5:loginPath>, <config5:logoutPath>, <config5:setPasswordPath>, and <config5:verifyEmailPath> settings will be ignored.
881881

882882
::: tip
883883
With Headless Mode enabled, users may only set passwords and verify email addresses via the control panel. Be sure to grant “Access the control
884-
panel” permission to all content editors and administrators. You’ll also need to set the <config4:baseCpUrl> config setting if the control
884+
panel” permission to all content editors and administrators. You’ll also need to set the <config5:baseCpUrl> config setting if the control
885885
panel is located on a different domain than your front end.
886886
:::
887887

@@ -1429,7 +1429,7 @@ Defined by
14291429
: [GeneralConfig::$safeMode](craft5:craft\config\GeneralConfig::$safeMode)
14301430
14311431
Since
1432-
: 4.9.0
1432+
: 5.1.0
14331433
14341434
</div>
14351435
@@ -1747,7 +1747,7 @@ page as well for this to work. You can conditionally include it for only Live Pr
17471747
`x-craft-live-preview` query string parameter.
17481748

17491749
::: tip
1750-
You can customize the behavior of iFrame Resizer via the <config4:previewIframeResizerOptions> config setting.
1750+
You can customize the behavior of iFrame Resizer via the <config5:previewIframeResizerOptions> config setting.
17511751
:::
17521752

17531753
::: code
@@ -1845,7 +1845,7 @@ Defined by
18451845
: [GeneralConfig::$backupCommandFormat](craft5:craft\config\GeneralConfig::$backupCommandFormat)
18461846

18471847
Since
1848-
: 4.9.0
1848+
: 5.1.0
18491849

18501850
</div>
18511851

@@ -2154,7 +2154,7 @@ The base URL Craft should use when generating control panel URLs.
21542154
It will be determined automatically if left blank.
21552155

21562156
::: tip
2157-
The base control panel URL should **not** include the [control panel trigger word](config4:cpTrigger) (e.g. `/admin`).
2157+
The base control panel URL should **not** include the [control panel trigger word](config5:cpTrigger) (e.g. `/admin`).
21582158
:::
21592159

21602160
::: code
@@ -2187,14 +2187,14 @@ The URI segment Craft should look for when determining if the current request sh
21872187
the front-end website.
21882188
21892189
This can be set to `null` if you have a dedicated hostname for the control panel (e.g. `cms.my-project.tld`), or you are running Craft in
2190-
[Headless Mode](config4:headlessMode). If you do that, you will need to ensure that the control panel is being served from its own web root
2190+
[Headless Mode](config5:headlessMode). If you do that, you will need to ensure that the control panel is being served from its own web root
21912191
directory on your server, with an `index.php` file that defines the `CRAFT_CP` PHP constant.
21922192
21932193
```php
21942194
define('CRAFT_CP', true);
21952195
```
21962196
2197-
Alternatively, you can set the <config4:baseCpUrl> config setting, but then you will run the risk of losing access to portions of your
2197+
Alternatively, you can set the <config5:baseCpUrl> config setting, but then you will run the risk of losing access to portions of your
21982198
control panel due to URI conflicts with actual folders/files in your main web root.
21992199
22002200
(For example, if you have an `assets/` folder, that would conflict with the `/assets` page in the control panel.)
@@ -2262,7 +2262,7 @@ The URI Craft should use for user login on the front end.
22622262
22632263
This can be set to `false` to disable front-end login.
22642264
2265-
Note that this config setting is ignored when <config4:headlessMode> is enabled.
2265+
Note that this config setting is ignored when <config5:headlessMode> is enabled.
22662266
22672267
See [craft\helpers\ConfigHelper::localizedValue()](https://docs.craftcms.com/api/v5/craft-helpers-confighelper.html#method-localizedvalue) for a list of supported value types.
22682268
@@ -2296,7 +2296,7 @@ The URI Craft should use for user logout on the front end.
22962296
22972297
This can be set to `false` to disable front-end logout.
22982298
2299-
Note that this config setting is ignored when <config4:headlessMode> is enabled.
2299+
Note that this config setting is ignored when <config5:headlessMode> is enabled.
23002300
23012301
See [craft\helpers\ConfigHelper::localizedValue()](https://docs.craftcms.com/api/v5/craft-helpers-confighelper.html#method-localizedvalue) for a list of supported value types.
23022302
@@ -2349,7 +2349,7 @@ CRAFT_OMIT_SCRIPT_NAME_IN_URLS=1
23492349
23502350
::: tip
23512351
Even when this is set to `true`, the script name could still be included in some action URLs.
2352-
If you want to ensure that `index.php` is fully omitted from **all** generated URLs, set the <config4:pathParam>
2352+
If you want to ensure that `index.php` is fully omitted from **all** generated URLs, set the <config5:pathParam>
23532353
config setting to `null`.
23542354
:::
23552355
@@ -2381,7 +2381,7 @@ Example Value | Example URI
23812381
`?page` | `/news?page=5`
23822382
23832383
::: tip
2384-
If you want to set this to `?p` (e.g. `/news?p=5`), you’ll also need to change your <config4:pathParam> setting which defaults to `p`.
2384+
If you want to set this to `?p` (e.g. `/news?p=5`), you’ll also need to change your <config5:pathParam> setting which defaults to `p`.
23852385
If your server is running Apache, you’ll need to update the redirect code in your `.htaccess` file to match your new `pathParam` value.
23862386
:::
23872387
@@ -2481,7 +2481,7 @@ Defined by
24812481
24822482
The path users should be redirected to after logging in from the front-end site.
24832483
2484-
This setting will also come into effect if the user visits the login page (as specified by the <config4:loginPath> config setting) when
2484+
This setting will also come into effect if the user visits the login page (as specified by the <config5:loginPath> config setting) when
24852485
they are already logged in.
24862486
24872487
See [craft\helpers\ConfigHelper::localizedValue()](https://docs.craftcms.com/api/v5/craft-helpers-confighelper.html#method-localizedvalue) for a list of supported value types.
@@ -2544,12 +2544,12 @@ Defined by
25442544
25452545
The URI or URL that Craft should use for Set Password forms on the front end.
25462546
2547-
This setting is ignored when <config4:headlessMode> is enabled, unless it’s set to an absolute URL.
2547+
This setting is ignored when <config5:headlessMode> is enabled, unless it’s set to an absolute URL.
25482548
25492549
See [craft\helpers\ConfigHelper::localizedValue()](https://docs.craftcms.com/api/v5/craft-helpers-confighelper.html#method-localizedvalue) for a list of supported value types.
25502550
25512551
::: tip
2552-
You might also want to set <config4:invalidUserTokenPath> in case a user clicks on an expired password reset link.
2552+
You might also want to set <config5:invalidUserTokenPath> in case a user clicks on an expired password reset link.
25532553
:::
25542554
25552555
::: code
@@ -2588,7 +2588,7 @@ See [craft\helpers\ConfigHelper::localizedValue()](https://docs.craftcms.com/api
25882588
If this is set, Craft will redirect [.well-known/change-password requests](https://w3c.github.io/webappsec-change-password-url/) to this URI.
25892589
25902590
::: tip
2591-
You’ll also need to set [setPasswordPath](config4:setPasswordPath), which determines the URI and template path for the Set Password form
2591+
You’ll also need to set [setPasswordPath](config5:setPasswordPath), which determines the URI and template path for the Set Password form
25922592
where the user resets their password after following the link in the Password Reset email.
25932593
:::
25942594
@@ -2709,7 +2709,7 @@ Defined by
27092709
27102710
Whether Craft should specify the path using `PATH_INFO` or as a query string parameter when generating URLs.
27112711
2712-
This setting only takes effect if <config4:omitScriptNameInUrls> is set to `false`.
2712+
This setting only takes effect if <config5:omitScriptNameInUrls> is set to `false`.
27132713
27142714
::: code
27152715
```php Static Config
@@ -2774,7 +2774,7 @@ Since
27742774
27752775
The URI or URL that Craft should use for email verification links on the front end.
27762776
2777-
This setting is ignored when <config4:headlessMode> is enabled, unless it’s set to an absolute URL.
2777+
This setting is ignored when <config5:headlessMode> is enabled, unless it’s set to an absolute URL.
27782778
27792779
See [craft\helpers\ConfigHelper::localizedValue()](https://docs.craftcms.com/api/v5/craft-helpers-confighelper.html#method-localizedvalue) for a list of supported value types.
27802780
@@ -3022,11 +3022,11 @@ Defined by
30223022
: [GeneralConfig::$asyncCsrfInputs](craft5:craft\config\GeneralConfig::$asyncCsrfInputs)
30233023
30243024
Since
3025-
: 4.9.0
3025+
: 5.1.0
30263026
30273027
</div>
30283028
3029-
Whether CSRF values should be injected via JavaScript for greater cache-ability.
3029+
Whether CSRF values should be injected via JavaScript for greater cache-ability. This setting can be overridden by passing an `async` option into the `csrfInput()` function.
30303030
30313031
::: code
30323032
```php Static Config
@@ -3124,7 +3124,7 @@ Defined by
31243124
31253125
</div>
31263126
3127-
The name of CSRF token used for CSRF validation if <config4:enableCsrfProtection> is set to `true`.
3127+
The name of CSRF token used for CSRF validation if <config5:enableCsrfProtection> is set to `true`.
31283128
31293129
::: code
31303130
```php Static Config
@@ -3279,7 +3279,7 @@ Defined by
32793279
32803280
</div>
32813281
3282-
Whether to use a cookie to persist the CSRF token if <config4:enableCsrfProtection> is enabled. If false, the CSRF token will be
3282+
Whether to use a cookie to persist the CSRF token if <config5:enableCsrfProtection> is enabled. If false, the CSRF token will be
32833283
stored in session under the `csrfTokenName` config setting name. Note that while storing CSRF tokens in session increases security,
32843284
it requires starting a session for every page that a CSRF token is needed, which may degrade site performance.
32853285
@@ -3434,7 +3434,7 @@ Since
34343434
34353435
The amount of time content preview tokens can be used before expiring.
34363436
3437-
Defaults to <config4:defaultTokenDuration> value.
3437+
Defaults to <config5:defaultTokenDuration> value.
34383438
34393439
See [craft\helpers\ConfigHelper::durationInSeconds()](https://docs.craftcms.com/api/v5/craft-helpers-confighelper.html#method-durationinseconds) for a list of supported value types.
34403440
@@ -3936,7 +3936,7 @@ List of additional file kinds Craft should support. This array will get merged w
39363936
39373937
::: tip
39383938
File extensions listed here won’t immediately be allowed to be uploaded. You will also need to list them with
3939-
the <config4:extraAllowedFileExtensions> config setting.
3939+
the <config5:extraAllowedFileExtensions> config setting.
39403940
:::
39413941
39423942
@@ -4400,7 +4400,7 @@ Since
44004400
44014401
Whether SVG thumbnails should be rasterized.
44024402
4403-
This will only work if ImageMagick is installed, and <config4:imageDriver> is set to either `auto` or `imagick`.
4403+
This will only work if ImageMagick is installed, and <config5:imageDriver> is set to either `auto` or `imagick`.
44044404
44054405
::: code
44064406
```php Static Config
@@ -4874,7 +4874,7 @@ Since
48744874
48754875
</div>
48764876
4877-
Whether the <config4:gqlTypePrefix> config setting should have an impact on `query`, `mutation`, and `subscription` types.
4877+
Whether the <config5:gqlTypePrefix> config setting should have an impact on `query`, `mutation`, and `subscription` types.
48784878
48794879
::: code
48804880
```php Static Config

docs/.artifacts/commerce/4.x/donations.md

Lines changed: 0 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@
1111
| [afterPopulate](#afterpopulate) | Performs any post-population processing on elements.
1212
| [andRelatedTo](#andrelatedto) | Narrows the query results to only elements that are related to certain other elements.
1313
| [asArray](#asarray) | Causes the query to return matching elements as arrays of data, rather than ElementClass objects.
14-
| [average](#average) | Returns the average of the specified column values.
1514
| [cache](#cache) | Enables query cache for this Query.
1615
| [clearCachedResult](#clearcachedresult) | Clears the [cached result](https://craftcms.com/docs/4.x/element-queries.html#cache).
1716
| [dateCreated](#datecreated) | Narrows the query results based on the elements’ creation dates.
@@ -22,8 +21,6 @@
2221
| [inReverse](#inreverse) | Causes the query results to be returned in reverse order.
2322
| [language](#language) | Determines which site(s) the elements should be queried in, based on their language.
2423
| [limit](#limit) | Determines the number of elements that should be returned.
25-
| [max](#max) | Returns the maximum of the specified column values.
26-
| [min](#min) | Returns the minimum of the specified column values.
2724
| [offset](#offset) | Determines how many elements should be skipped in the results.
2825
| [orderBy](#orderby) | Determines the order that the elements should be returned in. (If empty, defaults to `dateCreated DESC, elements.id`.)
2926
| [preferSites](#prefersites) | If [unique()](https://docs.craftcms.com/api/v4/craft-elements-db-elementquery.html#method-unique) is set, this determines which site should be selected when querying multi-site elements.
@@ -32,7 +29,6 @@
3229
| [search](#search) | Narrows the query results to only elements that match a search query.
3330
| [siteSettingsId](#sitesettingsid) | Narrows the query results based on the elements’ IDs in the `elements_sites` table.
3431
| [sku](#sku) | Narrows the query results based on the SKU.
35-
| [sum](#sum) | Returns the sum of the specified column values.
3632
| [trashed](#trashed) | Narrows the query results to only elements that have been soft-deleted.
3733
| [uid](#uid) | Narrows the query results based on the elements’ UIDs.
3834
| [with](#with) | Causes the query to return matching elements eager-loaded with related elements.
@@ -108,19 +104,6 @@ $elements = ElementClass::find()
108104
:::
109105

110106

111-
#### `average`
112-
113-
Returns the average of the specified column values.
114-
115-
116-
117-
118-
119-
120-
121-
122-
123-
124107
#### `cache`
125108

126109
Enables query cache for this Query.
@@ -392,32 +375,6 @@ $elements = ElementClass::find()
392375
:::
393376

394377

395-
#### `max`
396-
397-
Returns the maximum of the specified column values.
398-
399-
400-
401-
402-
403-
404-
405-
406-
407-
408-
#### `min`
409-
410-
Returns the minimum of the specified column values.
411-
412-
413-
414-
415-
416-
417-
418-
419-
420-
421378
#### `offset`
422379

423380
Determines how many elements should be skipped in the results.
@@ -634,19 +591,6 @@ $element = ElementClass::find()
634591
:::
635592

636593

637-
#### `sum`
638-
639-
Returns the sum of the specified column values.
640-
641-
642-
643-
644-
645-
646-
647-
648-
649-
650594
#### `trashed`
651595

652596
Narrows the query results to only elements that have been soft-deleted.

0 commit comments

Comments
 (0)