mirror of
https://github.com/WordPress/WordPress.git
synced 2024-12-22 09:07:59 +01:00
Docs: Various docblock fixes in wp-includes/revision.php
, as per documentation standards.
See #55646. Built from https://develop.svn.wordpress.org/trunk@54347 git-svn-id: http://core.svn.wordpress.org/trunk@53906 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
parent
2a81bee262
commit
525c52c873
@ -220,7 +220,7 @@ function wp_save_post_revision( $post_id ) {
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve the autosaved data of the specified post.
|
||||
* Retrieves the autosaved data of the specified post.
|
||||
*
|
||||
* Returns a post object with the information that was autosaved for the specified post.
|
||||
* If the optional $user_id is passed, returns the autosave for that user, otherwise
|
||||
@ -231,7 +231,7 @@ function wp_save_post_revision( $post_id ) {
|
||||
* @global wpdb $wpdb WordPress database abstraction object.
|
||||
*
|
||||
* @param int $post_id The post ID.
|
||||
* @param int $user_id Optional The post author ID.
|
||||
* @param int $user_id Optional. The post author ID.
|
||||
* @return WP_Post|false The autosaved data or false on failure or when no autosave exists.
|
||||
*/
|
||||
function wp_get_post_autosave( $post_id, $user_id = 0 ) {
|
||||
@ -313,7 +313,7 @@ function wp_is_post_autosave( $post ) {
|
||||
* @access private
|
||||
*
|
||||
* @param int|WP_Post|array|null $post Post ID, post object OR post array.
|
||||
* @param bool $autosave Optional. Is the revision an autosave?
|
||||
* @param bool $autosave Optional. Whether the revision is an autosave or not.
|
||||
* @return int|WP_Error WP_Error or 0 if error, new revision ID if success.
|
||||
*/
|
||||
function _wp_put_post_revision( $post = null, $autosave = false ) {
|
||||
@ -362,7 +362,7 @@ function _wp_put_post_revision( $post = null, $autosave = false ) {
|
||||
* @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().
|
||||
* @param string $filter Optional sanitization filter. See sanitize_post().
|
||||
* @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' ) {
|
||||
@ -613,7 +613,7 @@ function wp_get_post_revisions_url( $post = 0 ) {
|
||||
}
|
||||
|
||||
/**
|
||||
* Determine if revisions are enabled for a given post.
|
||||
* Determines whether revisions are enabled for a given post.
|
||||
*
|
||||
* @since 3.6.0
|
||||
*
|
||||
@ -625,7 +625,7 @@ function wp_revisions_enabled( $post ) {
|
||||
}
|
||||
|
||||
/**
|
||||
* Determine how many revisions to retain for a given post.
|
||||
* Determines how many revisions to retain for a given post.
|
||||
*
|
||||
* By default, an infinite number of revisions are kept.
|
||||
*
|
||||
@ -830,16 +830,16 @@ function _wp_get_post_revision_version( $revision ) {
|
||||
}
|
||||
|
||||
/**
|
||||
* Upgrade the revisions author, add the current post as a revision and set the revisions version to 1
|
||||
* Upgrades the revisions author, adds the current post as a revision and sets the revisions version to 1.
|
||||
*
|
||||
* @since 3.6.0
|
||||
* @access private
|
||||
*
|
||||
* @global wpdb $wpdb WordPress database abstraction object.
|
||||
*
|
||||
* @param WP_Post $post Post object
|
||||
* @param array $revisions Current revisions of the post
|
||||
* @return bool true if the revisions were upgraded, false if problems
|
||||
* @param WP_Post $post Post object.
|
||||
* @param array $revisions Current revisions of the post.
|
||||
* @return bool true if the revisions were upgraded, false if problems.
|
||||
*/
|
||||
function _wp_upgrade_revisions_of_post( $post, $revisions ) {
|
||||
global $wpdb;
|
||||
|
@ -16,7 +16,7 @@
|
||||
*
|
||||
* @global string $wp_version
|
||||
*/
|
||||
$wp_version = '6.1-beta2-54346';
|
||||
$wp_version = '6.1-beta2-54347';
|
||||
|
||||
/**
|
||||
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.
|
||||
|
Loading…
Reference in New Issue
Block a user