ActionScheduler_WPCLI_Scheduler_command::run( array $args, array $assoc_args )

Run the Action Scheduler

Contents

Description Description

Top ↑

OPTIONS OPTIONS

[–batch-size=] : The maximum number of actions to run. Defaults to 100.

[–batches=] : Limit execution to a number of batches. Defaults to 0, meaning batches will continue being executed until all actions are complete.

[–cleanup-batch-size=] : The maximum number of actions to clean up. Defaults to the value of –batch-size.

[–hooks=] : Only run actions with the specified hook. Omitting this option runs actions with any hook. Define multiple hooks as a comma separated string (without spaces), e.g. --hooks=hook_one,hook_two,hook_three

[–group=] : Only run actions from the specified group. Omitting this option runs actions from all groups.

[–free-memory-on=] : The number of actions to process between freeing memory. 0 disables freeing memory. Default 50.

[–pause=] : The number of seconds to pause when freeing memory. Default no pause.

[–force] : Whether to force execution despite the maximum number of concurrent processes being exceeded.

Parameters Parameters

$args

(Required) Positional arguments.

$assoc_args

(Required) Keyed arguments.

Top ↑

Source Source

File: packages/action-scheduler/classes/WP_CLI/ActionScheduler_WPCLI_Scheduler_command.php 


			

			

				
					Expand full source code
					Collapse full source code
				
				
			

			


	

	

		
Top ↑


					

				
Top ↑
Uses Uses

				

					Uses
					
						

							Uses
							Description
						

					
					
												

							
								packages/action-scheduler/classes/WP_CLI/ActionScheduler_WPCLI_QueueRunner.php:
								ActionScheduler_WPCLI_QueueRunner::__construct()
							
							
								
ActionScheduler_WPCLI_QueueRunner constructor.

									
						

												

							
								packages/action-scheduler/classes/WP_CLI/ActionScheduler_WPCLI_Scheduler_command.php:
								ActionScheduler_WPCLI_Scheduler_command::print_total_actions()
							
							
								
Print WP CLI message about how many actions are about to be processed.

									
						

												

							
								packages/action-scheduler/classes/WP_CLI/ActionScheduler_WPCLI_Scheduler_command.php:
								ActionScheduler_WPCLI_Scheduler_command::print_error()
							
							
								
Convert an exception into a WP CLI error.

									
						

												

							
								packages/action-scheduler/classes/WP_CLI/ActionScheduler_WPCLI_Scheduler_command.php:
								ActionScheduler_WPCLI_Scheduler_command::print_total_batches()
							
							
								
Print WP CLI message about how many batches of actions were processed.

									
						

												

							
								packages/action-scheduler/classes/WP_CLI/ActionScheduler_WPCLI_Scheduler_command.php:
								ActionScheduler_WPCLI_Scheduler_command::print_success()
							
							
								
Print a success message with the number of completed actions.

									
						

												

							
								packages/action-scheduler/classes/ActionScheduler_DataController.php:
								ActionScheduler_DataController::set_free_ticks()
							
							
								
Set the tick count required for freeing memory.

									
						

												

							
								packages/action-scheduler/classes/ActionScheduler_DataController.php:
								ActionScheduler_DataController::set_sleep_time()
							
							
								
Set the sleep time in seconds.

									
						

												

							
								packages/action-scheduler/classes/ActionScheduler_QueueCleaner.php:
								ActionScheduler_QueueCleaner::__construct()
							
							
								
ActionScheduler_QueueCleaner constructor.

									
						

											
				


								Show 3 more uses
				Hide more uses
							

		
			

		

	

		
Top ↑
User Contributed Notes User Contributed Notes

		



	
	
			

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