Function __global->get_schedule_code_event_time

Definitions

sources/calendar2.php

  • Get an array containing the time a scheduled event is set, or null if not scheduled.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$hook ID_TEXT No No required parameter N/A N/A Hook to run under systems/commandr_scheduled
$id string No No 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

Returns

  • Array of minute, hour, month, day, and year if the event is scheduled (null: not scheduled)
  • Type: ?array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get an array containing the time a scheduled event is set, or null if not scheduled.
 *
 * @param  ID_TEXT $hook Hook to run under systems/commandr_scheduled
 * @param  string $id Unspecified identifier for the resource behind this scheduled event, for future querying to find said event; also passed to the Commandr hook
 * @return ?array Array of minute, hour, month, day, and year if the event is scheduled (null: not scheduled)
 */

function get_schedule_code_event_time(string $hook, string $id) : ?array