Function __global->handle_upload_syndication
Definitions
sources/upload_syndication.php
- Do upload syndication (after an upload has been received, in-context).
- 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 | Upload field name |
| $title | string | required parameter | N/A | N/A | Title associated with the upload |
| $description | string | required parameter | N/A | N/A | Description associated with the upload |
| $url | URLPATH | required parameter | N/A | N/A | URL to the upload (should be local, if it isn't we'll return quickly without doing anything) |
| $filename | ID_TEXT | required parameter | N/A | N/A | Filename |
| $remove_locally_if_no_quota | boolean | required parameter | N/A | N/A | Whether to delete the local copy, if the current user has no upload quota. If no syndication was set, an error will be given. |
Return
- New URL (if we deleted the local copy, it will be a remote URL)
- Type: URLPATH
- Set: N/A
- Range: N/A