Changeset 32531

Timestamp:

05/21/2015 09:04:32 PM (9 years ago)

Author:

wonderboymusic

Message:

In category-template.php:

• Clarify/add some return docs.
• In walk_category_tree() and walk_category_dropdown_tree(), make behavior consistent and don't pass $walker by-reference - it is no longer necessary to do that with object instances.

See #32444.

File:

• trunk/src/wp-includes/category-template.php (modified) (13 diffs)

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

@@ -480 +480 @@
  *
  * @param string|array $args Optional. Override default arguments.
- * @return false|null|string HTML content only if 'echo' argument is 0.
+ * @return false|string HTML content only if 'echo' argument is 0.
  */
 function wp_list_categories( $args = '' ) {
@@ -630 +630 @@
  *
  * @param array|string|null $args Optional. Override default arguments.
- * @return null|false Generated tag cloud, only if no failures and 'array' is set for the 'format' argument.
+ * @return null|array Generated tag cloud, only if no failures and 'array' is set for the 'format' argument.
+ *                    Otherwise, this function outputs the tag cloud.
  */
 function wp_tag_cloud( $args = '' ) {
@@ -651 +652 @@
             $link = get_term_link( intval($tag->term_id), $tag->taxonomy );
         if ( is_wp_error( $link ) )
-            return false;
+            return;
 
         $tags[ $key ]->link = $link;
@@ -678 +679 @@
  * Default topic count scaling for tag links
  *
- * @param integer $count number of posts with that tag
- * @return integer scaled count
+ * @param int $count number of posts with that tag
+ * @return int scaled count
  */
 function default_topic_count_scale( $count ) {
@@ -869 +870 @@
  * @since 3.1.0
  * @access private
+ * @return int
  */
 function _wp_object_name_sort_cb( $a, $b ) {
@@ -879 +881 @@
  * @since 3.1.0
  * @access private
+ * @return bool
  */
 function _wp_object_count_sort_cb( $a, $b ) {
@@ -894 +897 @@
  * @since 2.1.0
  * @see Walker_Category::walk() for parameters and return description.
+ * @return string
  */
 function walk_category_tree() {
@@ -903 +907 @@
         $walker = $args[2]['walker'];
     }
-    return call_user_func_array(array( &$walker, 'walk' ), $args );
+    return call_user_func_array( array( $walker, 'walk' ), $args );
 }
 
@@ -912 +916 @@
  * @since 2.1.0
  * @see Walker_CategoryDropdown::walk() for parameters and return description.
+ * @return string
  */
 function walk_category_dropdown_tree() {
     $args = func_get_args();
     // the user's options are the third parameter
-    if ( empty($args[2]['walker']) || !is_a($args[2]['walker'], 'Walker') )
+    if ( empty( $args[2]['walker'] ) || ! ( $args[2]['walker'] instanceof Walker ) ) {
         $walker = new Walker_CategoryDropdown;
-    else
+    } else {
         $walker = $args[2]['walker'];
-
-    return call_user_func_array(array( &$walker, 'walk' ), $args );
+    }
+    return call_user_func_array( array( $walker, 'walk' ), $args );
 }
 
@@ -1215 +1220 @@
  *
  * @param int $id Post ID.
- * @return array|bool Array of tag objects on success, false on failure.
+ * @return array|false|WP_Error Array of tag objects on success, false on failure.
  */
 function get_the_tags( $id = 0 ) {
@@ -1240 +1245 @@
  * @param string $after Optional. After tags.
  * @param int $id Optional. Post ID. Defaults to the current post.
- * @return string|bool|WP_Error A list of tags on success, false if there are no terms, WP_Error on failure.
+ * @return string|false|WP_Error A list of tags on success, false if there are no terms, WP_Error on failure.
  */
 function get_the_tag_list( $before = '', $sep = '', $after = '', $id = 0 ) {
@@ -1313 +1318 @@
  * @param int|object $post Post ID or object.
  * @param string $taxonomy Taxonomy name.
- * @return array|bool|WP_Error Array of term objects on success, false if there are no terms
- *                             or the post does not exist, WP_Error on failure.
+ * @return array|false|WP_Error Array of term objects on success, false if there are no terms
+ *                              or the post does not exist, WP_Error on failure.
  */
 function get_the_terms( $post, $taxonomy ) {
@@ -1353 +1358 @@
  * @param string $sep Optional. Separate items using this.
  * @param string $after Optional. After list.
- * @return string|bool|WP_Error A list of terms on success, false if there are no terms, WP_Error on failure.
+ * @return string|false|WP_Error A list of terms on success, false if there are no terms, WP_Error on failure.
  */
 function get_the_term_list( $id, $taxonomy, $before = '', $sep = '', $after = '' ) {