Changeset 55732 for trunk/src/wp-includes/class-wpdb.php

Timestamp:

05/08/2023 10:35:38 PM (21 months ago)

Author:

johnbillion

Message:

Docs: A host of corrections and improvements to inline documentation.

See #57840

File:

• trunk/src/wp-includes/class-wpdb.php (modified) (3 diffs)

trunk/src/wp-includes/class-wpdb.php

@@ -1438 +1438 @@
      * Prepares a SQL query for safe execution.
      *
-     * Uses sprintf()-like syntax. The following placeholders can be used in the query string:
-     *
-     * - %d (integer)
-     * - %f (float)
-     * - %s (string)
-     * - %i (identifier, e.g. table/field names)
+     * Uses `sprintf()`-like syntax. The following placeholders can be used in the query string:
+     *
+     * - `%d` (integer)
+     * - `%f` (float)
+     * - `%s` (string)
+     * - `%i` (identifier, e.g. table/field names)
      *
      * All placeholders MUST be left unquoted in the query string. A corresponding argument
@@ -1478 +1478 @@
      * @since 6.2.0 Added `%i` for identifiers, e.g. table or field names.
      *              Check support via `wpdb::has_cap( 'identifier_placeholders' )`.
-     *              This preserves compatibility with sprintf(), as the C version uses
+     *              This preserves compatibility with `sprintf()`, as the C version uses
      *              `%d` and `$i` as a signed integer, whereas PHP only supports `%d`.
      *
      * @link https://www.php.net/sprintf Description of syntax.
      *
-     * @param string      $query   Query statement with sprintf()-like placeholders.
+     * @param string      $query   Query statement with `sprintf()`-like placeholders.
      * @param array|mixed $args    The array of variables to substitute into the query's placeholders
      *                             if being called with an array of arguments, or the first variable
@@ -3320 +3320 @@
      *     @type int    $length The column length.
      *     @type string $type   One of 'byte' or 'char'.
+     * }
      */
     public function get_col_length( $table, $column ) {