Changeset 28653

Timestamp:

06/03/2014 03:52:46 AM (11 years ago)

Author:

DrewAPicture

Message:

Make sure $post is properly documented as optional where applicable.

See #28388.

Location:

trunk/src

Files:

• wp-admin/includes/template.php (modified) (1 diff)
• wp-includes/media.php (modified) (4 diffs)
• wp-includes/post-template.php (modified) (2 diffs)
• wp-includes/taxonomy.php (modified) (2 diffs)

trunk/src/wp-admin/includes/template.php

@@ -1464 +1464 @@
  *
  * @since 2.7.0
- * @param mixed $post Post id or object. If not supplied the global $post is used.
- * @return string The post title if set
+ *
+ * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`.
+ * @return string The post title if set.
  */
 function _draft_or_post_title( $post = 0 ) {

trunk/src/wp-includes/media.php

@@ -2975 +2975 @@
  * @since 3.6.0
  *
- * @param string $type (Mime) type of media desired
- * @param mixed $post Post ID or object
- * @return array Found attachments
+ * @param string      $type Mime type.
+ * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`.
+ * @return array Found attachments.
  */
 function get_attached_media( $type, $post = 0 ) {
@@ -3101 +3101 @@
  * @since 3.6.0
  *
- * @param int|WP_Post $post Optional. Post ID or object.
+ * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`.
  * @param bool        $html Whether to return HTML or data.
  * @return string|array Gallery data and srcs parsed from the expanded shortcode.
@@ -3126 +3126 @@
  * @since 3.6.0
  *
- * @param mixed $post Optional. Post ID or object.
- * @return array A list of lists, each containing image srcs parsed
+ * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`.
+ * @return array A list of lists, each containing image srcs parsed.
  *      from an expanded shortcode
  */
@@ -3140 +3140 @@
  * @since 3.6.0
  *
- * @param mixed $post Optional. Post ID or object.
- * @return array A list of a gallery's image srcs in order
+ * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`.
+ * @return array A list of a gallery's image srcs in order.
  */
 function get_post_gallery_images( $post = 0 ) {

trunk/src/wp-includes/post-template.php

@@ -105 +105 @@
  * @since 0.71
  *
- * @param int|WP_Post $post Optional. Post ID or post object.
+ * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`.
  * @return string
  */
@@ -1546 +1546 @@
  *
  * @since 1.0.0
- * @uses apply_filters() Calls 'the_password_form' filter on output.
- * @param int|WP_Post $post Optional. A post ID or post object.
+ *
+ * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`.
  * @return string HTML content for password form for password protected post.
  */

trunk/src/wp-includes/taxonomy.php

@@ -3767 +3767 @@
  * @since 2.5.0
  *
- * @param int|WP_Post $post Optional. Post ID or post object.
+ * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`.
  * @param array $args Override the defaults.
- * @return array
+ * @return array List of taxonomies.
  */
 function get_the_taxonomies( $post = 0, $args = array() ) {
@@ -3816 +3816 @@
  *
  * @since 2.5.0
+ *
  * @uses get_object_taxonomies()
  *
- * @param int|WP_Post $post Optional. Post ID or post object.
+ * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`.
  * @return array
  */
-function get_post_taxonomies($post = 0) {
+function get_post_taxonomies( $post = 0 ) {
     $post = get_post( $post );