Function __global->post_param_multi_source_upload
Definitions
sources/uploads.php
- An upload has been passed through by POST, either as a file (a new upload), a URL, or as a filedump reference.For images use post_param_image instead.Used with form_input_upload_multi_source.Get the file URL from the POST data.
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: string
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $name | ID_TEXT | required parameter | N/A | N/A | Form field prefix (input type suffixes will be added automatically) |
| $upload_to | ?PATH | required parameter | N/A | N/A | Where to upload to (null: the correct place for $theme_image_type) |
| $required | boolean | True | N/A | N/A | Whether an image is required |
| $is_edit | boolean | False | N/A | N/A | Whether this is an edit operation |
| $filename | ?string | Null | N/A | N/A | Pass the filename back by reference (null: do not pass) |
| $thumb_url | ?string | Null | N/A | N/A | Pass the thumbnail back by reference (null: do not pass & do not collect a thumbnail) |
| $upload_type | integer | 15 | N/A | N/A | A CMS_UPLOAD_* constant |
| $copy_to_server | boolean | False | N/A | N/A | Whether to copy a URL (if a URL) to the server, and return a local reference |
| $obfuscate | integer | 0 | N/A | N/A | Whether to obfuscate file names so the URLs can not be guessed/derived (a OBFUSCATE_* constant) |
Return
- The URL (either to an independent upload, or the theme image, or a filedump URL) (null: leave alone, when doing an edit operation)
- Type: ?URLPATH
- Set: N/A
- Range: N/A