Changeset 32528

Timestamp:

05/21/2015 08:21:22 PM (9 years ago)

Author:

wonderboymusic

Message:

In cache.php, clarify some return docs. Some WP_Object_Cache methods return void, so those wrapper functions don't need to return at all.

See #32444.

File:

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

trunk/src/wp-includes/cache.php

@@ -38 +38 @@
  * @since 2.0.0
  *
- * @return bool Always returns True
+ * @return true Always returns True
  */
 function wp_cache_close() {
@@ -106 +106 @@
  * @param bool &$found Whether key was found in the cache. Disambiguates a return of false, a storable value.
  * @return bool|mixed False on failure to retrieve contents or the cache
- *      contents on success
+ *                    contents on success
  */
 function wp_cache_get( $key, $group = '', $force = false, &$found = null ) {
@@ -136 +136 @@
  *
  * @since 2.0.0
- * @global WP_Object_Cache $wp_object_cache WordPress Object Cache
+ * @global $wp_object_cache WordPress Object Cache instance
+ * @uses WP_Object_Cache
  */
 function wp_cache_init() {
@@ -193 +194 @@
     global $wp_object_cache;
 
-    return $wp_object_cache->switch_to_blog( $blog_id );
+    $wp_object_cache->switch_to_blog( $blog_id );
 }
 
@@ -206 +207 @@
     global $wp_object_cache;
 
-    return $wp_object_cache->add_global_groups( $groups );
+    $wp_object_cache->add_global_groups( $groups );
 }
 
@@ -240 +241 @@
     global $wp_object_cache;
 
-    return $wp_object_cache->reset();
+    $wp_object_cache->reset();
 }
 
@@ -500 +501 @@
      * @param string $group Where the cache contents are grouped
      * @param string $force Whether to force a refetch rather than relying on the local cache (default is false)
-     * @return bool|mixed False on failure to retrieve contents or the cache
-     *      contents on success
+     * @return false|mixed False on failure to retrieve contents or the cache
+     *                     contents on success
      */
     public function get( $key, $group = 'default', $force = false, &$found = null ) {
@@ -617 +618 @@
      * @param string $group Where to group the cache contents
      * @param int $expire Not Used
-     * @return bool Always returns true
+     * @return true Always returns true
      */
     public function set( $key, $data, $group = 'default', $expire = 0 ) {
@@ -707 +708 @@
      * @since  2.0.8
      *
-     * @return bool True value. Won't be used by PHP
+     * @return true True value. Won't be used by PHP
      */
     public function __destruct() {