Document @return value for wp_unschedule_event().

See #33475.
Built from https://develop.svn.wordpress.org/trunk@34044


git-svn-id: http://core.svn.wordpress.org/trunk@34012 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov
2015-09-11 11:35:24 +00:00
parent f130fd6c32
commit d9b7d915c2
2 changed files with 2 additions and 1 deletions

View File

@@ -161,6 +161,7 @@ function wp_reschedule_event( $timestamp, $recurrence, $hook, $args = array() )
* Although not passed to a callback function, these arguments are used
* to uniquely identify the scheduled event, so they should be the same
* as those used when originally scheduling the event.
* @return false|void False when an event is not unscheduled.
*/
function wp_unschedule_event( $timestamp, $hook, $args = array() ) {
// Make sure timestamp is a positive integer