Changeset 44601

Timestamp:

01/15/2019 06:17:42 AM (6 years ago)

Author:

pento

Message:

Docs: Fix the WP_Object_Cache::get() docblock.

The $force parameter is a bool, not a string. The matching wp_cache_get() docblock has the correct type.

Props subrataemfluence.
Fixes #44454.

File:

• trunk/src/wp-includes/cache.php (modified) (1 diff)

trunk/src/wp-includes/cache.php

@@ -527 +527 @@
      * @param int|string $key    What the contents in the cache are called.
      * @param string     $group  Optional. Where the cache contents are grouped. Default 'default'.
-     * @param string     $force  Optional. Unused. Whether to force a refetch rather than relying on the local
+     * @param bool       $force  Optional. Unused. Whether to force a refetch rather than relying on the local
      *                           cache. Default false.
-     * @param bool        $found  Optional. Whether the key was found in the cache (passed by reference).
-     *                            Disambiguates a return of false, a storable value. Default null.
+     * @param bool       $found  Optional. Whether the key was found in the cache (passed by reference).
+     *                           Disambiguates a return of false, a storable value. Default null.
      * @return false|mixed False on failure to retrieve contents or the cache contents on success.
      */