You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/.artifacts/cms/5.x/config-general.md
+25-25Lines changed: 25 additions & 25 deletions
Original file line number
Diff line number
Diff line change
@@ -132,7 +132,7 @@ Defined by
132
132
133
133
Whether Craft should allow system and plugin updates in the control panel, and plugin installation from the Plugin Store.
134
134
135
-
This setting will automatically be disabled if <config4:allowAdminChanges> is disabled.
135
+
This setting will automatically be disabled if <config5:allowAdminChanges> is disabled.
136
136
137
137
::: code
138
138
```php Static Config
@@ -387,7 +387,7 @@ Since
387
387
The default locale the control panel should use for date/number formatting, for users who haven’t set
388
388
a preferred language or formatting locale.
389
389
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.
391
391
392
392
::: code
393
393
```php Static Config
@@ -784,7 +784,7 @@ Defined by
784
784
785
785
</div>
786
786
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.
788
788
789
789
::: code
790
790
```php Static Config
@@ -877,11 +877,11 @@ When this is enabled, the following changes will take place:
877
877
- Front-end routing will skip checks for element and template requests.
878
878
- Front-end responses will be JSON-formatted rather than HTML by default.
879
879
- 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.
881
881
882
882
::: tip
883
883
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
885
885
panel is located on a different domain than your front end.
886
886
:::
887
887
@@ -1747,7 +1747,7 @@ page as well for this to work. You can conditionally include it for only Live Pr
1747
1747
`x-craft-live-preview` query string parameter.
1748
1748
1749
1749
::: 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.
1751
1751
:::
1752
1752
1753
1753
::: code
@@ -2154,7 +2154,7 @@ The base URL Craft should use when generating control panel URLs.
2154
2154
It will be determined automatically if left blank.
2155
2155
2156
2156
::: 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`).
2158
2158
:::
2159
2159
2160
2160
::: code
@@ -2187,14 +2187,14 @@ The URI segment Craft should look for when determining if the current request sh
2187
2187
the front-end website.
2188
2188
2189
2189
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
2191
2191
directory on your server, with an `index.php` file that defines the `CRAFT_CP` PHP constant.
2192
2192
2193
2193
```php
2194
2194
define('CRAFT_CP', true);
2195
2195
```
2196
2196
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
2198
2198
control panel due to URI conflicts with actual folders/files in your main web root.
2199
2199
2200
2200
(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.
2262
2262
2263
2263
This can be set to `false` to disable front-end login.
2264
2264
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.
2266
2266
2267
2267
See [craft\helpers\ConfigHelper::localizedValue()](https://docs.craftcms.com/api/v5/craft-helpers-confighelper.html#method-localizedvalue) for a list of supported value types.
2268
2268
@@ -2296,7 +2296,7 @@ The URI Craft should use for user logout on the front end.
2296
2296
2297
2297
This can be set to `false` to disable front-end logout.
2298
2298
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.
2300
2300
2301
2301
See [craft\helpers\ConfigHelper::localizedValue()](https://docs.craftcms.com/api/v5/craft-helpers-confighelper.html#method-localizedvalue) for a list of supported value types.
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>
2353
2353
config setting to `null`.
2354
2354
:::
2355
2355
@@ -2381,7 +2381,7 @@ Example Value | Example URI
2381
2381
`?page` | `/news?page=5`
2382
2382
2383
2383
::: 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`.
2385
2385
If your server is running Apache, you’ll need to update the redirect code in your `.htaccess` file to match your new `pathParam` value.
2386
2386
:::
2387
2387
@@ -2481,7 +2481,7 @@ Defined by
2481
2481
2482
2482
The path users should be redirected to after logging in from the front-end site.
2483
2483
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
2485
2485
they are already logged in.
2486
2486
2487
2487
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
2544
2544
2545
2545
The URI or URL that Craft should use for Set Password forms on the front end.
2546
2546
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.
2548
2548
2549
2549
See [craft\helpers\ConfigHelper::localizedValue()](https://docs.craftcms.com/api/v5/craft-helpers-confighelper.html#method-localizedvalue) for a list of supported value types.
2550
2550
2551
2551
::: 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.
2553
2553
:::
2554
2554
2555
2555
::: code
@@ -2588,7 +2588,7 @@ See [craft\helpers\ConfigHelper::localizedValue()](https://docs.craftcms.com/api
2588
2588
If this is set, Craft will redirect [.well-known/change-password requests](https://w3c.github.io/webappsec-change-password-url/) to this URI.
2589
2589
2590
2590
::: 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
2592
2592
where the user resets their password after following the link in the Password Reset email.
2593
2593
:::
2594
2594
@@ -2709,7 +2709,7 @@ Defined by
2709
2709
2710
2710
Whether Craft should specify the path using `PATH_INFO` or as a query string parameter when generating URLs.
2711
2711
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`.
2713
2713
2714
2714
::: code
2715
2715
```php Static Config
@@ -2774,7 +2774,7 @@ Since
2774
2774
2775
2775
The URI or URL that Craft should use for email verification links on the front end.
2776
2776
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.
2778
2778
2779
2779
See [craft\helpers\ConfigHelper::localizedValue()](https://docs.craftcms.com/api/v5/craft-helpers-confighelper.html#method-localizedvalue) for a list of supported value types.
2780
2780
@@ -3124,7 +3124,7 @@ Defined by
3124
3124
3125
3125
</div>
3126
3126
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`.
3128
3128
3129
3129
::: code
3130
3130
```php Static Config
@@ -3279,7 +3279,7 @@ Defined by
3279
3279
3280
3280
</div>
3281
3281
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
3283
3283
stored in session under the `csrfTokenName` config setting name. Note that while storing CSRF tokens in session increases security,
3284
3284
it requires starting a session for every page that a CSRF token is needed, which may degrade site performance.
3285
3285
@@ -3434,7 +3434,7 @@ Since
3434
3434
3435
3435
The amount of time content preview tokens can be used before expiring.
3436
3436
3437
-
Defaults to <config4:defaultTokenDuration> value.
3437
+
Defaults to <config5:defaultTokenDuration> value.
3438
3438
3439
3439
See [craft\helpers\ConfigHelper::durationInSeconds()](https://docs.craftcms.com/api/v5/craft-helpers-confighelper.html#method-durationinseconds) for a list of supported value types.
3440
3440
@@ -3936,7 +3936,7 @@ List of additional file kinds Craft should support. This array will get merged w
3936
3936
3937
3937
::: tip
3938
3938
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.
3940
3940
:::
3941
3941
3942
3942
@@ -4400,7 +4400,7 @@ Since
4400
4400
4401
4401
Whether SVG thumbnails should be rasterized.
4402
4402
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`.
4404
4404
4405
4405
::: code
4406
4406
```php Static Config
@@ -4874,7 +4874,7 @@ Since
4874
4874
4875
4875
</div>
4876
4876
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.
0 commit comments