Function __global->edit_image
Definitions
sources/galleries2.php
- Edit an image in a specified gallery.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $id | AUTO_LINK | No | No | required parameter | N/A | N/A | The ID of the image to edit |
| $title | SHORT_TEXT | No | No | required parameter | N/A | N/A | Image title |
| $cat | ID_TEXT | No | No | required parameter | N/A | N/A | The gallery name |
| $description | LONG_TEXT | No | No | required parameter | N/A | N/A | The image description |
| $url | URLPATH | No | No | required parameter | N/A | N/A | The URL to the actual image |
| $validated | BINARY | No | No | required parameter | N/A | N/A | Whether the image has been validated for display on the site |
| $allow_rating | BINARY | No | No | required parameter | N/A | N/A | Whether the image may be rated |
| $allow_comments | SHORT_INTEGER | No | No | required parameter | N/A | N/A | Whether the image may be commented upon |
| $allow_trackbacks | BINARY | No | No | required parameter | N/A | N/A | Whether the image may be trackbacked |
| $notes | LONG_TEXT | No | No | required parameter | N/A | N/A | Hidden notes associated with the image |
| $meta_keywords | SHORT_TEXT | No | No | required parameter | N/A | N/A | Meta keywords |
| $meta_description | LONG_TEXT | No | No | required parameter | N/A | N/A | Meta description |
| $edit_time | ?TIME | No | No | Null | N/A | N/A | Edit time (null: either means current time, or if $null_is_literal, means reset to to null) |
| $add_time | ?TIME | No | No | Null | N/A | N/A | Add time (null: do not change) |
| $views | ?integer | No | No | Null | N/A | N/A | Number of views (null: do not change) |
| $submitter | ?MEMBER | No | No | Null | N/A | N/A | Submitter (null: do not change) |
| $regions | array | No | No | [] | N/A | N/A | The regions (empty: not region-limited) |
| $null_is_literal | boolean | No | No | False | N/A | N/A | Determines whether some nulls passed mean 'use a default' or literally mean 'set to null' |
| $watermark | boolean | No | No | True | N/A | N/A | Whether to apply watermarks to this image |
Preview
Code (PHP)
/**
* Edit an image in a specified gallery.
*
* @param AUTO_LINK $id The ID of the image to edit
* @param SHORT_TEXT $title Image title
* @param ID_TEXT $cat The gallery name
* @param LONG_TEXT $description The image description
* @param URLPATH $url The URL to the actual image
* @param BINARY $validated Whether the image has been validated for display on the site
* @param BINARY $allow_rating Whether the image may be rated
* @param SHORT_INTEGER $allow_comments Whether the image may be commented upon
* @param BINARY $allow_trackbacks Whether the image may be trackbacked
* @param LONG_TEXT $notes Hidden notes associated with the image
* @param SHORT_TEXT $meta_keywords Meta keywords
* @param LONG_TEXT $meta_description Meta description
* @param ?TIME $edit_time Edit time (null: either means current time, or if $null_is_literal, means reset to to null)
* @param ?TIME $add_time Add time (null: do not change)
* @param ?integer $views Number of views (null: do not change)
* @param ?MEMBER $submitter Submitter (null: do not change)
* @param array $regions The regions (empty: not region-limited)
* @param boolean $null_is_literal Determines whether some nulls passed mean 'use a default' or literally mean 'set to null'
* @param boolean $watermark Whether to apply watermarks to this image
*/
function edit_image(int $id, string $title, string $cat, string $description, string $url, int $validated, int $allow_rating, int $allow_comments, int $allow_trackbacks, string $notes, string $meta_keywords, string $meta_description, ?int $edit_time = null, ?int $add_time = null, ?int $views = null, ?int $submitter = null, array $regions = [], bool $null_is_literal = false, bool $watermark = true)
* Edit an image in a specified gallery.
*
* @param AUTO_LINK $id The ID of the image to edit
* @param SHORT_TEXT $title Image title
* @param ID_TEXT $cat The gallery name
* @param LONG_TEXT $description The image description
* @param URLPATH $url The URL to the actual image
* @param BINARY $validated Whether the image has been validated for display on the site
* @param BINARY $allow_rating Whether the image may be rated
* @param SHORT_INTEGER $allow_comments Whether the image may be commented upon
* @param BINARY $allow_trackbacks Whether the image may be trackbacked
* @param LONG_TEXT $notes Hidden notes associated with the image
* @param SHORT_TEXT $meta_keywords Meta keywords
* @param LONG_TEXT $meta_description Meta description
* @param ?TIME $edit_time Edit time (null: either means current time, or if $null_is_literal, means reset to to null)
* @param ?TIME $add_time Add time (null: do not change)
* @param ?integer $views Number of views (null: do not change)
* @param ?MEMBER $submitter Submitter (null: do not change)
* @param array $regions The regions (empty: not region-limited)
* @param boolean $null_is_literal Determines whether some nulls passed mean 'use a default' or literally mean 'set to null'
* @param boolean $watermark Whether to apply watermarks to this image
*/
function edit_image(int $id, string $title, string $cat, string $description, string $url, int $validated, int $allow_rating, int $allow_comments, int $allow_trackbacks, string $notes, string $meta_keywords, string $meta_description, ?int $edit_time = null, ?int $add_time = null, ?int $views = null, ?int $submitter = null, array $regions = [], bool $null_is_literal = false, bool $watermark = true)
