Changeset 32532

Timestamp:

05/21/2015 09:17:42 PM (10 years ago)

Author:

wonderboymusic

Message:

In category.php:

• Clarify some return docs.
• In _make_cat_compat(), ensure that WP_Error is not decorated

See #32444.

File:

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

trunk/src/wp-includes/category.php

@@ -69 +69 @@
  * @param string $output Optional. Constant OBJECT, ARRAY_A, or ARRAY_N
  * @param string $filter Optional. Default is raw or no WordPress defined filter will applied.
- * @return object|array|WP_Error|null Category data in type defined by $output parameter. WP_Error if $category is empty, null if it does not exist.
+ * @return object|array|WP_Error|null Category data in type defined by $output parameter.
+ *                                    WP_Error if $category is empty, null if it does not exist.
  */
 function get_category( $category, $output = OBJECT, $filter = 'raw' ) {
@@ -99 +100 @@
  * @param bool $full_match Optional. Whether full path should be matched.
  * @param string $output Optional. Constant OBJECT, ARRAY_A, or ARRAY_N
- * @return null|object|array Null on failure. Type is based on $output value.
+ * @return null|object|array|WP_Error Null on failure. Type is based on $output value.
  */
 function get_category_by_path( $category_path, $full_match = true, $output = OBJECT ) {
@@ -109 +110 @@
     $category_paths = explode( '/', $category_paths );
     $full_path = '';
-    foreach ( (array) $category_paths as $pathdir )
+    foreach ( (array) $category_paths as $pathdir ) {
         $full_path .= ( $pathdir != '' ? '/' : '' ) . sanitize_title( $pathdir );
-
+    }
     $categories = get_terms( 'category', array('get' => 'all', 'slug' => $leaf_path) );
 
-    if ( empty( $categories ) )
-        return null;
+    if ( empty( $categories ) ) {
+        return;
+    }
 
     foreach ( $categories as $category ) {
@@ -122 +124 @@
         while ( ( $curcategory->parent != 0 ) && ( $curcategory->parent != $curcategory->term_id ) ) {
             $curcategory = get_term( $curcategory->parent, 'category' );
-            if ( is_wp_error( $curcategory ) )
+            if ( is_wp_error( $curcategory ) ) {
                 return $curcategory;
+            }
             $path = '/' . $curcategory->slug . $path;
         }
@@ -140 +143 @@
         return $category;
     }
-
-    return null;
 }
 
@@ -322 +323 @@
  */
 function _make_cat_compat( &$category ) {
-    if ( is_object( $category ) ) {
+    if ( is_object( $category ) && ! is_wp_error( $category ) ) {
         $category->cat_ID = &$category->term_id;
         $category->category_count = &$category->count;