as_next_scheduled_action( string $hook, array $args = NULL, string $group = '' )

Check if there is an existing action in the queue with a given hook, args and group combination.

Contents

Description Description

An action in the queue could be pending, in-progress or async. If the is pending for a time in future, its scheduled date will be returned as a timestamp. If it is currently being run, or an async action sitting in the queue waiting to be processed, in which case boolean true will be returned. Or there may be no async, in-progress or pending action for this hook, in which case, boolean false will be the return value.

Parameters Parameters

$hook

(Required)

$args

(Optional)

Default value: NULL

$group

(Optional)

Default value: ''

Top ↑

Return Return

(int|bool) The timestamp for the next occurrence of a pending scheduled action, true for an async or in-progress action or false if there is no matching action.

Top ↑

Source Source

File: packages/action-scheduler/functions.php 


			

			

				
					Expand full source code
					Collapse full source code
				
				
			

			


	

	

		
Top ↑


					
		
					
			

				
Top ↑
Used By Used By

				

					Used By
					
						

							Used By
							Description
						

					
					
												

							
								packages/woocommerce-blocks/src/Domain/Services/DraftOrders.php:
								DraftOrders::maybe_create_cronjobs()
							
							
								
Maybe create cron events.

									
						

												

							
								packages/woocommerce-blocks/src/Domain/Services/DraftOrders.php:
								DraftOrders::maybe_remove_cronjobs()
							
							
								
Unschedule cron jobs that are present.

									
						

												

							
								includes/queue/class-wc-action-queue.php:
								WC_Action_Queue::get_next()
							
							
								
Get the date and time for the next scheduled occurence of an action with a given hook (an optionally that matches certain args and group), if any.

									
						

												

							
								packages/action-scheduler/classes/ActionScheduler_WPCommentCleaner.php:
								ActionScheduler_WPCommentCleaner::maybe_schedule_cleanup()
							
							
								
Schedules the WP Post comment table cleanup to run in 6 months if it’s not already scheduled.

									
						

												

							
								packages/action-scheduler/classes/ActionScheduler_WPCommentCleaner.php:
								ActionScheduler_WPCommentCleaner::print_admin_notice()
							
							
								
Prints details about the orphaned action logs and includes information on where to learn more.

									
						

												

							
								packages/action-scheduler/classes/migration/Scheduler.php:
								Scheduler::is_migration_scheduled()
							
							
								
Get a flag indicating whether the migration is scheduled.

									
						

												

							
								packages/action-scheduler/classes/migration/Scheduler.php:
								Scheduler::schedule_migration()
							
							
								
Schedule the migration.

									
						

												

							
								packages/action-scheduler/deprecated/functions.php:
								wc_next_scheduled_action()
							
							
															
						

											
				


								Show 3 more used by
				Hide more used by
							

			

		

	

		
Top ↑
User Contributed Notes User Contributed Notes

		



	
	
			

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