Changeset 6302 for trunk/src/includes/common/formatting.php

Timestamp:

02/23/2017 11:24:29 PM (9 years ago)

Author:

johnjamesjacoby

Message:

Common: Introduce bbp_number_not_negative() and use it in the following ways:

• Register the relevant meta-data keys for posts & users, so updated values can never be invalid
• Filter return values for existing database values that might be invalid on existing installs
• Use in place of intval() or (int) casts where negative values should not exist

This has the added benefit of introducing the bbp_register_meta hook, for future meta-data registrations (of which bbPress has much of.) We'll concentrate on counts for 2.6, and integrate IDs and timestamps in future releases.

See #3059.

File:

• trunk/src/includes/common/formatting.php (modified) (1 diff)

trunk/src/includes/common/formatting.php

@@ -463 +463 @@
 
 /**
+ * Never let a numeric value be less than zero.
+ *
+ * @since 2.6.0 bbPress (r6300)
+ *
+ * @param int $number
+ */
+function bbp_number_not_negative( $number = 0 ) {
+
+    // Protect against formatted strings
+    if ( is_string( $number ) ) {
+        $number = strip_tags( $number );                    // No HTML
+        $number = preg_replace( '/[^0-9-]/', '', $number ); // No number-format
+
+    // Protect against objects, arrays, scalars, etc...
+    } elseif ( ! is_numeric( $number ) ) {
+        $number = 0;
+    }
+
+    // Make the number an integer
+    $int = intval( $number );
+
+    // Pick the maximum value, never less than zero
+    $not_less_than_zero = max( 0, $int );
+
+    // Filter & return
+    return apply_filters( 'bbp_number_not_negative', $not_less_than_zero, $int, $number );
+}
+
+/**
  * A bbPress specific method of formatting numeric values
  *