Changeset 34831

Timestamp:

10/05/2015 06:02:41 PM (10 years ago)

Author:

DrewAPicture

Message:

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.

File:

• trunk/src/wp-admin/includes/revision.php (modified) (1 diff)

trunk/src/wp-admin/includes/revision.php

@@ -217 +217 @@
          * @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.
          */