$site->createFile()
Creates a new file
$site->createFile(array $props, bool $move = false): Kirby\Cms\File
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| $props * | array |
– | |
| $move | bool |
false |
If set to true, the source will be deleted |
For the $props parameter, you pass an array with the following data, which will be used to set up the Kirby\Cms\File object:
| Name | Type | Description |
|---|---|---|
| blueprint | array |
Sets the Blueprint object |
| content | array |
Sets the Content object |
| filename * | string |
Sets the filename |
| parent * | Kirby\Cms\Model |
Sets the parent model object |
| root | string |
Always set the root to null, to invoke auto root detection |
| template | string |
|
| translations | array |
Create the translations collection from an array |
| url | string |
Sets the url |
Return type
Parent class
Example
<?php
$kirby->impersonate('kirby');
$newPage = $site->createFile(
[
'filename' => 'trees.jpg',
'parent' => $site,
'source' => $kirby->root('assets') . '/images/trees.jpg',
'template' => 'image',
'content' => [
'alt' => 'A beautiful flower',
],
]
);