From 41f46d5e855ca9d0d58d04375db7bc1c54c44e25 Mon Sep 17 00:00:00 2001
From: Drew Jaynes <drewapicture@git.wordpress.org>
Date: Tue, 19 Nov 2013 05:00:39 +0000
Subject: [PATCH] Inline documentation for hooks in wp-includes/cron.php.

Props tmtoy for the initial patch.
Fixes #25475.


git-svn-id: https://develop.svn.wordpress.org/trunk@26267 602fd350-edb4-49c9-b593-d223f7449a82
---
 src/wp-includes/cron.php | 49 ++++++++++++++++++++++++++++++++++++----
 1 file changed, 44 insertions(+), 5 deletions(-)

diff --git a/src/wp-includes/cron.php b/src/wp-includes/cron.php
index 6668dc546e..4e9bbcd312 100644
--- a/src/wp-includes/cron.php
+++ b/src/wp-includes/cron.php
@@ -27,7 +27,14 @@ function wp_schedule_single_event( $timestamp, $hook, $args = array()) {
 
 	$crons = _get_cron_array();
 	$event = (object) array( 'hook' => $hook, 'timestamp' => $timestamp, 'schedule' => false, 'args' => $args );
-	$event = apply_filters('schedule_event', $event);
+	/**
+	 * Filter a single event before it is scheduled.
+	 *
+	 * @since 3.1.0
+	 *
+	 * @param object $event An object containing an event's data.
+	 */
+	$event = apply_filters( 'schedule_event', $event );
 
 	// A plugin disallowed this event
 	if ( ! $event )
@@ -68,7 +75,8 @@ function wp_schedule_event( $timestamp, $recurrence, $hook, $args = array()) {
 		return false;
 
 	$event = (object) array( 'hook' => $hook, 'timestamp' => $timestamp, 'schedule' => $recurrence, 'args' => $args, 'interval' => $schedules[$recurrence]['interval'] );
-	$event = apply_filters('schedule_event', $event);
+	/** This filter is documented in wp-includes/cron.php */
+	$event = apply_filters( 'schedule_event', $event );
 
 	// A plugin disallowed this event
 	if ( ! $event )
@@ -244,10 +252,34 @@ function spawn_cron( $gmt_time = 0 ) {
 	$doing_wp_cron = sprintf( '%.22F', $gmt_time );
 	set_transient( 'doing_cron', $doing_wp_cron );
 
+	/**
+	 * Filter the cron request arguments.
+	 *
+	 * @since 3.5.0
+	 *
+	 * @param array $cron_request_array {
+	 *     An array of cron request URL arguments.
+	 *
+	 *     @type string $url  The cron request URL.
+	 *     @type int    $key  The 22 digit GMT microtime.
+	 *     @type array  $args {
+	 *         An array of cron request arguments.
+	 *
+	 *         @type int  $timeout   The request timeout in seconds. Default .01 seconds.
+	 *         @type bool $blocking  Whether to set blocking for the request. Default false.
+	 *         @type bool $sslverify Whether to sslverify. Default true.
+	 *     }
+	 * }
+	 */
 	$cron_request = apply_filters( 'cron_request', array(
-		'url' => site_url( 'wp-cron.php?doing_wp_cron=' . $doing_wp_cron ),
-		'key' => $doing_wp_cron,
-		'args' => array( 'timeout' => 0.01, 'blocking' => false, 'sslverify' => apply_filters( 'https_local_ssl_verify', true ) )
+		'url'  => add_query_arg( array( 'doing_wp_cron', $doing_wp_cron ), site_url( 'wp-cron.php' ) ),
+		'key'  => $doing_wp_cron,
+		'args' => array(
+			'timeout'   => 0.01,
+			'blocking'  => false,
+			/** This filter is documented in wp-includes/class-http.php */
+			'sslverify' => apply_filters( 'https_local_ssl_verify', true )
+		)
 	) );
 
 	wp_remote_post( $cron_request['url'], $cron_request['args'] );
@@ -322,6 +354,13 @@ function wp_get_schedules() {
 		'twicedaily' => array( 'interval' => 12 * HOUR_IN_SECONDS, 'display' => __( 'Twice Daily' ) ),
 		'daily'      => array( 'interval' => DAY_IN_SECONDS,       'display' => __( 'Once Daily' ) ),
 	);
+	/**
+	 * Filter the non-default cron schedules.
+	 *
+	 * @since 2.1.0
+	 *
+	 * @param array $new_schedules An array of non-default cron schedules. Default empty.
+	 */
 	return array_merge( apply_filters( 'cron_schedules', array() ), $schedules );
 }