ActionScheduler_ActionFactory::recurring( string $hook, array $args = array(), int $first = null, int $interval = null, string $group = '' )

Create the first instance of an action recurring on a given interval.

Contents

Description
- Parameters
- Return
- Source
Related
- Uses
User Contributed Notes

Description Description

Parameters Parameters

$hook

(Required) The hook to trigger when this action runs

$args

(Optional) Args to pass when the hook is triggered

Default value: array()

$first

(Optional) Unix timestamp for the first run

Default value: null

$interval

(Optional) Seconds between runs

Default value: null

$group

(Optional) A group to put the action in

Default value: ''

Return Return

(int) The ID of the stored action

Source Source

File: packages/action-scheduler/classes/ActionScheduler_ActionFactory.php

Expand full source code Collapse full source code

Uses Uses

Uses
Uses	Description
packages/action-scheduler/classes/ActionScheduler_ActionFactory.php: ActionScheduler_ActionFactory::single()
packages/action-scheduler/classes/ActionScheduler_ActionFactory.php: ActionScheduler_ActionFactory::store()
packages/action-scheduler/classes/actions/ActionScheduler_Action.php: ActionScheduler_Action::__construct()
packages/action-scheduler/functions.php: as_get_datetime_object()	Helper function to create an instance of DateTime based on a given string and timezone. By default, will return the current date/time in the UTC timezone.

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.