Fix the syntax for some status-related documentation introduced in [30155].

* Variables in DocBlocks should be backtick-escaped
* Parameter and return types should be as specific as possible
* `@param` types and variables should align with each other, but not intentionally with the `@return` description

See #30230.

Built from https://develop.svn.wordpress.org/trunk@30284


git-svn-id: http://core.svn.wordpress.org/trunk@30284 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2014-11-08 20:56:22 +00:00
parent 77e2821d54
commit 92c153aa8c
4 changed files with 6 additions and 7 deletions

View File

@ -1149,8 +1149,7 @@ function wp_ajax_add_meta() {
if ( isset($_POST['metakeyselect']) && '#NONE#' == $_POST['metakeyselect'] && empty($_POST['metakeyinput']) ) if ( isset($_POST['metakeyselect']) && '#NONE#' == $_POST['metakeyselect'] && empty($_POST['metakeyinput']) )
wp_die( 1 ); wp_die( 1 );
// If the post is an autodraft, save the post as a draft and then // If the post is an autodraft, save the post as a draft and then attempt to save the meta.
// attempt to save the meta.
if ( $post->post_status == 'auto-draft' ) { if ( $post->post_status == 'auto-draft' ) {
$save_POST = $_POST; // Backup $_POST $save_POST = $_POST; // Backup $_POST
$_POST = array(); // Make it empty for edit_post() $_POST = array(); // Make it empty for edit_post()

View File

@ -1069,7 +1069,7 @@ function get_post_status_object( $post_status ) {
* @see register_post_status() * @see register_post_status()
* *
* @param array|string $args Optional. Array or string of post status arguments to compare against * @param array|string $args Optional. Array or string of post status arguments to compare against
* properties of the global $wp_post_statuses objects. Default empty array. * properties of the global `$wp_post_statuses objects`. Default empty array.
* @param string $output Optional. The type of output to return, either 'names' or 'objects'. Default 'names'. * @param string $output Optional. The type of output to return, either 'names' or 'objects'. Default 'names'.
* @param string $operator Optional. The logical operation to perform. 'or' means only one element * @param string $operator Optional. The logical operation to perform. 'or' means only one element
* from the array needs to match; 'and' means all elements must match. * from the array needs to match; 'and' means all elements must match.

View File

@ -77,8 +77,8 @@ function _wp_post_revision_fields( $post = null, $autosave = false ) {
* *
* @since 2.6.0 * @since 2.6.0
* *
* @param int $post_id The ID of the post to save as a revision. * @param int $post_id The ID of the post to save as a revision.
* @return mixed Null or 0 if error, new revision ID, if success. * @return null|int Null or 0 if error, new revision ID, if success.
*/ */
function wp_save_post_revision( $post_id ) { function wp_save_post_revision( $post_id ) {
if ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE ) if ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE )
@ -455,7 +455,7 @@ function wp_revisions_enabled( $post ) {
* *
* @since 3.6.0 * @since 3.6.0
* *
* @param object $post The post object. * @param WP_Post $post The post object.
* @return int The number of revisions to keep. * @return int The number of revisions to keep.
*/ */
function wp_revisions_to_keep( $post ) { function wp_revisions_to_keep( $post ) {

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.1-alpha-30283'; $wp_version = '4.1-alpha-30284';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.