ActionScheduler_ActionFactory::cron( string $hook, array $args = array(), int $base_timestamp = null, int $schedule = null, string $group = '' )

Create the first instance of an action recurring on a Cron schedule.

Contents

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()

$base_timestamp

(Optional) The first instance of the action will be scheduled to run at a time calculated after this timestamp matching the cron expression. This can be used to delay the first instance of the action.

Default value: null

$schedule

(Optional) A cron definition string

Default value: null

$group

(Optional) A group to put the action in

Default value: ''

Top ↑

Return Return

(int) The ID of the stored action

Top ↑

Source Source

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


			

			

				
					Expand full source code
					Collapse full source code
				
				
			

			


	

	

		
Top ↑


					

				
Top ↑
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/schedules/ActionScheduler_CronSchedule.php:
								ActionScheduler_CronSchedule::__construct()
							
							
								
Wrapper for parent constructor to accept a cron expression string and map it to a CronExpression for this objects $recurrence property.

									
						

												

							
								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.

									
						

												

							
								packages/action-scheduler/lib/cron-expression/CronExpression.php:
								CronExpression::factory()
							
							
								
Factory method to create a new CronExpression.

									
						

											
				


								Show 1 more use
				Hide more uses
							

		
			

		

	

		
Top ↑
User Contributed Notes User Contributed Notes

		



	
	
			

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