classes
2 years ago
deprecated
3 years ago
lib
3 years ago
action-scheduler.php
2 years ago
changelog.txt
2 years ago
functions.php
2 years ago
license.txt
3 years ago
readme.txt
2 years ago
readme.txt
178 lines
| 1 | === Action Scheduler === |
| 2 | Contributors: Automattic, wpmuguru, claudiosanches, peterfabian1000, vedjain, jamosova, obliviousharmony, konamiman, sadowski, royho, barryhughes-1 |
| 3 | Tags: scheduler, cron |
| 4 | Stable tag: 3.7.0 |
| 5 | License: GPLv3 |
| 6 | Tested up to: 6.4 |
| 7 | |
| 8 | Action Scheduler - Job Queue for WordPress |
| 9 | |
| 10 | == Description == |
| 11 | |
| 12 | Action Scheduler is a scalable, traceable job queue for background processing large sets of actions in WordPress. It's specially designed to be distributed in WordPress plugins. |
| 13 | |
| 14 | Action Scheduler works by triggering an action hook to run at some time in the future. Each hook can be scheduled with unique data, to allow callbacks to perform operations on that data. The hook can also be scheduled to run on one or more occassions. |
| 15 | |
| 16 | Think of it like an extension to `do_action()` which adds the ability to delay and repeat a hook. |
| 17 | |
| 18 | ## Battle-Tested Background Processing |
| 19 | |
| 20 | Every month, Action Scheduler processes millions of payments for [Subscriptions](https://woocommerce.com/products/woocommerce-subscriptions/), webhooks for [WooCommerce](https://wordpress.org/plugins/woocommerce/), as well as emails and other events for a range of other plugins. |
| 21 | |
| 22 | It's been seen on live sites processing queues in excess of 50,000 jobs and doing resource intensive operations, like processing payments and creating orders, at a sustained rate of over 10,000 / hour without negatively impacting normal site operations. |
| 23 | |
| 24 | This is all on infrastructure and WordPress sites outside the control of the plugin author. |
| 25 | |
| 26 | If your plugin needs background processing, especially of large sets of tasks, Action Scheduler can help. |
| 27 | |
| 28 | ## Learn More |
| 29 | |
| 30 | To learn more about how to Action Scheduler works, and how to use it in your plugin, check out the docs on [ActionScheduler.org](https://actionscheduler.org). |
| 31 | |
| 32 | There you will find: |
| 33 | |
| 34 | * [Usage guide](https://actionscheduler.org/usage/): instructions on installing and using Action Scheduler |
| 35 | * [WP CLI guide](https://actionscheduler.org/wp-cli/): instructions on running Action Scheduler at scale via WP CLI |
| 36 | * [API Reference](https://actionscheduler.org/api/): complete reference guide for all API functions |
| 37 | * [Administration Guide](https://actionscheduler.org/admin/): guide to managing scheduled actions via the administration screen |
| 38 | * [Guide to Background Processing at Scale](https://actionscheduler.org/perf/): instructions for running Action Scheduler at scale via the default WP Cron queue runner |
| 39 | |
| 40 | ## Credits |
| 41 | |
| 42 | Action Scheduler is developed and maintained by [Automattic](http://automattic.com/) with significant early development completed by [Flightless](https://flightless.us/). |
| 43 | |
| 44 | Collaboration is cool. We'd love to work with you to improve Action Scheduler. [Pull Requests](https://github.com/woocommerce/action-scheduler/pulls) welcome. |
| 45 | |
| 46 | == Changelog == |
| 47 | |
| 48 | = 3.7.0 - 2023-11-20 = |
| 49 | * Add extended indexes for hook_status_scheduled_date_gmt and status_sheduled_date_gmt. |
| 50 | * Catch and log exceptions thrown when actions can't be created, e.g. under a corrupt database schema. |
| 51 | * Release/3.6.4. |
| 52 | * Tweak - WP 6.4 compatibility. |
| 53 | * Update unit tests for upcoming dependency version policy. |
| 54 | * make sure hook action_scheduler_failed_execution can access original exception object. |
| 55 | * mention dependency version policy in usage.md. |
| 56 | |
| 57 | = 3.6.4 - 2023-10-11 = |
| 58 | * Performance improvements when bulk cancelling actions. |
| 59 | * Dev-related fixes. |
| 60 | |
| 61 | = 3.6.3 - 2023-09-13 = |
| 62 | * Use `_doing_it_wrong` in initialization check. |
| 63 | |
| 64 | = 3.6.2 - 2023-08-09 = |
| 65 | * Add guidance about passing arguments. |
| 66 | * Atomic option locking. |
| 67 | * Improve bulk delete handling. |
| 68 | * Include database error in the exception message. |
| 69 | * Tweak - WP 6.3 compatibility. |
| 70 | |
| 71 | = 3.6.1 - 2023-06-14 = |
| 72 | * Document new optional `$priority` arg for various API functions. |
| 73 | * Document the new `--exclude-groups` WP CLI option. |
| 74 | * Document the new `action_scheduler_init` hook. |
| 75 | * Ensure actions within each claim are executed in the expected order. |
| 76 | * Fix incorrect text domain. |
| 77 | * Remove SHOW TABLES usage when checking if tables exist. |
| 78 | |
| 79 | = 3.6.0 - 2023-05-10 = |
| 80 | * Add $unique parameter to function signatures. |
| 81 | * Add a cast-to-int for extra safety before forming new DateTime object. |
| 82 | * Add a hook allowing exceptions for consistently failing recurring actions. |
| 83 | * Add action priorities. |
| 84 | * Add init hook. |
| 85 | * Always raise the time limit. |
| 86 | * Bump minimatch from 3.0.4 to 3.0.8. |
| 87 | * Bump yaml from 2.2.1 to 2.2.2. |
| 88 | * Defensive coding relating to gaps in declared schedule types. |
| 89 | * Do not process an action if it cannot be set to `in-progress`. |
| 90 | * Filter view labels (status names) should be translatable | #919. |
| 91 | * Fix WPCLI progress messages. |
| 92 | * Improve data-store initialization flow. |
| 93 | * Improve error handling across all supported PHP versions. |
| 94 | * Improve logic for flushing the runtime cache. |
| 95 | * Support exclusion of multiple groups. |
| 96 | * Update lint-staged and Node/NPM requirements. |
| 97 | * add CLI clean command. |
| 98 | * add CLI exclude-group filter. |
| 99 | * exclude past-due from list table all filter count. |
| 100 | * throwing an exception if as_schedule_recurring_action interval param is not of type integer. |
| 101 | |
| 102 | = 3.5.4 - 2023-01-17 = |
| 103 | * Add pre filters during action registration. |
| 104 | * Async scheduling. |
| 105 | * Calculate timeouts based on total actions. |
| 106 | * Correctly order the parameters for `ActionScheduler_ActionFactory`'s calls to `single_unique`. |
| 107 | * Fetch action in memory first before releasing claim to avoid deadlock. |
| 108 | * PHP 8.2: declare property to fix creation of dynamic property warning. |
| 109 | * PHP 8.2: fix "Using ${var} in strings is deprecated, use {$var} instead". |
| 110 | * Prevent `undefined variable` warning for `$num_pastdue_actions`. |
| 111 | |
| 112 | = 3.5.3 - 2022-11-09 = |
| 113 | * Query actions with partial match. |
| 114 | |
| 115 | = 3.5.2 - 2022-09-16 = |
| 116 | * Fix - erroneous 3.5.1 release. |
| 117 | |
| 118 | = 3.5.1 - 2022-09-13 = |
| 119 | * Maintenance on A/S docs. |
| 120 | * fix: PHP 8.2 deprecated notice. |
| 121 | |
| 122 | = 3.5.0 - 2022-08-25 = |
| 123 | * Add - The active view link within the "Tools > Scheduled Actions" screen is now clickable. |
| 124 | * Add - A warning when there are past-due actions. |
| 125 | * Enhancement - Added the ability to schedule unique actions via an atomic operation. |
| 126 | * Enhancement - Improvements to cache invalidation when processing batches (when running on WordPress 6.0+). |
| 127 | * Enhancement - If a recurring action is found to be consistently failing, it will stop being rescheduled. |
| 128 | * Enhancement - Adds a new "Past Due" view to the scheduled actions list table. |
| 129 | |
| 130 | = 3.4.2 - 2022-06-08 = |
| 131 | * Fix - Change the include for better linting. |
| 132 | * Fix - update: Added Action scheduler completed action hook. |
| 133 | |
| 134 | = 3.4.1 - 2022-05-24 = |
| 135 | * Fix - Change the include for better linting. |
| 136 | * Fix - Fix the documented return type. |
| 137 | |
| 138 | = 3.4.0 - 2021-10-29 = |
| 139 | * Enhancement - Number of items per page can now be set for the Scheduled Actions view (props @ovidiul). #771 |
| 140 | * Fix - Do not lower the max_execution_time if it is already set to 0 (unlimited) (props @barryhughes). #755 |
| 141 | * Fix - Avoid triggering autoloaders during the version resolution process (props @olegabr). #731 & #776 |
| 142 | * Dev - ActionScheduler_wcSystemStatus PHPCS fixes (props @ovidiul). #761 |
| 143 | * Dev - ActionScheduler_DBLogger.php PHPCS fixes (props @ovidiul). #768 |
| 144 | * Dev - Fixed phpcs for ActionScheduler_Schedule_Deprecated (props @ovidiul). #762 |
| 145 | * Dev - Improve actions table indicies (props @glagonikas). #774 & #777 |
| 146 | * Dev - PHPCS fixes for ActionScheduler_DBStore.php (props @ovidiul). #769 & #778 |
| 147 | * Dev - PHPCS Fixes for ActionScheduler_Abstract_ListTable (props @ovidiul). #763 & #779 |
| 148 | * Dev - Adds new filter action_scheduler_claim_actions_order_by to allow tuning of the claim query (props @glagonikas). #773 |
| 149 | * Dev - PHPCS fixes for ActionScheduler_WpPostStore class (props @ovidiul). #780 |
| 150 | |
| 151 | = 3.3.0 - 2021-09-15 = |
| 152 | * Enhancement - Adds as_has_scheduled_action() to provide a performant way to test for existing actions. #645 |
| 153 | * Fix - Improves compatibility with environments where NO_ZERO_DATE is enabled. #519 |
| 154 | * Fix - Adds safety checks to guard against errors when our database tables cannot be created. #645 |
| 155 | * Dev - Now supports queries that use multiple statuses. #649 |
| 156 | * Dev - Minimum requirements for WordPress and PHP bumped (to 5.2 and 5.6 respectively). #723 |
| 157 | |
| 158 | = 3.2.1 - 2021-06-21 = |
| 159 | * Fix - Add extra safety/account for different versions of AS and different loading patterns. #714 |
| 160 | * Fix - Handle hidden columns (Tools → Scheduled Actions) | #600. |
| 161 | |
| 162 | = 3.2.0 - 2021-06-03 = |
| 163 | * Fix - Add "no ordering" option to as_next_scheduled_action(). |
| 164 | * Fix - Add secondary scheduled date checks when claiming actions (DBStore) | #634. |
| 165 | * Fix - Add secondary scheduled date checks when claiming actions (wpPostStore) | #634. |
| 166 | * Fix - Adds a new index to the action table, reducing the potential for deadlocks (props: @glagonikas). |
| 167 | * Fix - Fix unit tests infrastructure and adapt tests to PHP 8. |
| 168 | * Fix - Identify in-use data store. |
| 169 | * Fix - Improve test_migration_is_scheduled. |
| 170 | * Fix - PHP notice on list table. |
| 171 | * Fix - Speed up clean up and batch selects. |
| 172 | * Fix - Update pending dependencies. |
| 173 | * Fix - [PHP 8.0] Only pass action arg values through to do_action_ref_array(). |
| 174 | * Fix - [PHP 8] Set the PHP version to 7.1 in composer.json for PHP 8 compatibility. |
| 175 | * Fix - add is_initialized() to docs. |
| 176 | * Fix - fix file permissions. |
| 177 | * Fix - fixes #664 by replacing __ with esc_html__. |
| 178 |