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

Improve the @param docs for src/wp-includes/post*.php.

Browse Source 
See #30224.


git-svn-id: https://develop.svn.wordpress.org/trunk@30671 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Scott Taylor 2014-11-30 22:37:00 +00:00
parent 3c558b7436
commit 4de850c8ff
2 changed files with 22 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/wp-includes/post-template.php
View File

@ -229,7 +229,7 @@ function the_content( $more_link_text = null, $strip_teaser = false) {
* @since 0.71 * @since 0.71
* *
* @param string $more_link_text Optional. Content for when there is more text. * @param string $more_link_text Optional. Content for when there is more text.
* @param bool $stripteaser Optional. Strip teaser content before the more text. Default is false. * @param bool $strip_teaser Optional. Strip teaser content before the more text. Default is false.
* @return string * @return string
*/ */
function get_the_content( $more_link_text = null, $strip_teaser = false ) { function get_the_content( $more_link_text = null, $strip_teaser = false ) {

15
src/wp-includes/post.php
View File

@ -839,7 +839,7 @@ function get_post_field( $field, $post, $context = 'display' ) {
* @since 2.0.0 * @since 2.0.0
* *
* @param int|WP_Post $ID Optional. Post ID or post object. Default empty. * @param int|WP_Post $ID Optional. Post ID or post object. Default empty.
* @return string|bool The mime type on success, false on failure. * @return string|false The mime type on success, false on failure.
*/ */
function get_post_mime_type( $ID = '' ) { function get_post_mime_type( $ID = '' ) {
$post = get_post($ID); $post = get_post($ID);
@ -859,7 +859,7 @@ function get_post_mime_type( $ID = '' ) {
* @since 2.0.0 * @since 2.0.0
* *
* @param int|WP_Post $ID Optional. Post ID or post object. Default empty. * @param int|WP_Post $ID Optional. Post ID or post object. Default empty.
* @return string|bool Post status on success, false on failure. * @return string|false Post status on success, false on failure.
*/ */
function get_post_status( $ID = '' ) { function get_post_status( $ID = '' ) {
$post = get_post($ID); $post = get_post($ID);
@ -1124,7 +1124,7 @@ function post_type_exists( $post_type ) {
* @since 2.1.0 * @since 2.1.0
* *
* @param int|WP_Post $post Optional. Post ID or post object. Default is global $post. * @param int|WP_Post $post Optional. Post ID or post object. Default is global $post.
* @return string|bool Post type on success, false on failure. * @return string|false Post type on success, false on failure.
*/ */
function get_post_type( $post = null ) { function get_post_type( $post = null ) {
if ( $post = get_post( $post ) ) if ( $post = get_post( $post ) )
@ -2856,7 +2856,7 @@ function wp_trash_post_comments( $post = null ) {
* @since 2.9.0 * @since 2.9.0
* *
* @param int|WP_Post $post Optional. Post ID or post object. Defaults to global $post. * @param int|WP_Post $post Optional. Post ID or post object. Defaults to global $post.
* @return mixed False on failure. * @return null|bool Null on failure.
*/ */
function wp_untrash_post_comments( $post = null ) { function wp_untrash_post_comments( $post = null ) {
global $wpdb; global $wpdb;
@ -2984,7 +2984,6 @@ function wp_get_post_terms( $post_id = 0, $taxonomy = 'post_tag', $args = array(
* *
* @see get_posts() * @see get_posts()
* *
* @param string $deprecated Not used.
* @param array $args Optional. Arguments to retrieve posts. Default empty array. * @param array $args Optional. Arguments to retrieve posts. Default empty array.
* @param string $output Optional. Type of output. Accepts ARRAY_A or ''. Default ARRAY_A. * @param string $output Optional. Type of output. Accepts ARRAY_A or ''. Default ARRAY_A.
* @return array|bool Associative array if $output equals ARRAY_A, array or false if no results. * @return array|bool Associative array if $output equals ARRAY_A, array or false if no results.
@ -3918,7 +3917,7 @@ function wp_set_post_categories( $post_ID = 0, $post_categories = array(), $appe
* *
* @param string $new_status Transition to this post status. * @param string $new_status Transition to this post status.
* @param string $old_status Previous post status. * @param string $old_status Previous post status.
* @param object $post Post data. * @param WP_Post $post Post data.
*/ */
function wp_transition_post_status( $new_status, $old_status, $post ) { function wp_transition_post_status( $new_status, $old_status, $post ) {
/** /**
@ -5702,7 +5701,7 @@ function _publish_post_hook( $post_id ) {
* *
* @since 3.1.0 * @since 3.1.0
* *
* @param int $post_id * @param int $post_ID
* *
* @return int|bool Post parent ID, otherwise false. * @return int|bool Post parent ID, otherwise false.
*/ */
@ -5838,7 +5837,7 @@ function _update_term_count_on_transition_post_status( $new_status, $old_status,
* *
* @see update_post_caches() * @see update_post_caches()
* *
* @param array $post_ids ID list * @param array $ids ID list
* @param bool $update_term_cache Optional. Whether to update the term cache. Default true. * @param bool $update_term_cache Optional. Whether to update the term cache. Default true.
* @param bool $update_meta_cache Optional. Whether to update the meta cache. Default true. * @param bool $update_meta_cache Optional. Whether to update the meta cache. Default true.
*/ */