Changeset 47060 for trunk/src/wp-includes/cache.php

Timestamp:

01/11/2020 06:30:58 PM (7 years ago)

Author:

SergeyBiryukov

Message:

Docs: In various @return tags, list the expected type first, instead of false.

Follow-up to [46696].

See #48303.

File:

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

trunk/src/wp-includes/cache.php

@@ -23 +23 @@
  * @param int        $expire Optional. When the cache data should expire, in seconds.
  *                           Default 0 (no expiration).
- * @return bool False if cache key and group already exist, true on success.
+ * @return bool True on success, false if cache key and group already exist.
  */
 function wp_cache_add( $key, $data, $group = '', $expire = 0 ) {
@@ -59 +59 @@
  * @param int        $offset Optional. The amount by which to decrement the item's value. Default 1.
  * @param string     $group  Optional. The group the key is in. Default empty.
- * @return false|int False on failure, the item's new value on success.
+ * @return int|false The item's new value on success, false on failure.
  */
 function wp_cache_decr( $key, $offset = 1, $group = '' ) {
@@ -93 +93 @@
  * @global WP_Object_Cache $wp_object_cache Object cache global instance.
  *
- * @return bool False on failure, true on success
+ * @return bool True on success, false on failure.
  */
 function wp_cache_flush() {
@@ -135 +135 @@
  * @param int        $offset Optional. The amount by which to increment the item's value. Default 1.
  * @param string     $group  Optional. The group the key is in. Default empty.
- * @return false|int False on failure, the item's new value on success.
+ * @return int|false The item's new value on success, false on failure.
  */
 function wp_cache_incr( $key, $offset = 1, $group = '' ) {
@@ -192 +192 @@
  * @param int        $expire Optional. When to expire the cache contents, in seconds.
  *                           Default 0 (no expiration).
- * @return bool False on failure, true on success
+ * @return bool True on success, false on failure.
  */
 function wp_cache_set( $key, $data, $group = '', $expire = 0 ) {
@@ -397 +397 @@
          * @param string     $group  Optional. Where to group the cache contents. Default 'default'.
          * @param int        $expire Optional. When to expire the cache contents. Default 0 (no expiration).
-         * @return bool False if cache key and group already exist, true on success
+         * @return bool True on success, false if cache key and group already exist.
          */
         public function add( $key, $data, $group = 'default', $expire = 0 ) {
@@ -442 +442 @@
          * @param int        $offset Optional. The amount by which to decrement the item's value. Default 1.
          * @param string     $group  Optional. The group the key is in. Default 'default'.
-         * @return false|int False on failure, the item's new value on success.
+         * @return int|false The item's new value on success, false on failure.
          */
         public function decr( $key, $offset = 1, $group = 'default' ) {
@@ -531 +531 @@
          * @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.
+         * @return mixed|false The cache contents on success, false on failure to retrieve contents.
          */
         public function get( $key, $group = 'default', $force = false, &$found = null ) {
@@ -565 +565 @@
          * @param int        $offset Optional. The amount by which to increment the item's value. Default 1.
          * @param string     $group  Optional. The group the key is in. Default 'default'.
-         * @return false|int False on failure, the item's new value on success.
+         * @return int|false The item's new value on success, false on failure.
          */
         public function incr( $key, $offset = 1, $group = 'default' ) {