From d95423c0918a81c4885ef25e97e9fdb16e167ee9 Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Mon, 5 Oct 2015 18:02:41 +0000 Subject: [PATCH] Docs: Document the `$revision_data` parameter passed to the `wp_prepare_revision_for_js` filter with a hash notation. The hook was introduced in [34541]. See #28627. git-svn-id: https://develop.svn.wordpress.org/trunk@34831 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-admin/includes/revision.php | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/src/wp-admin/includes/revision.php b/src/wp-admin/includes/revision.php index 756a1dd500..db6ea9b570 100644 --- a/src/wp-admin/includes/revision.php +++ b/src/wp-admin/includes/revision.php @@ -216,7 +216,20 @@ function wp_prepare_revisions_for_js( $post, $selected_revision_id, $from = null * * @since 4.4.0 * - * @param array $revisions_data The bootstrapped data for the revisions screen. + * @param array $revisions_data { + * The bootstrapped data for the revisions screen. + * + * @type int $id Revision ID. + * @type string $title Title for the revision's parent WP_Post object. + * @type int $author Revision post author ID. + * @type string $date Date the revision was modified. + * @type string $dateShort Short-form version of the date the revision was modified. + * @type string $timeAgo GMT-aware amount of time ago the revision was modified. + * @type bool $autosave Whether the revision is an autosave. + * @type bool $current Whether the revision is both not an autosave and the post + * modified date matches the revision modified date (GMT-aware). + * @type bool|false $restoreUrl URL if the revision can be restored, false otherwise. + * } * @param WP_Post $post The revision's parent WP_Post object. */ $revisions[ $revision->ID ] = apply_filters( 'wp_prepare_revision_for_js', $revisions_data, $post );