sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Inline documentation fixes and additions for wp-admin/revision.php and wp-admin/includes/revision.php.

Browse Source 
props adamsilverstein.
see #25283.

git-svn-id: https://develop.svn.wordpress.org/trunk@25419 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2013-09-12 22:58:45 +00:00
parent 9e8bcc8bcd
commit 529c973323
2 changed files with 18 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/wp-admin/includes/revision.php
View File

@ -1,6 +1,6 @@
<?php <?php
/** /**
* WordPress Administration Revisions API. * WordPress Administration Revisions API
* *
* @package WordPress * @package WordPress
* @subpackage Administration * @subpackage Administration
@ -11,12 +11,12 @@
* *
* @since 3.6.0 * @since 3.6.0
* *
* @param object $post The post object. * @param object|int $post The post object. Also accepts a post ID.
* @param int $compare_from The revision id to compare from. * @param int $compare_from The revision ID to compare from.
* @param int $compare_to The revision id to come to. * @param int $compare_to The revision ID to come to.
* *
* @return array|bool Associative array of a post's revisioned fields and their diffs. * @return array|bool Associative array of a post's revisioned fields and their diffs.
* Or, false on failure. * Or, false on failure.
*/ */
function wp_get_revision_ui_diff( $post, $compare_from, $compare_to ) { function wp_get_revision_ui_diff( $post, $compare_from, $compare_to ) {
if ( ! $post = get_post( $post ) ) if ( ! $post = get_post( $post ) )
@ -85,9 +85,9 @@ function wp_get_revision_ui_diff( $post, $compare_from, $compare_to ) {
* *
* @since 3.6.0 * @since 3.6.0
* *
* @param object $post The post object. * @param object|int $post The post object. Also accepts a post ID.
* @param int $selected_revision_id The selected revision id. * @param int $selected_revision_id The selected revision ID.
* @param int $from (optional) The revision id to compare from. * @param int $from Optional. The revision ID to compare from.
* *
* @return array An associative array of revision data and related settings. * @return array An associative array of revision data and related settings.
*/ */

11
src/wp-admin/revision.php
View File

@ -1,9 +1,18 @@
<?php <?php
/** /**
* Revisions administration panel. * Revisions administration panel
*
* Requires wp-admin/includes/revision.php.
* *
* @package WordPress * @package WordPress
* @subpackage Administration * @subpackage Administration
* @since 2.6.0
*
* @param int revision Optional. The revision ID.
* @param string action The action to take.
* Accepts 'restore', 'view' or 'edit'.
* @param int from The revision to compare from.
* @param int to Optional, required if revision missing. The revision to compare to.
*/ */
/** WordPress Administration Bootstrap */ /** WordPress Administration Bootstrap */