Function __global->check_form_field_image
Definitions
sources/images2.php
- Check form images based on fields.xml. Usually a no-op.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: string
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $name | string | No | No | required parameter | N/A | N/A | The name of the parameter |
| $val | URLPATH | No | No | required parameter | N/A | N/A | The current value of the parameter (if blank, no-op) |
| $delete_on_error | ?PATH | No | No | Null | N/A | N/A | File path to delete if there's an error (null: none) |
Returns
- Altered $val
- Type: string
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Check form images based on fields.xml. Usually a no-op.
*
* @param string $name The name of the parameter
* @param URLPATH $val The current value of the parameter (if blank, no-op)
* @param ?PATH $delete_on_error File path to delete if there's an error (null: none)
* @return string Altered $val
*/
function check_form_field_image(string $name, string $val, ?string $delete_on_error = null) : string
* Check form images based on fields.xml. Usually a no-op.
*
* @param string $name The name of the parameter
* @param URLPATH $val The current value of the parameter (if blank, no-op)
* @param ?PATH $delete_on_error File path to delete if there's an error (null: none)
* @return string Altered $val
*/
function check_form_field_image(string $name, string $val, ?string $delete_on_error = null) : string
