WordPress 4.7
[autoinstalls/wordpress.git] / wp-includes / revision.php
index 07a986c00318aab77ae03490d8bcb443af26a34c..c166fbf13199bf566709ee46b2153e88733d3671 100644 (file)
@@ -321,9 +321,10 @@ function _wp_put_post_revision( $post = null, $autosave = false ) {
  * @since 2.6.0
  *
  * @param int|WP_Post $post   The post ID or object.
- * @param string      $output Optional. OBJECT, ARRAY_A, or ARRAY_N.
+ * @param string      $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to
+ *                            a WP_Post object, an associative array, or a numeric array, respectively. Default OBJECT.
  * @param string      $filter Optional sanitation filter. See sanitize_post().
- * @return WP_Post|array|null Null if error or post object if success.
+ * @return WP_Post|array|null WP_Post (or array) on success, or null on failure.
  */
 function wp_get_post_revision(&$post, $output = OBJECT, $filter = 'raw') {
        if ( !$revision = get_post( $post, OBJECT, $filter ) )