Changeset 32616

Timestamp:

05/27/2015 04:05:33 PM (10 years ago)

Author:

wonderboymusic

Message:

Add missing doc blocks to post-formats.php.
Correct some types for @param and @return.

See #32444.

File:

• trunk/src/wp-includes/post-formats.php (modified) (9 diffs)

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

@@ -12 +12 @@
  * @since 3.1.0
  *
- * @param int|object $post Post ID or post object. Optional, default is the current post from the loop.
- * @return mixed The format if successful. False otherwise.
+ * @param int|object|null $post Post ID or post object. Optional, default is the current post from the loop.
+ * @return string|false The format if successful. False otherwise.
  */
 function get_post_format( $post = null ) {
@@ -37 +37 @@
  * @since 3.1.0
  *
- * @param string|array $format Optional. The format or formats to check.
- * @param object|int $post Optional. The post to check. If not supplied, defaults to the current post if used in the loop.
+ * @param string|array    $format Optional. The format or formats to check.
+ * @param object|int|null $post   Optional. The post to check. If not supplied, defaults to the current post if used in the loop.
  * @return bool True if the post has any of the given formats (or any format, if no format specified), false otherwise.
  */
@@ -58 +58 @@
  * @since 3.1.0
  *
- * @param int|object $post The post for which to assign a format.
- * @param string $format A format to assign. Use an empty string or array to remove all formats from the post.
- * @return mixed WP_Error on error. Array of affected term IDs on success.
+ * @param int|object $post   The post for which to assign a format.
+ * @param string     $format A format to assign. Use an empty string or array to remove all formats from the post.
+ * @return array|WP_Error|false WP_Error on error. Array of affected term IDs on success.
  */
 function set_post_format( $post, $format ) {
@@ -136 +136 @@
  *
  * @param string $format The post format slug.
- * @return string The post format term link.
+ * @return string|WP_Error|false The post format term link.
  */
 function get_post_format_link( $format ) {
@@ -150 +150 @@
  * @access private
  * @since 3.1.0
+ *
+ * @param array $qvs
+ * @return array
  */
 function _post_format_request( $qvs ) {
@@ -168 +171 @@
  * @access private
  * @since 3.1.0
+ *
+ * @global WP_Rewrite $wp_rewrite
+ *
+ * @param string $link
+ * @param object $term
+ * @param string $taxonomy
+ * @return string
  */
 function _post_format_link( $link, $term, $taxonomy ) {
     global $wp_rewrite;
-    if ( 'post_format' != $taxonomy )
+    if ( 'post_format' != $taxonomy ) {
         return $link;
+    }
     if ( $wp_rewrite->get_extra_permastruct( $taxonomy ) ) {
         return str_replace( "/{$term->slug}", '/' . str_replace( 'post-format-', '', $term->slug ), $link );
@@ -186 +197 @@
  * @access private
  * @since 3.1.0
+ *
+ * @param object $term
+ * @return object
  */
 function _post_format_get_term( $term ) {
@@ -199 +213 @@
  * @access private
  * @since 3.1.0
+ *
+ * @param array        $terms
+ * @param string|array $taxonomies
+ * @param array        $args
+ * @return array
  */
 function _post_format_get_terms( $terms, $taxonomies, $args ) {
@@ -222 +241 @@
  * @access private
  * @since 3.1.0
+ *
+ * @param array $terms
+ * @return array
  */
 function _post_format_wp_get_object_terms( $terms ) {