Docs: Clarify that cron event arguments must match when using wp_sche…#10890
Docs: Clarify that cron event arguments must match when using wp_sche…#10890manishdhorepatil-art wants to merge 2 commits intoWordPress:trunkfrom
Conversation
…dule_event() and wp_next_scheduled()
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the Core Committers: Use this line as a base for the props when committing in SVN: To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
Test using WordPress PlaygroundThe changes in this pull request can previewed and tested using a WordPress Playground instance. WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser. Some things to be aware of
For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation. |
Summary
Improves inline documentation for
wp_schedule_event()andwp_next_scheduled()to clarify that the$argsparameter is part of the unique identifier for scheduled cron events.Problem
If developers schedule an event with arguments but later check for existing events without passing the same arguments, WordPress treats them as different events. This can result in duplicate cron entries being created on every page load, potentially causing excessive growth of the
cronoption and database performance issues.Solution
This patch enhances the DocBlocks for both functions to:
Notes
This is a documentation-only change. No functional behavior is modified.
Trac Ticket
https://core.trac.wordpress.org/ticket/43801