Changeset 18714 for trunk/wp-includes/wp-db.php

Timestamp:

09/19/2011 05:15:44 AM (13 years ago)

Author:

dd32

Message:

Add documentation for floats (%f) to wpdb::prepare() and friends. Props dllh. Fixes #18407

File:

• trunk/wp-includes/wp-db.php (modified) (5 diffs)

trunk/wp-includes/wp-db.php

@@ -844 +844 @@
      * The following directives can be used in the query format string:
      *   %d (integer)
+     *   %f (float)
      *   %s (string)
      *   %% (literal percentage sign - no argument needed)
      *
-     * Both %d and %s are to be left unquoted in the query string and they need an argument passed for them.
+     * All of %d, %f, and %s are to be left unquoted in the query string and they need an argument passed for them.
      * Literals (%) as parts of the query must be properly written as %%.
      *
-     * This function only supports a small subset of the sprintf syntax; it only supports %d (integer), %s (string).
+     * This function only supports a small subset of the sprintf syntax; it only supports %d (integer), %f (float), and %s (string).
      * Does not support sign, padding, alignment, width or precision specifiers.
      * Does not support argument numbering/swapping.
@@ -1133 +1134 @@
      * @param array $data Data to insert (in column => value pairs). Both $data columns and $data values should be "raw" (neither should be SQL escaped).
      * @param array|string $format Optional. An array of formats to be mapped to each of the value in $data. If string, that format will be used for all of the values in $data.
-     *  A format is one of '%d', '%s' (integer, string). If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
+     *  A format is one of '%d', '%f', '%s' (integer, float, string). If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
      * @return int|false The number of rows inserted, or false on error.
      */
@@ -1156 +1157 @@
      * @param array $data Data to insert (in column => value pairs). Both $data columns and $data values should be "raw" (neither should be SQL escaped).
      * @param array|string $format Optional. An array of formats to be mapped to each of the value in $data. If string, that format will be used for all of the values in $data.
-     *  A format is one of '%d', '%s' (integer, string). If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
+     *  A format is one of '%d', '%f', '%s' (integer, float, string). If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
      * @return int|false The number of rows affected, or false on error.
      */
@@ -1177 +1178 @@
      * @param array $data Data to insert (in column => value pairs).  Both $data columns and $data values should be "raw" (neither should be SQL escaped).
      * @param array|string $format Optional. An array of formats to be mapped to each of the value in $data. If string, that format will be used for all of the values in $data.
-     *  A format is one of '%d', '%s' (integer, string). If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
+     *  A format is one of '%d', '%f', '%s' (integer, float, string). If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
      * @return int|false The number of rows affected, or false on error.
      */
@@ -1216 +1217 @@
      * @param array $where A named array of WHERE clauses (in column => value pairs). Multiple clauses will be joined with ANDs. Both $where columns and $where values should be "raw".
      * @param array|string $format Optional. An array of formats to be mapped to each of the values in $data. If string, that format will be used for all of the values in $data.
-     *  A format is one of '%d', '%s' (integer, string). If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
-     * @param array|string $format_where Optional. An array of formats to be mapped to each of the values in $where. If string, that format will be used for all of the items in $where.  A format is one of '%d', '%s' (integer, string).  If omitted, all values in $where will be treated as strings.
+     *  A format is one of '%d', '%f', '%s' (integer, float, string). If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
+     * @param array|string $format_where Optional. An array of formats to be mapped to each of the values in $where. If string, that format will be used for all of the items in $where.  A format is one of '%d', '%f', '%s' (integer, float, string).  If omitted, all values in $where will be treated as strings.
      * @return int|false The number of rows updated, or false on error.
      */