Function __global->schedule_code
Definitions
sources/calendar2.php
- Create a calendar event containing a Commandr command to execute a scheduled task.
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: int
Parameters
Name | Type | Default | Set | Range | Description |
---|---|---|---|---|---|
$hook | ID_TEXT | required parameter | N/A | N/A | Hook to run under systems/commandr_scheduled |
$id | string | required parameter | N/A | N/A | Unspecified identifier for the resource behind this scheduled event, for future querying to find said event; also passed to the Commandr hook |
$parameters | array | required parameter | N/A | N/A | Array of parameters to pass through the Commandr command to the hook |
$title | string | required parameter | N/A | N/A | Title of the calendar event to create |
$start_year | integer | required parameter | N/A | N/A | Year which to execute the task |
$start_month | integer | required parameter | N/A | N/A | Month which to execute the task |
$start_day | integer | required parameter | N/A | N/A | Day of the month which to execute the task |
$start_hour | integer | required parameter | N/A | N/A | Hour of the day which to execute the task |
$start_minute | integer | required parameter | N/A | N/A | Minut of the hour which to execute the task |
Return
- The ID of the event that was created
- Type: AUTO_LINK
- Set: N/A
- Range: N/A