Skip to content

Docs: Clarify that cron event arguments must match when using wp_sche…#10890

Open
manishdhorepatil-art wants to merge 2 commits intoWordPress:trunkfrom
manishdhorepatil-art:43801
Open

Docs: Clarify that cron event arguments must match when using wp_sche…#10890
manishdhorepatil-art wants to merge 2 commits intoWordPress:trunkfrom
manishdhorepatil-art:43801

Conversation

@manishdhorepatil-art
Copy link

Summary

Improves inline documentation for wp_schedule_event() and wp_next_scheduled() to clarify that the $args parameter 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 cron option and database performance issues.

Solution

This patch enhances the DocBlocks for both functions to:

  • Clarify that event arguments must match exactly when checking or unscheduling events
  • Explain how mismatched arguments can lead to duplicate scheduled events
  • Add a usage example demonstrating correct and incorrect patterns

Notes

This is a documentation-only change. No functional behavior is modified.

Trac Ticket

https://core.trac.wordpress.org/ticket/43801

@github-actions
Copy link

github-actions bot commented Feb 9, 2026

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 props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props manishxdp.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@github-actions
Copy link

github-actions bot commented Feb 9, 2026

Test using WordPress Playground

The 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

  • The Plugin and Theme Directories cannot be accessed within Playground.
  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant