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

Timestamp:

04/27/2023 11:13:36 PM (2 years ago)

Author:

johnbillion

Message:

Docs: All sorts of improvements and corrections to function and hook docs.

See #57840

File:

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

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

@@ -2557 +2557 @@
      * @param string       $table  Table name.
      * @param array        $data   Data to insert (in column => value pairs).
-     *                             Both $data columns and $data values should be "raw" (neither should be SQL escaped).
+     *                             Both `$data` columns and `$data` values should be "raw" (neither should be SQL escaped).
      *                             Sending a null value will cause the column to be set to NULL - the corresponding
      *                             format is ignored in this case.
-     * @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.
+     * @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', '%f', '%s' (integer, float, string).
-     *                             If omitted, all values in $data will be treated as strings unless otherwise
+     *                             If omitted, all values in `$data` will be treated as strings unless otherwise
      *                             specified in wpdb::$field_types. Default null.
      * @return int|false The number of rows inserted, or false on error.
@@ -2587 +2587 @@
      * @param string       $table  Table name.
      * @param array        $data   Data to insert (in column => value pairs).
-     *                             Both $data columns and $data values should be "raw" (neither should be SQL escaped).
+     *                             Both `$data` columns and `$data` values should be "raw" (neither should be SQL escaped).
      *                             Sending a null value will cause the column to be set to NULL - the corresponding
      *                             format is ignored in this case.
-     * @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.
+     * @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', '%f', '%s' (integer, float, string).
-     *                             If omitted, all values in $data will be treated as strings unless otherwise
+     *                             If omitted, all values in `$data` will be treated as strings unless otherwise
      *                             specified in wpdb::$field_types. Default null.
      * @return int|false The number of rows affected, or false on error.
@@ -2604 +2604 @@
      * Helper function for insert and replace.
      *
-     * Runs an insert or replace query based on $type argument.
+     * Runs an insert or replace query based on `$type` argument.
      *
      * @since 3.0.0
@@ -2614 +2614 @@
      * @param string       $table  Table name.
      * @param array        $data   Data to insert (in column => value pairs).
-     *                             Both $data columns and $data values should be "raw" (neither should be SQL escaped).
+     *                             Both `$data` columns and `$data` values should be "raw" (neither should be SQL escaped).
      *                             Sending a null value will cause the column to be set to NULL - the corresponding
      *                             format is ignored in this case.
-     * @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.
+     * @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', '%f', '%s' (integer, float, string).
-     *                             If omitted, all values in $data will be treated as strings unless otherwise
+     *                             If omitted, all values in `$data` will be treated as strings unless otherwise
      *                             specified in wpdb::$field_types. Default null.
-     * @param string       $type   Optional. Type of operation. Possible values include 'INSERT' or 'REPLACE'.
+     * @param string       $type   Optional. Type of operation. Either 'INSERT' or 'REPLACE'.
      *                             Default 'INSERT'.
      * @return int|false The number of rows affected, or false on error.