WordPress.org

Make WordPress Core

Changeset 24722


Ignore:
Timestamp:
07/17/13 20:39:35 (9 months ago)
Author:
nacin
Message:

Inline docs for admin/includes/revision.php. props DrewAPicture, fixes #24742.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/wp-admin/includes/revision.php

    r24708 r24722  
    11<?php 
     2/** 
     3 * WordPress Administration Revisions API. 
     4 * 
     5 * @package WordPress 
     6 * @subpackage Administration 
     7 */ 
    28 
     9/** 
     10 * Get the revision UI diff. 
     11 * 
     12 * @param object $post The post object. 
     13 * @param int $compare_from The revision id to compare from. 
     14 * @param int $compare_to The revision id to come to. 
     15 * 
     16 * @return array|bool Associative array of a post's revisioned fields and their diffs. 
     17 *  Or, false on failure. 
     18 */ 
    319function wp_get_revision_ui_diff( $post, $compare_from, $compare_to ) { 
    420    if ( ! $post = get_post( $post ) ) 
     
    6278} 
    6379 
     80/** 
     81 * Prepare revisions for JavaScript. 
     82 * 
     83 * @param object $post The post object. 
     84 * @param int $selected_revision_id The selected revision id. 
     85 * @param int $from (optional) The revision id to compare from. 
     86 * 
     87 * @return array An associative array of revision daIta and related settings. 
     88 */ 
    6489function wp_prepare_revisions_for_js( $post, $selected_revision_id, $from = null ) { 
    6590    $post = get_post( $post ); 
Note: See TracChangeset for help on using the changeset viewer.