[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

/wp-includes/ -> wp-db.php (source)

   1  <?php
   2  /**
   3   * WordPress database access abstraction class
   4   *
   5   * Original code from {@link http://php.justinvincent.com Justin Vincent (justin@visunet.ie)}
   6   *
   7   * @package WordPress
   8   * @subpackage Database
   9   * @since 0.71
  10   */
  11  
  12  /**
  13   * @since 0.71
  14   */
  15  define( 'EZSQL_VERSION', 'WP1.25' );
  16  
  17  /**
  18   * @since 0.71
  19   */
  20  define( 'OBJECT', 'OBJECT' );
  21  // phpcs:ignore Generic.NamingConventions.UpperCaseConstantName.ConstantNotUpperCase
  22  define( 'object', 'OBJECT' ); // Back compat.
  23  
  24  /**
  25   * @since 2.5.0
  26   */
  27  define( 'OBJECT_K', 'OBJECT_K' );
  28  
  29  /**
  30   * @since 0.71
  31   */
  32  define( 'ARRAY_A', 'ARRAY_A' );
  33  
  34  /**
  35   * @since 0.71
  36   */
  37  define( 'ARRAY_N', 'ARRAY_N' );
  38  
  39  /**
  40   * WordPress database access abstraction class.
  41   *
  42   * This class is used to interact with a database without needing to use raw SQL statements.
  43   * By default, WordPress uses this class to instantiate the global $wpdb object, providing
  44   * access to the WordPress database.
  45   *
  46   * It is possible to replace this class with your own by setting the $wpdb global variable
  47   * in wp-content/db.php file to your class. The wpdb class will still be included, so you can
  48   * extend it or simply use your own.
  49   *
  50   * @link https://developer.wordpress.org/reference/classes/wpdb/
  51   *
  52   * @since 0.71
  53   */
  54  class wpdb {
  55  
  56      /**
  57       * Whether to show SQL/DB errors.
  58       *
  59       * Default is to show errors if both WP_DEBUG and WP_DEBUG_DISPLAY evaluate to true.
  60       *
  61       * @since 0.71
  62       * @var bool
  63       */
  64      var $show_errors = false;
  65  
  66      /**
  67       * Whether to suppress errors during the DB bootstrapping. Default false.
  68       *
  69       * @since 2.5.0
  70       * @var bool
  71       */
  72      var $suppress_errors = false;
  73  
  74      /**
  75       * The error encountered during the last query.
  76       *
  77       * @since 2.5.0
  78       * @var string
  79       */
  80      public $last_error = '';
  81  
  82      /**
  83       * The number of queries made.
  84       *
  85       * @since 1.2.0
  86       * @var int
  87       */
  88      public $num_queries = 0;
  89  
  90      /**
  91       * Count of rows returned by the last query.
  92       *
  93       * @since 0.71
  94       * @var int
  95       */
  96      public $num_rows = 0;
  97  
  98      /**
  99       * Count of rows affected by the last query.
 100       *
 101       * @since 0.71
 102       * @var int
 103       */
 104      var $rows_affected = 0;
 105  
 106      /**
 107       * The ID generated for an AUTO_INCREMENT column by the last query (usually INSERT).
 108       *
 109       * @since 0.71
 110       * @var int
 111       */
 112      public $insert_id = 0;
 113  
 114      /**
 115       * The last query made.
 116       *
 117       * @since 0.71
 118       * @var string
 119       */
 120      var $last_query;
 121  
 122      /**
 123       * Results of the last query.
 124       *
 125       * @since 0.71
 126       * @var array|null
 127       */
 128      var $last_result;
 129  
 130      /**
 131       * MySQL result, which is either a resource or boolean.
 132       *
 133       * @since 0.71
 134       * @var mixed
 135       */
 136      protected $result;
 137  
 138      /**
 139       * Cached column info, for sanity checking data before inserting.
 140       *
 141       * @since 4.2.0
 142       * @var array
 143       */
 144      protected $col_meta = array();
 145  
 146      /**
 147       * Calculated character sets on tables.
 148       *
 149       * @since 4.2.0
 150       * @var array
 151       */
 152      protected $table_charset = array();
 153  
 154      /**
 155       * Whether text fields in the current query need to be sanity checked. Default false.
 156       *
 157       * @since 4.2.0
 158       * @var bool
 159       */
 160      protected $check_current_query = true;
 161  
 162      /**
 163       * Flag to ensure we don't run into recursion problems when checking the collation.
 164       *
 165       * @since 4.2.0
 166       * @see wpdb::check_safe_collation()
 167       * @var bool
 168       */
 169      private $checking_collation = false;
 170  
 171      /**
 172       * Saved info on the table column.
 173       *
 174       * @since 0.71
 175       * @var array
 176       */
 177      protected $col_info;
 178  
 179      /**
 180       * Log of queries that were executed, for debugging purposes.
 181       *
 182       * @since 1.5.0
 183       * @since 2.5.0 The third element in each query log was added to record the calling functions.
 184       * @since 5.1.0 The fourth element in each query log was added to record the start time.
 185       * @since 5.3.0 The fifth element in each query log was added to record custom data.
 186       *
 187       * @var array[] {
 188       *     Array of queries that were executed.
 189       *
 190       *     @type array ...$0 {
 191       *         Data for each query.
 192       *
 193       *         @type string $0 The query's SQL.
 194       *         @type float  $1 Total time spent on the query, in seconds.
 195       *         @type string $2 Comma-separated list of the calling functions.
 196       *         @type float  $3 Unix timestamp of the time at the start of the query.
 197       *         @type array  $4 Custom query data.
 198       *     }
 199       * }
 200       */
 201      var $queries;
 202  
 203      /**
 204       * The number of times to retry reconnecting before dying. Default 5.
 205       *
 206       * @since 3.9.0
 207       * @see wpdb::check_connection()
 208       * @var int
 209       */
 210      protected $reconnect_retries = 5;
 211  
 212      /**
 213       * WordPress table prefix
 214       *
 215       * You can set this to have multiple WordPress installations in a single database.
 216       * The second reason is for possible security precautions.
 217       *
 218       * @since 2.5.0
 219       * @var string
 220       */
 221      public $prefix = '';
 222  
 223      /**
 224       * WordPress base table prefix.
 225       *
 226       * @since 3.0.0
 227       * @var string
 228       */
 229      public $base_prefix;
 230  
 231      /**
 232       * Whether the database queries are ready to start executing.
 233       *
 234       * @since 2.3.2
 235       * @var bool
 236       */
 237      var $ready = false;
 238  
 239      /**
 240       * Blog ID.
 241       *
 242       * @since 3.0.0
 243       * @var int
 244       */
 245      public $blogid = 0;
 246  
 247      /**
 248       * Site ID.
 249       *
 250       * @since 3.0.0
 251       * @var int
 252       */
 253      public $siteid = 0;
 254  
 255      /**
 256       * List of WordPress per-blog tables.
 257       *
 258       * @since 2.5.0
 259       * @see wpdb::tables()
 260       * @var array
 261       */
 262      var $tables = array(
 263          'posts',
 264          'comments',
 265          'links',
 266          'options',
 267          'postmeta',
 268          'terms',
 269          'term_taxonomy',
 270          'term_relationships',
 271          'termmeta',
 272          'commentmeta',
 273      );
 274  
 275      /**
 276       * List of deprecated WordPress tables.
 277       *
 278       * 'categories', 'post2cat', and 'link2cat' were deprecated in 2.3.0, db version 5539.
 279       *
 280       * @since 2.9.0
 281       * @see wpdb::tables()
 282       * @var array
 283       */
 284      var $old_tables = array( 'categories', 'post2cat', 'link2cat' );
 285  
 286      /**
 287       * List of WordPress global tables.
 288       *
 289       * @since 3.0.0
 290       * @see wpdb::tables()
 291       * @var array
 292       */
 293      var $global_tables = array( 'users', 'usermeta' );
 294  
 295      /**
 296       * List of Multisite global tables.
 297       *
 298       * @since 3.0.0
 299       * @see wpdb::tables()
 300       * @var array
 301       */
 302      var $ms_global_tables = array(
 303          'blogs',
 304          'blogmeta',
 305          'signups',
 306          'site',
 307          'sitemeta',
 308          'sitecategories',
 309          'registration_log',
 310      );
 311  
 312      /**
 313       * WordPress Comments table.
 314       *
 315       * @since 1.5.0
 316       * @var string
 317       */
 318      public $comments;
 319  
 320      /**
 321       * WordPress Comment Metadata table.
 322       *
 323       * @since 2.9.0
 324       * @var string
 325       */
 326      public $commentmeta;
 327  
 328      /**
 329       * WordPress Links table.
 330       *
 331       * @since 1.5.0
 332       * @var string
 333       */
 334      public $links;
 335  
 336      /**
 337       * WordPress Options table.
 338       *
 339       * @since 1.5.0
 340       * @var string
 341       */
 342      public $options;
 343  
 344      /**
 345       * WordPress Post Metadata table.
 346       *
 347       * @since 1.5.0
 348       * @var string
 349       */
 350      public $postmeta;
 351  
 352      /**
 353       * WordPress Posts table.
 354       *
 355       * @since 1.5.0
 356       * @var string
 357       */
 358      public $posts;
 359  
 360      /**
 361       * WordPress Terms table.
 362       *
 363       * @since 2.3.0
 364       * @var string
 365       */
 366      public $terms;
 367  
 368      /**
 369       * WordPress Term Relationships table.
 370       *
 371       * @since 2.3.0
 372       * @var string
 373       */
 374      public $term_relationships;
 375  
 376      /**
 377       * WordPress Term Taxonomy table.
 378       *
 379       * @since 2.3.0
 380       * @var string
 381       */
 382      public $term_taxonomy;
 383  
 384      /**
 385       * WordPress Term Meta table.
 386       *
 387       * @since 4.4.0
 388       * @var string
 389       */
 390      public $termmeta;
 391  
 392      //
 393      // Global and Multisite tables
 394      //
 395  
 396      /**
 397       * WordPress User Metadata table.
 398       *
 399       * @since 2.3.0
 400       * @var string
 401       */
 402      public $usermeta;
 403  
 404      /**
 405       * WordPress Users table.
 406       *
 407       * @since 1.5.0
 408       * @var string
 409       */
 410      public $users;
 411  
 412      /**
 413       * Multisite Blogs table.
 414       *
 415       * @since 3.0.0
 416       * @var string
 417       */
 418      public $blogs;
 419  
 420      /**
 421       * Multisite Blog Metadata table.
 422       *
 423       * @since 5.1.0
 424       * @var string
 425       */
 426      public $blogmeta;
 427  
 428      /**
 429       * Multisite Registration Log table.
 430       *
 431       * @since 3.0.0
 432       * @var string
 433       */
 434      public $registration_log;
 435  
 436      /**
 437       * Multisite Signups table.
 438       *
 439       * @since 3.0.0
 440       * @var string
 441       */
 442      public $signups;
 443  
 444      /**
 445       * Multisite Sites table.
 446       *
 447       * @since 3.0.0
 448       * @var string
 449       */
 450      public $site;
 451  
 452      /**
 453       * Multisite Sitewide Terms table.
 454       *
 455       * @since 3.0.0
 456       * @var string
 457       */
 458      public $sitecategories;
 459  
 460      /**
 461       * Multisite Site Metadata table.
 462       *
 463       * @since 3.0.0
 464       * @var string
 465       */
 466      public $sitemeta;
 467  
 468      /**
 469       * Format specifiers for DB columns.
 470       *
 471       * Columns not listed here default to %s. Initialized during WP load.
 472       * Keys are column names, values are format types: 'ID' => '%d'.
 473       *
 474       * @since 2.8.0
 475       * @see wpdb::prepare()
 476       * @see wpdb::insert()
 477       * @see wpdb::update()
 478       * @see wpdb::delete()
 479       * @see wp_set_wpdb_vars()
 480       * @var array
 481       */
 482      public $field_types = array();
 483  
 484      /**
 485       * Database table columns charset.
 486       *
 487       * @since 2.2.0
 488       * @var string
 489       */
 490      public $charset;
 491  
 492      /**
 493       * Database table columns collate.
 494       *
 495       * @since 2.2.0
 496       * @var string
 497       */
 498      public $collate;
 499  
 500      /**
 501       * Database Username.
 502       *
 503       * @since 2.9.0
 504       * @var string
 505       */
 506      protected $dbuser;
 507  
 508      /**
 509       * Database Password.
 510       *
 511       * @since 3.1.0
 512       * @var string
 513       */
 514      protected $dbpassword;
 515  
 516      /**
 517       * Database Name.
 518       *
 519       * @since 3.1.0
 520       * @var string
 521       */
 522      protected $dbname;
 523  
 524      /**
 525       * Database Host.
 526       *
 527       * @since 3.1.0
 528       * @var string
 529       */
 530      protected $dbhost;
 531  
 532      /**
 533       * Database Handle.
 534       *
 535       * @since 0.71
 536       * @var string
 537       */
 538      protected $dbh;
 539  
 540      /**
 541       * A textual description of the last query/get_row/get_var call.
 542       *
 543       * @since 3.0.0
 544       * @var string
 545       */
 546      public $func_call;
 547  
 548      /**
 549       * Whether MySQL is used as the database engine.
 550       *
 551       * Set in wpdb::db_connect() to true, by default. This is used when checking
 552       * against the required MySQL version for WordPress. Normally, a replacement
 553       * database drop-in (db.php) will skip these checks, but setting this to true
 554       * will force the checks to occur.
 555       *
 556       * @since 3.3.0
 557       * @var bool
 558       */
 559      public $is_mysql = null;
 560  
 561      /**
 562       * A list of incompatible SQL modes.
 563       *
 564       * @since 3.9.0
 565       * @var array
 566       */
 567      protected $incompatible_modes = array(
 568          'NO_ZERO_DATE',
 569          'ONLY_FULL_GROUP_BY',
 570          'STRICT_TRANS_TABLES',
 571          'STRICT_ALL_TABLES',
 572          'TRADITIONAL',
 573          'ANSI',
 574      );
 575  
 576      /**
 577       * Whether to use mysqli over mysql. Default false.
 578       *
 579       * @since 3.9.0
 580       * @var bool
 581       */
 582      private $use_mysqli = false;
 583  
 584      /**
 585       * Whether we've managed to successfully connect at some point.
 586       *
 587       * @since 3.9.0
 588       * @var bool
 589       */
 590      private $has_connected = false;
 591  
 592      /**
 593       * Connects to the database server and selects a database.
 594       *
 595       * PHP5 style constructor for compatibility with PHP5. Does the actual setting up
 596       * of the class properties and connection to the database.
 597       *
 598       * @since 2.0.8
 599       *
 600       * @link https://core.trac.wordpress.org/ticket/3354
 601       * @global string $wp_version The WordPress version string.
 602       *
 603       * @param string $dbuser     MySQL database user.
 604       * @param string $dbpassword MySQL database password.
 605       * @param string $dbname     MySQL database name.
 606       * @param string $dbhost     MySQL database host.
 607       */
 608  	public function __construct( $dbuser, $dbpassword, $dbname, $dbhost ) {
 609          if ( WP_DEBUG && WP_DEBUG_DISPLAY ) {
 610              $this->show_errors();
 611          }
 612  
 613          // Use ext/mysqli if it exists unless WP_USE_EXT_MYSQL is defined as true.
 614          if ( function_exists( 'mysqli_connect' ) ) {
 615              $this->use_mysqli = true;
 616  
 617              if ( defined( 'WP_USE_EXT_MYSQL' ) ) {
 618                  $this->use_mysqli = ! WP_USE_EXT_MYSQL;
 619              }
 620          }
 621  
 622          $this->dbuser     = $dbuser;
 623          $this->dbpassword = $dbpassword;
 624          $this->dbname     = $dbname;
 625          $this->dbhost     = $dbhost;
 626  
 627          // wp-config.php creation will manually connect when ready.
 628          if ( defined( 'WP_SETUP_CONFIG' ) ) {
 629              return;
 630          }
 631  
 632          $this->db_connect();
 633      }
 634  
 635      /**
 636       * Makes private properties readable for backward compatibility.
 637       *
 638       * @since 3.5.0
 639       *
 640       * @param string $name The private member to get, and optionally process.
 641       * @return mixed The private member.
 642       */
 643  	public function __get( $name ) {
 644          if ( 'col_info' === $name ) {
 645              $this->load_col_info();
 646          }
 647  
 648          return $this->$name;
 649      }
 650  
 651      /**
 652       * Makes private properties settable for backward compatibility.
 653       *
 654       * @since 3.5.0
 655       *
 656       * @param string $name  The private member to set.
 657       * @param mixed  $value The value to set.
 658       */
 659  	public function __set( $name, $value ) {
 660          $protected_members = array(
 661              'col_meta',
 662              'table_charset',
 663              'check_current_query',
 664          );
 665          if ( in_array( $name, $protected_members, true ) ) {
 666              return;
 667          }
 668          $this->$name = $value;
 669      }
 670  
 671      /**
 672       * Makes private properties check-able for backward compatibility.
 673       *
 674       * @since 3.5.0
 675       *
 676       * @param string $name The private member to check.
 677       * @return bool If the member is set or not.
 678       */
 679  	public function __isset( $name ) {
 680          return isset( $this->$name );
 681      }
 682  
 683      /**
 684       * Makes private properties un-settable for backward compatibility.
 685       *
 686       * @since 3.5.0
 687       *
 688       * @param string $name  The private member to unset
 689       */
 690  	public function __unset( $name ) {
 691          unset( $this->$name );
 692      }
 693  
 694      /**
 695       * Sets $this->charset and $this->collate.
 696       *
 697       * @since 3.1.0
 698       */
 699  	public function init_charset() {
 700          $charset = '';
 701          $collate = '';
 702  
 703          if ( function_exists( 'is_multisite' ) && is_multisite() ) {
 704              $charset = 'utf8';
 705              if ( defined( 'DB_COLLATE' ) && DB_COLLATE ) {
 706                  $collate = DB_COLLATE;
 707              } else {
 708                  $collate = 'utf8_general_ci';
 709              }
 710          } elseif ( defined( 'DB_COLLATE' ) ) {
 711              $collate = DB_COLLATE;
 712          }
 713  
 714          if ( defined( 'DB_CHARSET' ) ) {
 715              $charset = DB_CHARSET;
 716          }
 717  
 718          $charset_collate = $this->determine_charset( $charset, $collate );
 719  
 720          $this->charset = $charset_collate['charset'];
 721          $this->collate = $charset_collate['collate'];
 722      }
 723  
 724      /**
 725       * Determines the best charset and collation to use given a charset and collation.
 726       *
 727       * For example, when able, utf8mb4 should be used instead of utf8.
 728       *
 729       * @since 4.6.0
 730       *
 731       * @param string $charset The character set to check.
 732       * @param string $collate The collation to check.
 733       * @return array {
 734       *     The most appropriate character set and collation to use.
 735       *
 736       *     @type string $charset Character set.
 737       *     @type string $collate Collation.
 738       * }
 739       */
 740  	public function determine_charset( $charset, $collate ) {
 741          if ( ( $this->use_mysqli && ! ( $this->dbh instanceof mysqli ) ) || empty( $this->dbh ) ) {
 742              return compact( 'charset', 'collate' );
 743          }
 744  
 745          if ( 'utf8' === $charset && $this->has_cap( 'utf8mb4' ) ) {
 746              $charset = 'utf8mb4';
 747          }
 748  
 749          if ( 'utf8mb4' === $charset && ! $this->has_cap( 'utf8mb4' ) ) {
 750              $charset = 'utf8';
 751              $collate = str_replace( 'utf8mb4_', 'utf8_', $collate );
 752          }
 753  
 754          if ( 'utf8mb4' === $charset ) {
 755              // _general_ is outdated, so we can upgrade it to _unicode_, instead.
 756              if ( ! $collate || 'utf8_general_ci' === $collate ) {
 757                  $collate = 'utf8mb4_unicode_ci';
 758              } else {
 759                  $collate = str_replace( 'utf8_', 'utf8mb4_', $collate );
 760              }
 761          }
 762  
 763          // _unicode_520_ is a better collation, we should use that when it's available.
 764          if ( $this->has_cap( 'utf8mb4_520' ) && 'utf8mb4_unicode_ci' === $collate ) {
 765              $collate = 'utf8mb4_unicode_520_ci';
 766          }
 767  
 768          return compact( 'charset', 'collate' );
 769      }
 770  
 771      /**
 772       * Sets the connection's character set.
 773       *
 774       * @since 3.1.0
 775       *
 776       * @param resource $dbh     The resource given by mysql_connect.
 777       * @param string   $charset Optional. The character set. Default null.
 778       * @param string   $collate Optional. The collation. Default null.
 779       */
 780  	public function set_charset( $dbh, $charset = null, $collate = null ) {
 781          if ( ! isset( $charset ) ) {
 782              $charset = $this->charset;
 783          }
 784          if ( ! isset( $collate ) ) {
 785              $collate = $this->collate;
 786          }
 787          if ( $this->has_cap( 'collation' ) && ! empty( $charset ) ) {
 788              $set_charset_succeeded = true;
 789  
 790              if ( $this->use_mysqli ) {
 791                  if ( function_exists( 'mysqli_set_charset' ) && $this->has_cap( 'set_charset' ) ) {
 792                      $set_charset_succeeded = mysqli_set_charset( $dbh, $charset );
 793                  }
 794  
 795                  if ( $set_charset_succeeded ) {
 796                      $query = $this->prepare( 'SET NAMES %s', $charset );
 797                      if ( ! empty( $collate ) ) {
 798                          $query .= $this->prepare( ' COLLATE %s', $collate );
 799                      }
 800                      mysqli_query( $dbh, $query );
 801                  }
 802              } else {
 803                  if ( function_exists( 'mysql_set_charset' ) && $this->has_cap( 'set_charset' ) ) {
 804                      $set_charset_succeeded = mysql_set_charset( $charset, $dbh );
 805                  }
 806                  if ( $set_charset_succeeded ) {
 807                      $query = $this->prepare( 'SET NAMES %s', $charset );
 808                      if ( ! empty( $collate ) ) {
 809                          $query .= $this->prepare( ' COLLATE %s', $collate );
 810                      }
 811                      mysql_query( $query, $dbh );
 812                  }
 813              }
 814          }
 815      }
 816  
 817      /**
 818       * Changes the current SQL mode, and ensures its WordPress compatibility.
 819       *
 820       * If no modes are passed, it will ensure the current MySQL server modes are compatible.
 821       *
 822       * @since 3.9.0
 823       *
 824       * @param array $modes Optional. A list of SQL modes to set. Default empty array.
 825       */
 826  	public function set_sql_mode( $modes = array() ) {
 827          if ( empty( $modes ) ) {
 828              if ( $this->use_mysqli ) {
 829                  $res = mysqli_query( $this->dbh, 'SELECT @@SESSION.sql_mode' );
 830              } else {
 831                  $res = mysql_query( 'SELECT @@SESSION.sql_mode', $this->dbh );
 832              }
 833  
 834              if ( empty( $res ) ) {
 835                  return;
 836              }
 837  
 838              if ( $this->use_mysqli ) {
 839                  $modes_array = mysqli_fetch_array( $res );
 840                  if ( empty( $modes_array[0] ) ) {
 841                      return;
 842                  }
 843                  $modes_str = $modes_array[0];
 844              } else {
 845                  $modes_str = mysql_result( $res, 0 );
 846              }
 847  
 848              if ( empty( $modes_str ) ) {
 849                  return;
 850              }
 851  
 852              $modes = explode( ',', $modes_str );
 853          }
 854  
 855          $modes = array_change_key_case( $modes, CASE_UPPER );
 856  
 857          /**
 858           * Filters the list of incompatible SQL modes to exclude.
 859           *
 860           * @since 3.9.0
 861           *
 862           * @param array $incompatible_modes An array of incompatible modes.
 863           */
 864          $incompatible_modes = (array) apply_filters( 'incompatible_sql_modes', $this->incompatible_modes );
 865  
 866          foreach ( $modes as $i => $mode ) {
 867              if ( in_array( $mode, $incompatible_modes, true ) ) {
 868                  unset( $modes[ $i ] );
 869              }
 870          }
 871  
 872          $modes_str = implode( ',', $modes );
 873  
 874          if ( $this->use_mysqli ) {
 875              mysqli_query( $this->dbh, "SET SESSION sql_mode='$modes_str'" );
 876          } else {
 877              mysql_query( "SET SESSION sql_mode='$modes_str'", $this->dbh );
 878          }
 879      }
 880  
 881      /**
 882       * Sets the table prefix for the WordPress tables.
 883       *
 884       * @since 2.5.0
 885       *
 886       * @param string $prefix          Alphanumeric name for the new prefix.
 887       * @param bool   $set_table_names Optional. Whether the table names, e.g. wpdb::$posts,
 888       *                                should be updated or not. Default true.
 889       * @return string|WP_Error Old prefix or WP_Error on error.
 890       */
 891  	public function set_prefix( $prefix, $set_table_names = true ) {
 892  
 893          if ( preg_match( '|[^a-z0-9_]|i', $prefix ) ) {
 894              return new WP_Error( 'invalid_db_prefix', 'Invalid database prefix' );
 895          }
 896  
 897          $old_prefix = is_multisite() ? '' : $prefix;
 898  
 899          if ( isset( $this->base_prefix ) ) {
 900              $old_prefix = $this->base_prefix;
 901          }
 902  
 903          $this->base_prefix = $prefix;
 904  
 905          if ( $set_table_names ) {
 906              foreach ( $this->tables( 'global' ) as $table => $prefixed_table ) {
 907                  $this->$table = $prefixed_table;
 908              }
 909  
 910              if ( is_multisite() && empty( $this->blogid ) ) {
 911                  return $old_prefix;
 912              }
 913  
 914              $this->prefix = $this->get_blog_prefix();
 915  
 916              foreach ( $this->tables( 'blog' ) as $table => $prefixed_table ) {
 917                  $this->$table = $prefixed_table;
 918              }
 919  
 920              foreach ( $this->tables( 'old' ) as $table => $prefixed_table ) {
 921                  $this->$table = $prefixed_table;
 922              }
 923          }
 924          return $old_prefix;
 925      }
 926  
 927      /**
 928       * Sets blog ID.
 929       *
 930       * @since 3.0.0
 931       *
 932       * @param int $blog_id
 933       * @param int $network_id Optional.
 934       * @return int Previous blog ID.
 935       */
 936  	public function set_blog_id( $blog_id, $network_id = 0 ) {
 937          if ( ! empty( $network_id ) ) {
 938              $this->siteid = $network_id;
 939          }
 940  
 941          $old_blog_id  = $this->blogid;
 942          $this->blogid = $blog_id;
 943  
 944          $this->prefix = $this->get_blog_prefix();
 945  
 946          foreach ( $this->tables( 'blog' ) as $table => $prefixed_table ) {
 947              $this->$table = $prefixed_table;
 948          }
 949  
 950          foreach ( $this->tables( 'old' ) as $table => $prefixed_table ) {
 951              $this->$table = $prefixed_table;
 952          }
 953  
 954          return $old_blog_id;
 955      }
 956  
 957      /**
 958       * Gets blog prefix.
 959       *
 960       * @since 3.0.0
 961       *
 962       * @param int $blog_id Optional.
 963       * @return string Blog prefix.
 964       */
 965  	public function get_blog_prefix( $blog_id = null ) {
 966          if ( is_multisite() ) {
 967              if ( null === $blog_id ) {
 968                  $blog_id = $this->blogid;
 969              }
 970  
 971              $blog_id = (int) $blog_id;
 972  
 973              if ( defined( 'MULTISITE' ) && ( 0 === $blog_id || 1 === $blog_id ) ) {
 974                  return $this->base_prefix;
 975              } else {
 976                  return $this->base_prefix . $blog_id . '_';
 977              }
 978          } else {
 979              return $this->base_prefix;
 980          }
 981      }
 982  
 983      /**
 984       * Returns an array of WordPress tables.
 985       *
 986       * Also allows for the CUSTOM_USER_TABLE and CUSTOM_USER_META_TABLE to override the WordPress users
 987       * and usermeta tables that would otherwise be determined by the prefix.
 988       *
 989       * The $scope argument can take one of the following:
 990       *
 991       * 'all' - returns 'all' and 'global' tables. No old tables are returned.
 992       * 'blog' - returns the blog-level tables for the queried blog.
 993       * 'global' - returns the global tables for the installation, returning multisite tables only on multisite.
 994       * 'ms_global' - returns the multisite global tables, regardless if current installation is multisite.
 995       * 'old' - returns tables which are deprecated.
 996       *
 997       * @since 3.0.0
 998       *
 999       * @uses wpdb::$tables
1000       * @uses wpdb::$old_tables
1001       * @uses wpdb::$global_tables
1002       * @uses wpdb::$ms_global_tables
1003       *
1004       * @param string $scope   Optional. Possible values include 'all', 'global', 'ms_global', 'blog',
1005       *                        or 'old' tables. Default 'all'.
1006       * @param bool   $prefix  Optional. Whether to include table prefixes. If blog prefix is requested,
1007       *                        then the custom users and usermeta tables will be mapped. Default true.
1008       * @param int    $blog_id Optional. The blog_id to prefix. Used only when prefix is requested.
1009       *                        Defaults to wpdb::$blogid.
1010       * @return array Table names. When a prefix is requested, the key is the unprefixed table name.
1011       */
1012  	public function tables( $scope = 'all', $prefix = true, $blog_id = 0 ) {
1013          switch ( $scope ) {
1014              case 'all':
1015                  $tables = array_merge( $this->global_tables, $this->tables );
1016                  if ( is_multisite() ) {
1017                      $tables = array_merge( $tables, $this->ms_global_tables );
1018                  }
1019                  break;
1020              case 'blog':
1021                  $tables = $this->tables;
1022                  break;
1023              case 'global':
1024                  $tables = $this->global_tables;
1025                  if ( is_multisite() ) {
1026                      $tables = array_merge( $tables, $this->ms_global_tables );
1027                  }
1028                  break;
1029              case 'ms_global':
1030                  $tables = $this->ms_global_tables;
1031                  break;
1032              case 'old':
1033                  $tables = $this->old_tables;
1034                  break;
1035              default:
1036                  return array();
1037          }
1038  
1039          if ( $prefix ) {
1040              if ( ! $blog_id ) {
1041                  $blog_id = $this->blogid;
1042              }
1043              $blog_prefix   = $this->get_blog_prefix( $blog_id );
1044              $base_prefix   = $this->base_prefix;
1045              $global_tables = array_merge( $this->global_tables, $this->ms_global_tables );
1046              foreach ( $tables as $k => $table ) {
1047                  if ( in_array( $table, $global_tables, true ) ) {
1048                      $tables[ $table ] = $base_prefix . $table;
1049                  } else {
1050                      $tables[ $table ] = $blog_prefix . $table;
1051                  }
1052                  unset( $tables[ $k ] );
1053              }
1054  
1055              if ( isset( $tables['users'] ) && defined( 'CUSTOM_USER_TABLE' ) ) {
1056                  $tables['users'] = CUSTOM_USER_TABLE;
1057              }
1058  
1059              if ( isset( $tables['usermeta'] ) && defined( 'CUSTOM_USER_META_TABLE' ) ) {
1060                  $tables['usermeta'] = CUSTOM_USER_META_TABLE;
1061              }
1062          }
1063  
1064          return $tables;
1065      }
1066  
1067      /**
1068       * Selects a database using the current database connection.
1069       *
1070       * The database name will be changed based on the current database connection.
1071       * On failure, the execution will bail and display a DB error.
1072       *
1073       * @since 0.71
1074       *
1075       * @param string        $db  MySQL database name.
1076       * @param resource|null $dbh Optional link identifier.
1077       */
1078  	public function select( $db, $dbh = null ) {
1079          if ( is_null( $dbh ) ) {
1080              $dbh = $this->dbh;
1081          }
1082  
1083          if ( $this->use_mysqli ) {
1084              $success = mysqli_select_db( $dbh, $db );
1085          } else {
1086              $success = mysql_select_db( $db, $dbh );
1087          }
1088          if ( ! $success ) {
1089              $this->ready = false;
1090              if ( ! did_action( 'template_redirect' ) ) {
1091                  wp_load_translations_early();
1092  
1093                  $message = '<h1>' . __( 'Can&#8217;t select database' ) . "</h1>\n";
1094  
1095                  $message .= '<p>' . sprintf(
1096                      /* translators: %s: Database name. */
1097                      __( 'We were able to connect to the database server (which means your username and password is okay) but not able to select the %s database.' ),
1098                      '<code>' . htmlspecialchars( $db, ENT_QUOTES ) . '</code>'
1099                  ) . "</p>\n";
1100  
1101                  $message .= "<ul>\n";
1102                  $message .= '<li>' . __( 'Are you sure it exists?' ) . "</li>\n";
1103  
1104                  $message .= '<li>' . sprintf(
1105                      /* translators: 1: Database user, 2: Database name. */
1106                      __( 'Does the user %1$s have permission to use the %2$s database?' ),
1107                      '<code>' . htmlspecialchars( $this->dbuser, ENT_QUOTES ) . '</code>',
1108                      '<code>' . htmlspecialchars( $db, ENT_QUOTES ) . '</code>'
1109                  ) . "</li>\n";
1110  
1111                  $message .= '<li>' . sprintf(
1112                      /* translators: %s: Database name. */
1113                      __( 'On some systems the name of your database is prefixed with your username, so it would be like <code>username_%1$s</code>. Could that be the problem?' ),
1114                      htmlspecialchars( $db, ENT_QUOTES )
1115                  ) . "</li>\n";
1116  
1117                  $message .= "</ul>\n";
1118  
1119                  $message .= '<p>' . sprintf(
1120                      /* translators: %s: Support forums URL. */
1121                      __( 'If you don&#8217;t know how to set up a database you should <strong>contact your host</strong>. If all else fails you may find help at the <a href="%s">WordPress Support Forums</a>.' ),
1122                      __( 'https://wordpress.org/support/forums/' )
1123                  ) . "</p>\n";
1124  
1125                  $this->bail( $message, 'db_select_fail' );
1126              }
1127          }
1128      }
1129  
1130      /**
1131       * Do not use, deprecated.
1132       *
1133       * Use esc_sql() or wpdb::prepare() instead.
1134       *
1135       * @since 2.8.0
1136       * @deprecated 3.6.0 Use wpdb::prepare()
1137       * @see wpdb::prepare()
1138       * @see esc_sql()
1139       *
1140       * @param string $string
1141       * @return string
1142       */
1143  	function _weak_escape( $string ) {
1144          if ( func_num_args() === 1 && function_exists( '_deprecated_function' ) ) {
1145              _deprecated_function( __METHOD__, '3.6.0', 'wpdb::prepare() or esc_sql()' );
1146          }
1147          return addslashes( $string );
1148      }
1149  
1150      /**
1151       * Real escape, using mysqli_real_escape_string() or mysql_real_escape_string().
1152       *
1153       * @since 2.8.0
1154       *
1155       * @see mysqli_real_escape_string()
1156       * @see mysql_real_escape_string()
1157       *
1158       * @param string $string String to escape.
1159       * @return string Escaped string.
1160       */
1161  	function _real_escape( $string ) {
1162          if ( ! is_scalar( $string ) && ! is_null( $string ) ) {
1163              return '';
1164          }
1165  
1166          if ( $this->dbh ) {
1167              if ( $this->use_mysqli ) {
1168                  $escaped = mysqli_real_escape_string( $this->dbh, $string );
1169              } else {
1170                  $escaped = mysql_real_escape_string( $string, $this->dbh );
1171              }
1172          } else {
1173              $class = get_class( $this );
1174              if ( function_exists( '__' ) ) {
1175                  /* translators: %s: Database access abstraction class, usually wpdb or a class extending wpdb. */
1176                  _doing_it_wrong( $class, sprintf( __( '%s must set a database connection for use with escaping.' ), $class ), '3.6.0' );
1177              } else {
1178                  _doing_it_wrong( $class, sprintf( '%s must set a database connection for use with escaping.', $class ), '3.6.0' );
1179              }
1180              $escaped = addslashes( $string );
1181          }
1182  
1183          return $this->add_placeholder_escape( $escaped );
1184      }
1185  
1186      /**
1187       * Escapes data. Works on arrays.
1188       *
1189       * @since 2.8.0
1190       *
1191       * @uses wpdb::_real_escape()
1192       *
1193       * @param string|array $data Data to escape.
1194       * @return string|array Escaped data, in the same type as supplied.
1195       */
1196  	public function _escape( $data ) {
1197          if ( is_array( $data ) ) {
1198              foreach ( $data as $k => $v ) {
1199                  if ( is_array( $v ) ) {
1200                      $data[ $k ] = $this->_escape( $v );
1201                  } else {
1202                      $data[ $k ] = $this->_real_escape( $v );
1203                  }
1204              }
1205          } else {
1206              $data = $this->_real_escape( $data );
1207          }
1208  
1209          return $data;
1210      }
1211  
1212      /**
1213       * Do not use, deprecated.
1214       *
1215       * Use esc_sql() or wpdb::prepare() instead.
1216       *
1217       * @since 0.71
1218       * @deprecated 3.6.0 Use wpdb::prepare()
1219       * @see wpdb::prepare()
1220       * @see esc_sql()
1221       *
1222       * @param string|array $data Data to escape.
1223       * @return string|array Escaped data, in the same type as supplied.
1224       */
1225  	public function escape( $data ) {
1226          if ( func_num_args() === 1 && function_exists( '_deprecated_function' ) ) {
1227              _deprecated_function( __METHOD__, '3.6.0', 'wpdb::prepare() or esc_sql()' );
1228          }
1229          if ( is_array( $data ) ) {
1230              foreach ( $data as $k => $v ) {
1231                  if ( is_array( $v ) ) {
1232                      $data[ $k ] = $this->escape( $v, 'recursive' );
1233                  } else {
1234                      $data[ $k ] = $this->_weak_escape( $v, 'internal' );
1235                  }
1236              }
1237          } else {
1238              $data = $this->_weak_escape( $data, 'internal' );
1239          }
1240  
1241          return $data;
1242      }
1243  
1244      /**
1245       * Escapes content by reference for insertion into the database, for security.
1246       *
1247       * @uses wpdb::_real_escape()
1248       *
1249       * @since 2.3.0
1250       *
1251       * @param string $string String to escape.
1252       */
1253  	public function escape_by_ref( &$string ) {
1254          if ( ! is_float( $string ) ) {
1255              $string = $this->_real_escape( $string );
1256          }
1257      }
1258  
1259      /**
1260       * Prepares a SQL query for safe execution.
1261       *
1262       * Uses sprintf()-like syntax. The following placeholders can be used in the query string:
1263       *   %d (integer)
1264       *   %f (float)
1265       *   %s (string)
1266       *
1267       * All placeholders MUST be left unquoted in the query string. A corresponding argument
1268       * MUST be passed for each placeholder.
1269       *
1270       * Note: There is one exception to the above: for compatibility with old behavior,
1271       * numbered or formatted string placeholders (eg, %1$s, %5s) will not have quotes
1272       * added by this function, so should be passed with appropriate quotes around them.
1273       *
1274       * Literal percentage signs (%) in the query string must be written as %%. Percentage wildcards
1275       * (for example, to use in LIKE syntax) must be passed via a substitution argument containing
1276       * the complete LIKE string, these cannot be inserted directly in the query string.
1277       * Also see wpdb::esc_like().
1278       *
1279       * Arguments may be passed as individual arguments to the method, or as a single array
1280       * containing all arguments. A combination of the two is not supported.
1281       *
1282       * Examples:
1283       *     $wpdb->prepare( "SELECT * FROM `table` WHERE `column` = %s AND `field` = %d OR `other_field` LIKE %s", array( 'foo', 1337, '%bar' ) );
1284       *     $wpdb->prepare( "SELECT DATE_FORMAT(`field`, '%%c') FROM `table` WHERE `column` = %s", 'foo' );
1285       *
1286       * @since 2.3.0
1287       * @since 5.3.0 Formalized the existing and already documented `...$args` parameter
1288       *              by updating the function signature. The second parameter was changed
1289       *              from `$args` to `...$args`.
1290       *
1291       * @link https://www.php.net/sprintf Description of syntax.
1292       *
1293       * @param string      $query   Query statement with sprintf()-like placeholders.
1294       * @param array|mixed $args    The array of variables to substitute into the query's placeholders
1295       *                             if being called with an array of arguments, or the first variable
1296       *                             to substitute into the query's placeholders if being called with
1297       *                             individual arguments.
1298       * @param mixed       ...$args Further variables to substitute into the query's placeholders
1299       *                             if being called with individual arguments.
1300       * @return string|void Sanitized query string, if there is a query to prepare.
1301       */
1302  	public function prepare( $query, ...$args ) {
1303          if ( is_null( $query ) ) {
1304              return;
1305          }
1306  
1307          // This is not meant to be foolproof -- but it will catch obviously incorrect usage.
1308          if ( strpos( $query, '%' ) === false ) {
1309              wp_load_translations_early();
1310              _doing_it_wrong(
1311                  'wpdb::prepare',
1312                  sprintf(
1313                      /* translators: %s: wpdb::prepare() */
1314                      __( 'The query argument of %s must have a placeholder.' ),
1315                      'wpdb::prepare()'
1316                  ),
1317                  '3.9.0'
1318              );
1319          }
1320  
1321          // If args were passed as an array (as in vsprintf), move them up.
1322          $passed_as_array = false;
1323          if ( is_array( $args[0] ) && count( $args ) === 1 ) {
1324              $passed_as_array = true;
1325              $args            = $args[0];
1326          }
1327  
1328          foreach ( $args as $arg ) {
1329              if ( ! is_scalar( $arg ) && ! is_null( $arg ) ) {
1330                  wp_load_translations_early();
1331                  _doing_it_wrong(
1332                      'wpdb::prepare',
1333                      sprintf(
1334                          /* translators: %s: Value type. */
1335                          __( 'Unsupported value type (%s).' ),
1336                          gettype( $arg )
1337                      ),
1338                      '4.8.2'
1339                  );
1340              }
1341          }
1342  
1343          /*
1344           * Specify the formatting allowed in a placeholder. The following are allowed:
1345           *
1346           * - Sign specifier. eg, $+d
1347           * - Numbered placeholders. eg, %1$s
1348           * - Padding specifier, including custom padding characters. eg, %05s, %'#5s
1349           * - Alignment specifier. eg, %05-s
1350           * - Precision specifier. eg, %.2f
1351           */
1352          $allowed_format = '(?:[1-9][0-9]*[$])?[-+0-9]*(?: |0|\'.)?[-+0-9]*(?:\.[0-9]+)?';
1353  
1354          /*
1355           * If a %s placeholder already has quotes around it, removing the existing quotes and re-inserting them
1356           * ensures the quotes are consistent.
1357           *
1358           * For backward compatibility, this is only applied to %s, and not to placeholders like %1$s, which are frequently
1359           * used in the middle of longer strings, or as table name placeholders.
1360           */
1361          $query = str_replace( "'%s'", '%s', $query ); // Strip any existing single quotes.
1362          $query = str_replace( '"%s"', '%s', $query ); // Strip any existing double quotes.
1363          $query = preg_replace( '/(?<!%)%s/', "'%s'", $query ); // Quote the strings, avoiding escaped strings like %%s.
1364  
1365          $query = preg_replace( "/(?<!%)(%($allowed_format)?f)/", '%\\2F', $query ); // Force floats to be locale-unaware.
1366  
1367          $query = preg_replace( "/%(?:%|$|(?!($allowed_format)?[sdF]))/", '%%\\1', $query ); // Escape any unescaped percents.
1368  
1369          // Count the number of valid placeholders in the query.
1370          $placeholders = preg_match_all( "/(^|[^%]|(%%)+)%($allowed_format)?[sdF]/", $query, $matches );
1371  
1372          $args_count = count( $args );
1373  
1374          if ( $args_count !== $placeholders ) {
1375              if ( 1 === $placeholders && $passed_as_array ) {
1376                  // If the passed query only expected one argument, but the wrong number of arguments were sent as an array, bail.
1377                  wp_load_translations_early();
1378                  _doing_it_wrong(
1379                      'wpdb::prepare',
1380                      __( 'The query only expected one placeholder, but an array of multiple placeholders was sent.' ),
1381                      '4.9.0'
1382                  );
1383  
1384                  return;
1385              } else {
1386                  /*
1387                   * If we don't have the right number of placeholders, but they were passed as individual arguments,
1388                   * or we were expecting multiple arguments in an array, throw a warning.
1389                   */
1390                  wp_load_translations_early();
1391                  _doing_it_wrong(
1392                      'wpdb::prepare',
1393                      sprintf(
1394                          /* translators: 1: Number of placeholders, 2: Number of arguments passed. */
1395                          __( 'The query does not contain the correct number of placeholders (%1$d) for the number of arguments passed (%2$d).' ),
1396                          $placeholders,
1397                          $args_count
1398                      ),
1399                      '4.8.3'
1400                  );
1401  
1402                  /*
1403                   * If we don't have enough arguments to match the placeholders,
1404                   * return an empty string to avoid a fatal error on PHP 8.
1405                   */
1406                  if ( $args_count < $placeholders ) {
1407                      $max_numbered_placeholder = ! empty( $matches[3] ) ? max( array_map( 'intval', $matches[3] ) ) : 0;
1408  
1409                      if ( ! $max_numbered_placeholder || $args_count < $max_numbered_placeholder ) {
1410                          return '';
1411                      }
1412                  }
1413              }
1414          }
1415  
1416          array_walk( $args, array( $this, 'escape_by_ref' ) );
1417          $query = vsprintf( $query, $args );
1418  
1419          return $this->add_placeholder_escape( $query );
1420      }
1421  
1422      /**
1423       * First half of escaping for LIKE special characters % and _ before preparing for MySQL.
1424       *
1425       * Use this only before wpdb::prepare() or esc_sql(). Reversing the order is very bad for security.
1426       *
1427       * Example Prepared Statement:
1428       *
1429       *     $wild = '%';
1430       *     $find = 'only 43% of planets';
1431       *     $like = $wild . $wpdb->esc_like( $find ) . $wild;
1432       *     $sql  = $wpdb->prepare( "SELECT * FROM $wpdb->posts WHERE post_content LIKE %s", $like );
1433       *
1434       * Example Escape Chain:
1435       *
1436       *     $sql  = esc_sql( $wpdb->esc_like( $input ) );
1437       *
1438       * @since 4.0.0
1439       *
1440       * @param string $text The raw text to be escaped. The input typed by the user
1441       *                     should have no extra or deleted slashes.
1442       * @return string Text in the form of a LIKE phrase. The output is not SQL safe.
1443       *                Call wpdb::prepare() or wpdb::_real_escape() next.
1444       */
1445  	public function esc_like( $text ) {
1446          return addcslashes( $text, '_%\\' );
1447      }
1448  
1449      /**
1450       * Prints SQL/DB error.
1451       *
1452       * @since 0.71
1453       *
1454       * @global array $EZSQL_ERROR Stores error information of query and error string.
1455       *
1456       * @param string $str The error to display.
1457       * @return void|false Void if the showing of errors is enabled, false if disabled.
1458       */
1459  	public function print_error( $str = '' ) {
1460          global $EZSQL_ERROR;
1461  
1462          if ( ! $str ) {
1463              if ( $this->use_mysqli ) {
1464                  $str = mysqli_error( $this->dbh );
1465              } else {
1466                  $str = mysql_error( $this->dbh );
1467              }
1468          }
1469          $EZSQL_ERROR[] = array(
1470              'query'     => $this->last_query,
1471              'error_str' => $str,
1472          );
1473  
1474          if ( $this->suppress_errors ) {
1475              return false;
1476          }
1477  
1478          wp_load_translations_early();
1479  
1480          $caller = $this->get_caller();
1481          if ( $caller ) {
1482              /* translators: 1: Database error message, 2: SQL query, 3: Name of the calling function. */
1483              $error_str = sprintf( __( 'WordPress database error %1$s for query %2$s made by %3$s' ), $str, $this->last_query, $caller );
1484          } else {
1485              /* translators: 1: Database error message, 2: SQL query. */
1486              $error_str = sprintf( __( 'WordPress database error %1$s for query %2$s' ), $str, $this->last_query );
1487          }
1488  
1489          error_log( $error_str );
1490  
1491          // Are we showing errors?
1492          if ( ! $this->show_errors ) {
1493              return false;
1494          }
1495  
1496          // If there is an error then take note of it.
1497          if ( is_multisite() ) {
1498              $msg = sprintf(
1499                  "%s [%s]\n%s\n",
1500                  __( 'WordPress database error:' ),
1501                  $str,
1502                  $this->last_query
1503              );
1504  
1505              if ( defined( 'ERRORLOGFILE' ) ) {
1506                  error_log( $msg, 3, ERRORLOGFILE );
1507              }
1508              if ( defined( 'DIEONDBERROR' ) ) {
1509                  wp_die( $msg );
1510              }
1511          } else {
1512              $str   = htmlspecialchars( $str, ENT_QUOTES );
1513              $query = htmlspecialchars( $this->last_query, ENT_QUOTES );
1514  
1515              printf(
1516                  '<div id="error"><p class="wpdberror"><strong>%s</strong> [%s]<br /><code>%s</code></p></div>',
1517                  __( 'WordPress database error:' ),
1518                  $str,
1519                  $query
1520              );
1521          }
1522      }
1523  
1524      /**
1525       * Enables showing of database errors.
1526       *
1527       * This function should be used only to enable showing of errors.
1528       * wpdb::hide_errors() should be used instead for hiding errors.
1529       *
1530       * @since 0.71
1531       *
1532       * @see wpdb::hide_errors()
1533       *
1534       * @param bool $show Optional. Whether to show errors. Default true.
1535       * @return bool Whether showing of errors was previously active.
1536       */
1537  	public function show_errors( $show = true ) {
1538          $errors            = $this->show_errors;
1539          $this->show_errors = $show;
1540          return $errors;
1541      }
1542  
1543      /**
1544       * Disables showing of database errors.
1545       *
1546       * By default database errors are not shown.
1547       *
1548       * @since 0.71
1549       *
1550       * @see wpdb::show_errors()
1551       *
1552       * @return bool Whether showing of errors was previously active.
1553       */
1554  	public function hide_errors() {
1555          $show              = $this->show_errors;
1556          $this->show_errors = false;
1557          return $show;
1558      }
1559  
1560      /**
1561       * Enables or disables suppressing of database errors.
1562       *
1563       * By default database errors are suppressed.
1564       *
1565       * @since 2.5.0
1566       *
1567       * @see wpdb::hide_errors()
1568       *
1569       * @param bool $suppress Optional. Whether to suppress errors. Default true.
1570       * @return bool Whether suppressing of errors was previously active.
1571       */
1572  	public function suppress_errors( $suppress = true ) {
1573          $errors                = $this->suppress_errors;
1574          $this->suppress_errors = (bool) $suppress;
1575          return $errors;
1576      }
1577  
1578      /**
1579       * Kills cached query results.
1580       *
1581       * @since 0.71
1582       */
1583  	public function flush() {
1584          $this->last_result   = array();
1585          $this->col_info      = null;
1586          $this->last_query    = null;
1587          $this->rows_affected = 0;
1588          $this->num_rows      = 0;
1589          $this->last_error    = '';
1590  
1591          if ( $this->use_mysqli && $this->result instanceof mysqli_result ) {
1592              mysqli_free_result( $this->result );
1593              $this->result = null;
1594  
1595              // Sanity check before using the handle.
1596              if ( empty( $this->dbh ) || ! ( $this->dbh instanceof mysqli ) ) {
1597                  return;
1598              }
1599  
1600              // Clear out any results from a multi-query.
1601              while ( mysqli_more_results( $this->dbh ) ) {
1602                  mysqli_next_result( $this->dbh );
1603              }
1604          } elseif ( is_resource( $this->result ) ) {
1605              mysql_free_result( $this->result );
1606          }
1607      }
1608  
1609      /**
1610       * Connects to and selects database.
1611       *
1612       * If $allow_bail is false, the lack of database connection will need to be handled manually.
1613       *
1614       * @since 3.0.0
1615       * @since 3.9.0 $allow_bail parameter added.
1616       *
1617       * @param bool $allow_bail Optional. Allows the function to bail. Default true.
1618       * @return bool True with a successful connection, false on failure.
1619       */
1620  	public function db_connect( $allow_bail = true ) {
1621          $this->is_mysql = true;
1622  
1623          /*
1624           * Deprecated in 3.9+ when using MySQLi. No equivalent
1625           * $new_link parameter exists for mysqli_* functions.
1626           */
1627          $new_link     = defined( 'MYSQL_NEW_LINK' ) ? MYSQL_NEW_LINK : true;
1628          $client_flags = defined( 'MYSQL_CLIENT_FLAGS' ) ? MYSQL_CLIENT_FLAGS : 0;
1629  
1630          if ( $this->use_mysqli ) {
1631              $this->dbh = mysqli_init();
1632  
1633              $host    = $this->dbhost;
1634              $port    = null;
1635              $socket  = null;
1636              $is_ipv6 = false;
1637  
1638              $host_data = $this->parse_db_host( $this->dbhost );
1639              if ( $host_data ) {
1640                  list( $host, $port, $socket, $is_ipv6 ) = $host_data;
1641              }
1642  
1643              /*
1644               * If using the `mysqlnd` library, the IPv6 address needs to be enclosed
1645               * in square brackets, whereas it doesn't while using the `libmysqlclient` library.
1646               * @see https://bugs.php.net/bug.php?id=67563
1647               */
1648              if ( $is_ipv6 && extension_loaded( 'mysqlnd' ) ) {
1649                  $host = "[$host]";
1650              }
1651  
1652              if ( WP_DEBUG ) {
1653                  mysqli_real_connect( $this->dbh, $host, $this->dbuser, $this->dbpassword, null, $port, $socket, $client_flags );
1654              } else {
1655                  // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
1656                  @mysqli_real_connect( $this->dbh, $host, $this->dbuser, $this->dbpassword, null, $port, $socket, $client_flags );
1657              }
1658  
1659              if ( $this->dbh->connect_errno ) {
1660                  $this->dbh = null;
1661  
1662                  /*
1663                   * It's possible ext/mysqli is misconfigured. Fall back to ext/mysql if:
1664                   *  - We haven't previously connected, and
1665                   *  - WP_USE_EXT_MYSQL isn't set to false, and
1666                   *  - ext/mysql is loaded.
1667                   */
1668                  $attempt_fallback = true;
1669  
1670                  if ( $this->has_connected ) {
1671                      $attempt_fallback = false;
1672                  } elseif ( defined( 'WP_USE_EXT_MYSQL' ) && ! WP_USE_EXT_MYSQL ) {
1673                      $attempt_fallback = false;
1674                  } elseif ( ! function_exists( 'mysql_connect' ) ) {
1675                      $attempt_fallback = false;
1676                  }
1677  
1678                  if ( $attempt_fallback ) {
1679                      $this->use_mysqli = false;
1680                      return $this->db_connect( $allow_bail );
1681                  }
1682              }
1683          } else {
1684              if ( WP_DEBUG ) {
1685                  $this->dbh = mysql_connect( $this->dbhost, $this->dbuser, $this->dbpassword, $new_link, $client_flags );
1686              } else {
1687                  // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
1688                  $this->dbh = @mysql_connect( $this->dbhost, $this->dbuser, $this->dbpassword, $new_link, $client_flags );
1689              }
1690          }
1691  
1692          if ( ! $this->dbh && $allow_bail ) {
1693              wp_load_translations_early();
1694  
1695              // Load custom DB error template, if present.
1696              if ( file_exists( WP_CONTENT_DIR . '/db-error.php' ) ) {
1697                  require_once WP_CONTENT_DIR . '/db-error.php';
1698                  die();
1699              }
1700  
1701              $message = '<h1>' . __( 'Error establishing a database connection' ) . "</h1>\n";
1702  
1703              $message .= '<p>' . sprintf(
1704                  /* translators: 1: wp-config.php, 2: Database host. */
1705                  __( 'This either means that the username and password information in your %1$s file is incorrect or we can&#8217;t contact the database server at %2$s. This could mean your host&#8217;s database server is down.' ),
1706                  '<code>wp-config.php</code>',
1707                  '<code>' . htmlspecialchars( $this->dbhost, ENT_QUOTES ) . '</code>'
1708              ) . "</p>\n";
1709  
1710              $message .= "<ul>\n";
1711              $message .= '<li>' . __( 'Are you sure you have the correct username and password?' ) . "</li>\n";
1712              $message .= '<li>' . __( 'Are you sure you have typed the correct hostname?' ) . "</li>\n";
1713              $message .= '<li>' . __( 'Are you sure the database server is running?' ) . "</li>\n";
1714              $message .= "</ul>\n";
1715  
1716              $message .= '<p>' . sprintf(
1717                  /* translators: %s: Support forums URL. */
1718                  __( 'If you&#8217;re unsure what these terms mean you should probably contact your host. If you still need help you can always visit the <a href="%s">WordPress Support Forums</a>.' ),
1719                  __( 'https://wordpress.org/support/forums/' )
1720              ) . "</p>\n";
1721  
1722              $this->bail( $message, 'db_connect_fail' );
1723  
1724              return false;
1725          } elseif ( $this->dbh ) {
1726              if ( ! $this->has_connected ) {
1727                  $this->init_charset();
1728              }
1729  
1730              $this->has_connected = true;
1731  
1732              $this->set_charset( $this->dbh );
1733  
1734              $this->ready = true;
1735              $this->set_sql_mode();
1736              $this->select( $this->dbname, $this->dbh );
1737  
1738              return true;
1739          }
1740  
1741          return false;
1742      }
1743  
1744      /**
1745       * Parses the DB_HOST setting to interpret it for mysqli_real_connect().
1746       *
1747       * mysqli_real_connect() doesn't support the host param including a port or socket
1748       * like mysql_connect() does. This duplicates how mysql_connect() detects a port
1749       * and/or socket file.
1750       *
1751       * @since 4.9.0
1752       *
1753       * @param string $host The DB_HOST setting to parse.
1754       * @return array|false Array containing the host, the port, the socket and
1755       *                     whether it is an IPv6 address, in that order.
1756       *                     False if $host couldn't be parsed.
1757       */
1758  	public function parse_db_host( $host ) {
1759          $port    = null;
1760          $socket  = null;
1761          $is_ipv6 = false;
1762  
1763          // First peel off the socket parameter from the right, if it exists.
1764          $socket_pos = strpos( $host, ':/' );
1765          if ( false !== $socket_pos ) {
1766              $socket = substr( $host, $socket_pos + 1 );
1767              $host   = substr( $host, 0, $socket_pos );
1768          }
1769  
1770          // We need to check for an IPv6 address first.
1771          // An IPv6 address will always contain at least two colons.
1772          if ( substr_count( $host, ':' ) > 1 ) {
1773              $pattern = '#^(?:\[)?(?P<host>[0-9a-fA-F:]+)(?:\]:(?P<port>[\d]+))?#';
1774              $is_ipv6 = true;
1775          } else {
1776              // We seem to be dealing with an IPv4 address.
1777              $pattern = '#^(?P<host>[^:/]*)(?::(?P<port>[\d]+))?#';
1778          }
1779  
1780          $matches = array();
1781          $result  = preg_match( $pattern, $host, $matches );
1782  
1783          if ( 1 !== $result ) {
1784              // Couldn't parse the address, bail.
1785              return false;
1786          }
1787  
1788          $host = '';
1789          foreach ( array( 'host', 'port' ) as $component ) {
1790              if ( ! empty( $matches[ $component ] ) ) {
1791                  $$component = $matches[ $component ];
1792              }
1793          }
1794  
1795          return array( $host, $port, $socket, $is_ipv6 );
1796      }
1797  
1798      /**
1799       * Checks that the connection to the database is still up. If not, try to reconnect.
1800       *
1801       * If this function is unable to reconnect, it will forcibly die, or if called
1802       * after the {@see 'template_redirect'} hook has been fired, return false instead.
1803       *
1804       * If $allow_bail is false, the lack of database connection will need to be handled manually.
1805       *
1806       * @since 3.9.0
1807       *
1808       * @param bool $allow_bail Optional. Allows the function to bail. Default true.
1809       * @return bool|void True if the connection is up.
1810       */
1811  	public function check_connection( $allow_bail = true ) {
1812          if ( $this->use_mysqli ) {
1813              if ( ! empty( $this->dbh ) && mysqli_ping( $this->dbh ) ) {
1814                  return true;
1815              }
1816          } else {
1817              if ( ! empty( $this->dbh ) && mysql_ping( $this->dbh ) ) {
1818                  return true;
1819              }
1820          }
1821  
1822          $error_reporting = false;
1823  
1824          // Disable warnings, as we don't want to see a multitude of "unable to connect" messages.
1825          if ( WP_DEBUG ) {
1826              $error_reporting = error_reporting();
1827              error_reporting( $error_reporting & ~E_WARNING );
1828          }
1829  
1830          for ( $tries = 1; $tries <= $this->reconnect_retries; $tries++ ) {
1831              // On the last try, re-enable warnings. We want to see a single instance
1832              // of the "unable to connect" message on the bail() screen, if it appears.
1833              if ( $this->reconnect_retries === $tries && WP_DEBUG ) {
1834                  error_reporting( $error_reporting );
1835              }
1836  
1837              if ( $this->db_connect( false ) ) {
1838                  if ( $error_reporting ) {
1839                      error_reporting( $error_reporting );
1840                  }
1841  
1842                  return true;
1843              }
1844  
1845              sleep( 1 );
1846          }
1847  
1848          // If template_redirect has already happened, it's too late for wp_die()/dead_db().
1849          // Let's just return and hope for the best.
1850          if ( did_action( 'template_redirect' ) ) {
1851              return false;
1852          }
1853  
1854          if ( ! $allow_bail ) {
1855              return false;
1856          }
1857  
1858          wp_load_translations_early();
1859  
1860          $message = '<h1>' . __( 'Error reconnecting to the database' ) . "</h1>\n";
1861  
1862          $message .= '<p>' . sprintf(
1863              /* translators: %s: Database host. */
1864              __( 'This means that we lost contact with the database server at %s. This could mean your host&#8217;s database server is down.' ),
1865              '<code>' . htmlspecialchars( $this->dbhost, ENT_QUOTES ) . '</code>'
1866          ) . "</p>\n";
1867  
1868          $message .= "<ul>\n";
1869          $message .= '<li>' . __( 'Are you sure the database server is running?' ) . "</li>\n";
1870          $message .= '<li>' . __( 'Are you sure the database server is not under particularly heavy load?' ) . "</li>\n";
1871          $message .= "</ul>\n";
1872  
1873          $message .= '<p>' . sprintf(
1874              /* translators: %s: Support forums URL. */
1875              __( 'If you&#8217;re unsure what these terms mean you should probably contact your host. If you still need help you can always visit the <a href="%s">WordPress Support Forums</a>.' ),
1876              __( 'https://wordpress.org/support/forums/' )
1877          ) . "</p>\n";
1878  
1879          // We weren't able to reconnect, so we better bail.
1880          $this->bail( $message, 'db_connect_fail' );
1881  
1882          // Call dead_db() if bail didn't die, because this database is no more.
1883          // It has ceased to be (at least temporarily).
1884          dead_db();
1885      }
1886  
1887      /**
1888       * Performs a MySQL database query, using current database connection.
1889       *
1890       * More information can be found on the Codex page.
1891       *
1892       * @since 0.71
1893       *
1894       * @link https://codex.wordpress.org/Function_Reference/wpdb_Class
1895       *
1896       * @param string $query Database query.
1897       * @return int|bool Boolean true for CREATE, ALTER, TRUNCATE and DROP queries. Number of rows
1898       *                  affected/selected for all other queries. Boolean false on error.
1899       */
1900  	public function query( $query ) {
1901          if ( ! $this->ready ) {
1902              $this->check_current_query = true;
1903              return false;
1904          }
1905  
1906          /**
1907           * Filters the database query.
1908           *
1909           * Some queries are made before the plugins have been loaded,
1910           * and thus cannot be filtered with this method.
1911           *
1912           * @since 2.1.0
1913           *
1914           * @param string $query Database query.
1915           */
1916          $query = apply_filters( 'query', $query );
1917  
1918          $this->flush();
1919  
1920          // Log how the function was called.
1921          $this->func_call = "\$db->query(\"$query\")";
1922  
1923          // If we're writing to the database, make sure the query will write safely.
1924          if ( $this->check_current_query && ! $this->check_ascii( $query ) ) {
1925              $stripped_query = $this->strip_invalid_text_from_query( $query );
1926              // strip_invalid_text_from_query() can perform queries, so we need
1927              // to flush again, just to make sure everything is clear.
1928              $this->flush();
1929              if ( $stripped_query !== $query ) {
1930                  $this->insert_id = 0;
1931                  return false;
1932              }
1933          }
1934  
1935          $this->check_current_query = true;
1936  
1937          // Keep track of the last query for debug.
1938          $this->last_query = $query;
1939  
1940          $this->_do_query( $query );
1941  
1942          // MySQL server has gone away, try to reconnect.
1943          $mysql_errno = 0;
1944          if ( ! empty( $this->dbh ) ) {
1945              if ( $this->use_mysqli ) {
1946                  if ( $this->dbh instanceof mysqli ) {
1947                      $mysql_errno = mysqli_errno( $this->dbh );
1948                  } else {
1949                      // $dbh is defined, but isn't a real connection.
1950                      // Something has gone horribly wrong, let's try a reconnect.
1951                      $mysql_errno = 2006;
1952                  }
1953              } else {
1954                  if ( is_resource( $this->dbh ) ) {
1955                      $mysql_errno = mysql_errno( $this->dbh );
1956                  } else {
1957                      $mysql_errno = 2006;
1958                  }
1959              }
1960          }
1961  
1962          if ( empty( $this->dbh ) || 2006 === $mysql_errno ) {
1963              if ( $this->check_connection() ) {
1964                  $this->_do_query( $query );
1965              } else {
1966                  $this->insert_id = 0;
1967                  return false;
1968              }
1969          }
1970  
1971          // If there is an error then take note of it.
1972          if ( $this->use_mysqli ) {
1973              if ( $this->dbh instanceof mysqli ) {
1974                  $this->last_error = mysqli_error( $this->dbh );
1975              } else {
1976                  $this->last_error = __( 'Unable to retrieve the error message from MySQL' );
1977              }
1978          } else {
1979              if ( is_resource( $this->dbh ) ) {
1980                  $this->last_error = mysql_error( $this->dbh );
1981              } else {
1982                  $this->last_error = __( 'Unable to retrieve the error message from MySQL' );
1983              }
1984          }
1985  
1986          if ( $this->last_error ) {
1987              // Clear insert_id on a subsequent failed insert.
1988              if ( $this->insert_id && preg_match( '/^\s*(insert|replace)\s/i', $query ) ) {
1989                  $this->insert_id = 0;
1990              }
1991  
1992              $this->print_error();
1993              return false;
1994          }
1995  
1996          if ( preg_match( '/^\s*(create|alter|truncate|drop)\s/i', $query ) ) {
1997              $return_val = $this->result;
1998          } elseif ( preg_match( '/^\s*(insert|delete|update|replace)\s/i', $query ) ) {
1999              if ( $this->use_mysqli ) {
2000                  $this->rows_affected = mysqli_affected_rows( $this->dbh );
2001              } else {
2002                  $this->rows_affected = mysql_affected_rows( $this->dbh );
2003              }
2004              // Take note of the insert_id.
2005              if ( preg_match( '/^\s*(insert|replace)\s/i', $query ) ) {
2006                  if ( $this->use_mysqli ) {
2007                      $this->insert_id = mysqli_insert_id( $this->dbh );
2008                  } else {
2009                      $this->insert_id = mysql_insert_id( $this->dbh );
2010                  }
2011              }
2012              // Return number of rows affected.
2013              $return_val = $this->rows_affected;
2014          } else {
2015              $num_rows = 0;
2016              if ( $this->use_mysqli && $this->result instanceof mysqli_result ) {
2017                  while ( $row = mysqli_fetch_object( $this->result ) ) {
2018                      $this->last_result[ $num_rows ] = $row;
2019                      $num_rows++;
2020                  }
2021              } elseif ( is_resource( $this->result ) ) {
2022                  while ( $row = mysql_fetch_object( $this->result ) ) {
2023                      $this->last_result[ $num_rows ] = $row;
2024                      $num_rows++;
2025                  }
2026              }
2027  
2028              // Log and return the number of rows selected.
2029              $this->num_rows = $num_rows;
2030              $return_val     = $num_rows;
2031          }
2032  
2033          return $return_val;
2034      }
2035  
2036      /**
2037       * Internal function to perform the mysql_query() call.
2038       *
2039       * @since 3.9.0
2040       *
2041       * @see wpdb::query()
2042       *
2043       * @param string $query The query to run.
2044       */
2045  	private function _do_query( $query ) {
2046          if ( defined( 'SAVEQUERIES' ) && SAVEQUERIES ) {
2047              $this->timer_start();
2048          }
2049  
2050          if ( ! empty( $this->dbh ) && $this->use_mysqli ) {
2051              $this->result = mysqli_query( $this->dbh, $query );
2052          } elseif ( ! empty( $this->dbh ) ) {
2053              $this->result = mysql_query( $query, $this->dbh );
2054          }
2055          $this->num_queries++;
2056  
2057          if ( defined( 'SAVEQUERIES' ) && SAVEQUERIES ) {
2058              $this->log_query(
2059                  $query,
2060                  $this->timer_stop(),
2061                  $this->get_caller(),
2062                  $this->time_start,
2063                  array()
2064              );
2065          }
2066      }
2067  
2068      /**
2069       * Logs query data.
2070       *
2071       * @since 5.3.0
2072       *
2073       * @param string $query           The query's SQL.
2074       * @param float  $query_time      Total time spent on the query, in seconds.
2075       * @param string $query_callstack Comma-separated list of the calling functions.
2076       * @param float  $query_start     Unix timestamp of the time at the start of the query.
2077       * @param array  $query_data      Custom query data.
2078       */
2079  	public function log_query( $query, $query_time, $query_callstack, $query_start, $query_data ) {
2080          /**
2081           * Filters the custom query data being logged.
2082           *
2083           * Caution should be used when modifying any of this data, it is recommended that any additional
2084           * information you need to store about a query be added as a new associative entry to the fourth
2085           * element $query_data.
2086           *
2087           * @since 5.3.0
2088           *
2089           * @param array  $query_data      Custom query data.
2090           * @param string $query           The query's SQL.
2091           * @param float  $query_time      Total time spent on the query, in seconds.
2092           * @param string $query_callstack Comma-separated list of the calling functions.
2093           * @param float  $query_start     Unix timestamp of the time at the start of the query.
2094           */
2095          $query_data = apply_filters( 'log_query_custom_data', $query_data, $query, $query_time, $query_callstack, $query_start );
2096  
2097          $this->queries[] = array(
2098              $query,
2099              $query_time,
2100              $query_callstack,
2101              $query_start,
2102              $query_data,
2103          );
2104      }
2105  
2106      /**
2107       * Generates and returns a placeholder escape string for use in queries returned by ::prepare().
2108       *
2109       * @since 4.8.3
2110       *
2111       * @return string String to escape placeholders.
2112       */
2113  	public function placeholder_escape() {
2114          static $placeholder;
2115  
2116          if ( ! $placeholder ) {
2117              // If ext/hash is not present, compat.php's hash_hmac() does not support sha256.
2118              $algo = function_exists( 'hash' ) ? 'sha256' : 'sha1';
2119              // Old WP installs may not have AUTH_SALT defined.
2120              $salt = defined( 'AUTH_SALT' ) && AUTH_SALT ? AUTH_SALT : (string) rand();
2121  
2122              $placeholder = '{' . hash_hmac( $algo, uniqid( $salt, true ), $salt ) . '}';
2123          }
2124  
2125          /*
2126           * Add the filter to remove the placeholder escaper. Uses priority 0, so that anything
2127           * else attached to this filter will receive the query with the placeholder string removed.
2128           */
2129          if ( false === has_filter( 'query', array( $this, 'remove_placeholder_escape' ) ) ) {
2130              add_filter( 'query', array( $this, 'remove_placeholder_escape' ), 0 );
2131          }
2132  
2133          return $placeholder;
2134      }
2135  
2136      /**
2137       * Adds a placeholder escape string, to escape anything that resembles a printf() placeholder.
2138       *
2139       * @since 4.8.3
2140       *
2141       * @param string $query The query to escape.
2142       * @return string The query with the placeholder escape string inserted where necessary.
2143       */
2144  	public function add_placeholder_escape( $query ) {
2145          /*
2146           * To prevent returning anything that even vaguely resembles a placeholder,
2147           * we clobber every % we can find.
2148           */
2149          return str_replace( '%', $this->placeholder_escape(), $query );
2150      }
2151  
2152      /**
2153       * Removes the placeholder escape strings from a query.
2154       *
2155       * @since 4.8.3
2156       *
2157       * @param string $query The query from which the placeholder will be removed.
2158       * @return string The query with the placeholder removed.
2159       */
2160  	public function remove_placeholder_escape( $query ) {
2161          return str_replace( $this->placeholder_escape(), '%', $query );
2162      }
2163  
2164      /**
2165       * Inserts a row into the table.
2166       *
2167       * Examples:
2168       *     wpdb::insert( 'table', array( 'column' => 'foo', 'field' => 'bar' ) )
2169       *     wpdb::insert( 'table', array( 'column' => 'foo', 'field' => 1337 ), array( '%s', '%d' ) )
2170       *
2171       * @since 2.5.0
2172       *
2173       * @see wpdb::prepare()
2174       * @see wpdb::$field_types
2175       * @see wp_set_wpdb_vars()
2176       *
2177       * @param string       $table  Table name.
2178       * @param array        $data   Data to insert (in column => value pairs).
2179       *                             Both $data columns and $data values should be "raw" (neither should be SQL escaped).
2180       *                             Sending a null value will cause the column to be set to NULL - the corresponding
2181       *                             format is ignored in this case.
2182       * @param array|string $format Optional. An array of formats to be mapped to each of the value in $data.
2183       *                             If string, that format will be used for all of the values in $data.
2184       *                             A format is one of '%d', '%f', '%s' (integer, float, string).
2185       *                             If omitted, all values in $data will be treated as strings unless otherwise
2186       *                             specified in wpdb::$field_types.
2187       * @return int|false The number of rows inserted, or false on error.
2188       */
2189  	public function insert( $table, $data, $format = null ) {
2190          return $this->_insert_replace_helper( $table, $data, $format, 'INSERT' );
2191      }
2192  
2193      /**
2194       * Replaces a row in the table.
2195       *
2196       * Examples:
2197       *     wpdb::replace( 'table', array( 'column' => 'foo', 'field' => 'bar' ) )
2198       *     wpdb::replace( 'table', array( 'column' => 'foo', 'field' => 1337 ), array( '%s', '%d' ) )
2199       *
2200       * @since 3.0.0
2201       *
2202       * @see wpdb::prepare()
2203       * @see wpdb::$field_types
2204       * @see wp_set_wpdb_vars()
2205       *
2206       * @param string       $table  Table name.
2207       * @param array        $data   Data to insert (in column => value pairs).
2208       *                             Both $data columns and $data values should be "raw" (neither should be SQL escaped).
2209       *                             Sending a null value will cause the column to be set to NULL - the corresponding
2210       *                             format is ignored in this case.
2211       * @param array|string $format Optional. An array of formats to be mapped to each of the value in $data.
2212       *                             If string, that format will be used for all of the values in $data.
2213       *                             A format is one of '%d', '%f', '%s' (integer, float, string).
2214       *                             If omitted, all values in $data will be treated as strings unless otherwise
2215       *                             specified in wpdb::$field_types.
2216       * @return int|false The number of rows affected, or false on error.
2217       */
2218  	public function replace( $table, $data, $format = null ) {
2219          return $this->_insert_replace_helper( $table, $data, $format, 'REPLACE' );
2220      }
2221  
2222      /**
2223       * Helper function for insert and replace.
2224       *
2225       * Runs an insert or replace query based on $type argument.
2226       *
2227       * @since 3.0.0
2228       *
2229       * @see wpdb::prepare()
2230       * @see wpdb::$field_types
2231       * @see wp_set_wpdb_vars()
2232       *
2233       * @param string       $table  Table name.
2234       * @param array        $data   Data to insert (in column => value pairs).
2235       *                             Both $data columns and $data values should be "raw" (neither should be SQL escaped).
2236       *                             Sending a null value will cause the column to be set to NULL - the corresponding
2237       *                             format is ignored in this case.
2238       * @param array|string $format Optional. An array of formats to be mapped to each of the value in $data.
2239       *                             If string, that format will be used for all of the values in $data.
2240       *                             A format is one of '%d', '%f', '%s' (integer, float, string).
2241       *                             If omitted, all values in $data will be treated as strings unless otherwise
2242       *                             specified in wpdb::$field_types.
2243       * @param string       $type   Optional. Type of operation. Possible values include 'INSERT' or 'REPLACE'.
2244       *                             Default 'INSERT'.
2245       * @return int|false The number of rows affected, or false on error.
2246       */
2247  	function _insert_replace_helper( $table, $data, $format = null, $type = 'INSERT' ) {
2248          $this->insert_id = 0;
2249  
2250          if ( ! in_array( strtoupper( $type ), array( 'REPLACE', 'INSERT' ), true ) ) {
2251              return false;
2252          }
2253  
2254          $data = $this->process_fields( $table, $data, $format );
2255          if ( false === $data ) {
2256              return false;
2257          }
2258  
2259          $formats = array();
2260          $values  = array();
2261          foreach ( $data as $value ) {
2262              if ( is_null( $value['value'] ) ) {
2263                  $formats[] = 'NULL';
2264                  continue;
2265              }
2266  
2267              $formats[] = $value['format'];
2268              $values[]  = $value['value'];
2269          }
2270  
2271          $fields  = '`' . implode( '`, `', array_keys( $data ) ) . '`';
2272          $formats = implode( ', ', $formats );
2273  
2274          $sql = "$type INTO `$table` ($fields) VALUES ($formats)";
2275  
2276          $this->check_current_query = false;
2277          return $this->query( $this->prepare( $sql, $values ) );
2278      }
2279  
2280      /**
2281       * Updates a row in the table.
2282       *
2283       * Examples:
2284       *     wpdb::update( 'table', array( 'column' => 'foo', 'field' => 'bar' ), array( 'ID' => 1 ) )
2285       *     wpdb::update( 'table', array( 'column' => 'foo', 'field' => 1337 ), array( 'ID' => 1 ), array( '%s', '%d' ), array( '%d' ) )
2286       *
2287       * @since 2.5.0
2288       *
2289       * @see wpdb::prepare()
2290       * @see wpdb::$field_types
2291       * @see wp_set_wpdb_vars()
2292       *
2293       * @param string       $table        Table name.
2294       * @param array        $data         Data to update (in column => value pairs).
2295       *                                   Both $data columns and $data values should be "raw" (neither should be SQL escaped).
2296       *                                   Sending a null value will cause the column to be set to NULL - the corresponding
2297       *                                   format is ignored in this case.
2298       * @param array        $where        A named array of WHERE clauses (in column => value pairs).
2299       *                                   Multiple clauses will be joined with ANDs.
2300       *                                   Both $where columns and $where values should be "raw".
2301       *                                   Sending a null value will create an IS NULL comparison - the corresponding
2302       *                                   format will be ignored in this case.
2303       * @param array|string $format       Optional. An array of formats to be mapped to each of the values in $data.
2304       *                                   If string, that format will be used for all of the values in $data.
2305       *                                   A format is one of '%d', '%f', '%s' (integer, float, string).
2306       *                                   If omitted, all values in $data will be treated as strings unless otherwise
2307       *                                   specified in wpdb::$field_types.
2308       * @param array|string $where_format Optional. An array of formats to be mapped to each of the values in $where.
2309       *                                   If string, that format will be used for all of the items in $where.
2310       *                                   A format is one of '%d', '%f', '%s' (integer, float, string).
2311       *                                   If omitted, all values in $where will be treated as strings.
2312       * @return int|false The number of rows updated, or false on error.
2313       */
2314  	public function update( $table, $data, $where, $format = null, $where_format = null ) {
2315          if ( ! is_array( $data ) || ! is_array( $where ) ) {
2316              return false;
2317          }
2318  
2319          $data = $this->process_fields( $table, $data, $format );
2320          if ( false === $data ) {
2321              return false;
2322          }
2323          $where = $this->process_fields( $table, $where, $where_format );
2324          if ( false === $where ) {
2325              return false;
2326          }
2327  
2328          $fields     = array();
2329          $conditions = array();
2330          $values     = array();
2331          foreach ( $data as $field => $value ) {
2332              if ( is_null( $value['value'] ) ) {
2333                  $fields[] = "`$field` = NULL";
2334                  continue;
2335              }
2336  
2337              $fields[] = "`$field` = " . $value['format'];
2338              $values[] = $value['value'];
2339          }
2340          foreach ( $where as $field => $value ) {
2341              if ( is_null( $value['value'] ) ) {
2342                  $conditions[] = "`$field` IS NULL";
2343                  continue;
2344              }
2345  
2346              $conditions[] = "`$field` = " . $value['format'];
2347              $values[]     = $value['value'];
2348          }
2349  
2350          $fields     = implode( ', ', $fields );
2351          $conditions = implode( ' AND ', $conditions );
2352  
2353          $sql = "UPDATE `$table` SET $fields WHERE $conditions";
2354  
2355          $this->check_current_query = false;
2356          return $this->query( $this->prepare( $sql, $values ) );
2357      }
2358  
2359      /**
2360       * Deletes a row in the table.
2361       *
2362       * Examples:
2363       *     wpdb::delete( 'table', array( 'ID' => 1 ) )
2364       *     wpdb::delete( 'table', array( 'ID' => 1 ), array( '%d' ) )
2365       *
2366       * @since 3.4.0
2367       *
2368       * @see wpdb::prepare()
2369       * @see wpdb::$field_types
2370       * @see wp_set_wpdb_vars()
2371       *
2372       * @param string       $table        Table name.
2373       * @param array        $where        A named array of WHERE clauses (in column => value pairs).
2374       *                                   Multiple clauses will be joined with ANDs.
2375       *                                   Both $where columns and $where values should be "raw".
2376       *                                   Sending a null value will create an IS NULL comparison - the corresponding
2377       *                                   format will be ignored in this case.
2378       * @param array|string $where_format Optional. An array of formats to be mapped to each of the values in $where.
2379       *                                   If string, that format will be used for all of the items in $where.
2380       *                                   A format is one of '%d', '%f', '%s' (integer, float, string).
2381       *                                   If omitted, all values in $data will be treated as strings unless otherwise
2382       *                                   specified in wpdb::$field_types.
2383       * @return int|false The number of rows updated, or false on error.
2384       */
2385  	public function delete( $table, $where, $where_format = null ) {
2386          if ( ! is_array( $where ) ) {
2387              return false;
2388          }
2389  
2390          $where = $this->process_fields( $table, $where, $where_format );
2391          if ( false === $where ) {
2392              return false;
2393          }
2394  
2395          $conditions = array();
2396          $values     = array();
2397          foreach ( $where as $field => $value ) {
2398              if ( is_null( $value['value'] ) ) {
2399                  $conditions[] = "`$field` IS NULL";
2400                  continue;
2401              }
2402  
2403              $conditions[] = "`$field` = " . $value['format'];
2404              $values[]     = $value['value'];
2405          }
2406  
2407          $conditions = implode( ' AND ', $conditions );
2408  
2409          $sql = "DELETE FROM `$table` WHERE $conditions";
2410  
2411          $this->check_current_query = false;
2412          return $this->query( $this->prepare( $sql, $values ) );
2413      }
2414  
2415      /**
2416       * Processes arrays of field/value pairs and field formats.
2417       *
2418       * This is a helper method for wpdb's CRUD methods, which take field/value pairs
2419       * for inserts, updates, and where clauses. This method first pairs each value
2420       * with a format. Then it determines the charset of that field, using that
2421       * to determine if any invalid text would be stripped. If text is stripped,
2422       * then field processing is rejected and the query fails.
2423       *
2424       * @since 4.2.0
2425       *
2426       * @param string $table  Table name.
2427       * @param array  $data   Field/value pair.
2428       * @param mixed  $format Format for each field.
2429       * @return array|false An array of fields that contain paired value and formats.
2430       *                     False for invalid values.
2431       */
2432  	protected function process_fields( $table, $data, $format ) {
2433          $data = $this->process_field_formats( $data, $format );
2434          if ( false === $data ) {
2435              return false;
2436          }
2437  
2438          $data = $this->process_field_charsets( $data, $table );
2439          if ( false === $data ) {
2440              return false;
2441          }
2442  
2443          $data = $this->process_field_lengths( $data, $table );
2444          if ( false === $data ) {
2445              return false;
2446          }
2447  
2448          $converted_data = $this->strip_invalid_text( $data );
2449  
2450          if ( $data !== $converted_data ) {
2451              return false;
2452          }
2453  
2454          return $data;
2455      }
2456  
2457      /**
2458       * Prepares arrays of value/format pairs as passed to wpdb CRUD methods.
2459       *
2460       * @since 4.2.0
2461       *
2462       * @param array $data   Array of fields to values.
2463       * @param mixed $format Formats to be mapped to the values in $data.
2464       * @return array Array, keyed by field names with values being an array
2465       *               of 'value' and 'format' keys.
2466       */
2467  	protected function process_field_formats( $data, $format ) {
2468          $formats          = (array) $format;
2469          $original_formats = $formats;
2470  
2471          foreach ( $data as $field => $value ) {
2472              $value = array(
2473                  'value'  => $value,
2474                  'format' => '%s',
2475              );
2476  
2477              if ( ! empty( $format ) ) {
2478                  $value['format'] = array_shift( $formats );
2479                  if ( ! $value['format'] ) {
2480                      $value['format'] = reset( $original_formats );
2481                  }
2482              } elseif ( isset( $this->field_types[ $field ] ) ) {
2483                  $value['format'] = $this->field_types[ $field ];
2484              }
2485  
2486              $data[ $field ] = $value;
2487          }
2488  
2489          return $data;
2490      }
2491  
2492      /**
2493       * Adds field charsets to field/value/format arrays generated by wpdb::process_field_formats().
2494       *
2495       * @since 4.2.0
2496       *
2497       * @param array  $data  As it comes from the wpdb::process_field_formats() method.
2498       * @param string $table Table name.
2499       * @return array|false The same array as $data with additional 'charset' keys.
2500       *                     False on failure.
2501       */
2502  	protected function process_field_charsets( $data, $table ) {
2503          foreach ( $data as $field => $value ) {
2504              if ( '%d' === $value['format'] || '%f' === $value['format'] ) {
2505                  /*
2506                   * We can skip this field if we know it isn't a string.
2507                   * This checks %d/%f versus ! %s because its sprintf() could take more.
2508                   */
2509                  $value['charset'] = false;
2510              } else {
2511                  $value['charset'] = $this->get_col_charset( $table, $field );
2512                  if ( is_wp_error( $value['charset'] ) ) {
2513                      return false;
2514                  }
2515              }
2516  
2517              $data[ $field ] = $value;
2518          }
2519  
2520          return $data;
2521      }
2522  
2523      /**
2524       * For string fields, records the maximum string length that field can safely save.
2525       *
2526       * @since 4.2.1
2527       *
2528       * @param array  $data  As it comes from the wpdb::process_field_charsets() method.
2529       * @param string $table Table name.
2530       * @return array|false The same array as $data with additional 'length' keys, or false if
2531       *                     any of the values were too long for their corresponding field.
2532       */
2533  	protected function process_field_lengths( $data, $table ) {
2534          foreach ( $data as $field => $value ) {
2535              if ( '%d' === $value['format'] || '%f' === $value['format'] ) {
2536                  /*
2537                   * We can skip this field if we know it isn't a string.
2538                   * This checks %d/%f versus ! %s because its sprintf() could take more.
2539                   */
2540                  $value['length'] = false;
2541              } else {
2542                  $value['length'] = $this->get_col_length( $table, $field );
2543                  if ( is_wp_error( $value['length'] ) ) {
2544                      return false;
2545                  }
2546              }
2547  
2548              $data[ $field ] = $value;
2549          }
2550  
2551          return $data;
2552      }
2553  
2554      /**
2555       * Retrieves one variable from the database.
2556       *
2557       * Executes a SQL query and returns the value from the SQL result.
2558       * If the SQL result contains more than one column and/or more than one row,
2559       * the value in the column and row specified is returned. If $query is null,
2560       * the value in the specified column and row from the previous SQL result is returned.
2561       *
2562       * @since 0.71
2563       *
2564       * @param string|null $query Optional. SQL query. Defaults to null, use the result from the previous query.
2565       * @param int         $x     Optional. Column of value to return. Indexed from 0.
2566       * @param int         $y     Optional. Row of value to return. Indexed from 0.
2567       * @return string|null Database query result (as string), or null on failure.
2568       */
2569  	public function get_var( $query = null, $x = 0, $y = 0 ) {
2570          $this->func_call = "\$db->get_var(\"$query\", $x, $y)";
2571  
2572          if ( $this->check_current_query && $this->check_safe_collation( $query ) ) {
2573              $this->check_current_query = false;
2574          }
2575  
2576          if ( $query ) {
2577              $this->query( $query );
2578          }
2579  
2580          // Extract var out of cached results based on x,y vals.
2581          if ( ! empty( $this->last_result[ $y ] ) ) {
2582              $values = array_values( get_object_vars( $this->last_result[ $y ] ) );
2583          }
2584  
2585          // If there is a value return it, else return null.
2586          return ( isset( $values[ $x ] ) && '' !== $values[ $x ] ) ? $values[ $x ] : null;
2587      }
2588  
2589      /**
2590       * Retrieves one row from the database.
2591       *
2592       * Executes a SQL query and returns the row from the SQL result.
2593       *
2594       * @since 0.71
2595       *
2596       * @param string|null $query  SQL query.
2597       * @param string      $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which
2598       *                            correspond to an stdClass object, an associative array, or a numeric array,
2599       *                            respectively. Default OBJECT.
2600       * @param int         $y      Optional. Row to return. Indexed from 0.
2601       * @return array|object|null|void Database query result in format specified by $output or null on failure.
2602       */
2603  	public function get_row( $query = null, $output = OBJECT, $y = 0 ) {
2604          $this->func_call = "\$db->get_row(\"$query\",$output,$y)";
2605  
2606          if ( $this->check_current_query && $this->check_safe_collation( $query ) ) {
2607              $this->check_current_query = false;
2608          }
2609  
2610          if ( $query ) {
2611              $this->query( $query );
2612          } else {
2613              return null;
2614          }
2615  
2616          if ( ! isset( $this->last_result[ $y ] ) ) {
2617              return null;
2618          }
2619  
2620          if ( OBJECT === $output ) {
2621              return $this->last_result[ $y ] ? $this->last_result[ $y ] : null;
2622          } elseif ( ARRAY_A === $output ) {
2623              return $this->last_result[ $y ] ? get_object_vars( $this->last_result[ $y ] ) : null;
2624          } elseif ( ARRAY_N === $output ) {
2625              return $this->last_result[ $y ] ? array_values( get_object_vars( $this->last_result[ $y ] ) ) : null;
2626          } elseif ( OBJECT === strtoupper( $output ) ) {
2627              // Back compat for OBJECT being previously case-insensitive.
2628              return $this->last_result[ $y ] ? $this->last_result[ $y ] : null;
2629          } else {
2630              $this->print_error( ' $db->get_row(string query, output type, int offset) -- Output type must be one of: OBJECT, ARRAY_A, ARRAY_N' );
2631          }
2632      }
2633  
2634      /**
2635       * Retrieves one column from the database.
2636       *
2637       * Executes a SQL query and returns the column from the SQL result.
2638       * If the SQL result contains more than one column, the column specified is returned.
2639       * If $query is null, the specified column from the previous SQL result is returned.
2640       *
2641       * @since 0.71
2642       *
2643       * @param string|null $query Optional. SQL query. Defaults to previous query.
2644       * @param int         $x     Optional. Column to return. Indexed from 0.
2645       * @return array Database query result. Array indexed from 0 by SQL result row number.
2646       */
2647  	public function get_col( $query = null, $x = 0 ) {
2648          if ( $this->check_current_query && $this->check_safe_collation( $query ) ) {
2649              $this->check_current_query = false;
2650          }
2651  
2652          if ( $query ) {
2653              $this->query( $query );
2654          }
2655  
2656          $new_array = array();
2657          // Extract the column values.
2658          if ( $this->last_result ) {
2659              for ( $i = 0, $j = count( $this->last_result ); $i < $j; $i++ ) {
2660                  $new_array[ $i ] = $this->get_var( null, $x, $i );
2661              }
2662          }
2663          return $new_array;
2664      }
2665  
2666      /**
2667       * Retrieves an entire SQL result set from the database (i.e., many rows).
2668       *
2669       * Executes a SQL query and returns the entire SQL result.
2670       *
2671       * @since 0.71
2672       *
2673       * @param string $query  SQL query.
2674       * @param string $output Optional. Any of ARRAY_A | ARRAY_N | OBJECT | OBJECT_K constants.
2675       *                       With one of the first three, return an array of rows indexed
2676       *                       from 0 by SQL result row number. Each row is an associative array
2677       *                       (column => value, ...), a numerically indexed array (0 => value, ...),
2678       *                       or an object ( ->column = value ), respectively. With OBJECT_K,
2679       *                       return an associative array of row objects keyed by the value
2680       *                       of each row's first column's value. Duplicate keys are discarded.
2681       * @return array|object|null Database query results.
2682       */
2683  	public function get_results( $query = null, $output = OBJECT ) {
2684          $this->func_call = "\$db->get_results(\"$query\", $output)";
2685  
2686          if ( $this->check_current_query && $this->check_safe_collation( $query ) ) {
2687              $this->check_current_query = false;
2688          }
2689  
2690          if ( $query ) {
2691              $this->query( $query );
2692          } else {
2693              return null;
2694          }
2695  
2696          $new_array = array();
2697          if ( OBJECT === $output ) {
2698              // Return an integer-keyed array of row objects.
2699              return $this->last_result;
2700          } elseif ( OBJECT_K === $output ) {
2701              // Return an array of row objects with keys from column 1.
2702              // (Duplicates are discarded.)
2703              if ( $this->last_result ) {
2704                  foreach ( $this->last_result as $row ) {
2705                      $var_by_ref = get_object_vars( $row );
2706                      $key        = array_shift( $var_by_ref );
2707                      if ( ! isset( $new_array[ $key ] ) ) {
2708                          $new_array[ $key ] = $row;
2709                      }
2710                  }
2711              }
2712              return $new_array;
2713          } elseif ( ARRAY_A === $output || ARRAY_N === $output ) {
2714              // Return an integer-keyed array of...
2715              if ( $this->last_result ) {
2716                  foreach ( (array) $this->last_result as $row ) {
2717                      if ( ARRAY_N === $output ) {
2718                          // ...integer-keyed row arrays.
2719                          $new_array[] = array_values( get_object_vars( $row ) );
2720                      } else {
2721                          // ...column name-keyed row arrays.
2722                          $new_array[] = get_object_vars( $row );
2723                      }
2724                  }
2725              }
2726              return $new_array;
2727          } elseif ( strtoupper( $output ) === OBJECT ) {
2728              // Back compat for OBJECT being previously case-insensitive.
2729              return $this->last_result;
2730          }
2731          return null;
2732      }
2733  
2734      /**
2735       * Retrieves the character set for the given table.
2736       *
2737       * @since 4.2.0
2738       *
2739       * @param string $table Table name.
2740       * @return string|WP_Error Table character set, WP_Error object if it couldn't be found.
2741       */
2742  	protected function get_table_charset( $table ) {
2743          $tablekey = strtolower( $table );
2744  
2745          /**
2746           * Filters the table charset value before the DB is checked.
2747           *
2748           * Passing a non-null value to the filter will effectively short-circuit
2749           * checking the DB for the charset, returning that value instead.
2750           *
2751           * @since 4.2.0
2752           *
2753           * @param string|null $charset The character set to use. Default null.
2754           * @param string      $table   The name of the table being checked.
2755           */
2756          $charset = apply_filters( 'pre_get_table_charset', null, $table );
2757          if ( null !== $charset ) {
2758              return $charset;
2759          }
2760  
2761          if ( isset( $this->table_charset[ $tablekey ] ) ) {
2762              return $this->table_charset[ $tablekey ];
2763          }
2764  
2765          $charsets = array();
2766          $columns  = array();
2767  
2768          $table_parts = explode( '.', $table );
2769          $table       = '`' . implode( '`.`', $table_parts ) . '`';
2770          $results     = $this->get_results( "SHOW FULL COLUMNS FROM $table" );
2771          if ( ! $results ) {
2772              return new WP_Error( 'wpdb_get_table_charset_failure' );
2773          }
2774  
2775          foreach ( $results as $column ) {
2776              $columns[ strtolower( $column->Field ) ] = $column;
2777          }
2778  
2779          $this->col_meta[ $tablekey ] = $columns;
2780  
2781          foreach ( $columns as $column ) {
2782              if ( ! empty( $column->Collation ) ) {
2783                  list( $charset ) = explode( '_', $column->Collation );
2784  
2785                  // If the current connection can't support utf8mb4 characters, let's only send 3-byte utf8 characters.
2786                  if ( 'utf8mb4' === $charset && ! $this->has_cap( 'utf8mb4' ) ) {
2787                      $charset = 'utf8';
2788                  }
2789  
2790                  $charsets[ strtolower( $charset ) ] = true;
2791              }
2792  
2793              list( $type ) = explode( '(', $column->Type );
2794  
2795              // A binary/blob means the whole query gets treated like this.
2796              if ( in_array( strtoupper( $type ), array( 'BINARY', 'VARBINARY', 'TINYBLOB', 'MEDIUMBLOB', 'BLOB', 'LONGBLOB' ), true ) ) {
2797                  $this->table_charset[ $tablekey ] = 'binary';
2798                  return 'binary';
2799              }
2800          }
2801  
2802          // utf8mb3 is an alias for utf8.
2803          if ( isset( $charsets['utf8mb3'] ) ) {
2804              $charsets['utf8'] = true;
2805              unset( $charsets['utf8mb3'] );
2806          }
2807  
2808          // Check if we have more than one charset in play.
2809          $count = count( $charsets );
2810          if ( 1 === $count ) {
2811              $charset = key( $charsets );
2812          } elseif ( 0 === $count ) {
2813              // No charsets, assume this table can store whatever.
2814              $charset = false;
2815          } else {
2816              // More than one charset. Remove latin1 if present and recalculate.
2817              unset( $charsets['latin1'] );
2818              $count = count( $charsets );
2819              if ( 1 === $count ) {
2820                  // Only one charset (besides latin1).
2821                  $charset = key( $charsets );
2822              } elseif ( 2 === $count && isset( $charsets['utf8'], $charsets['utf8mb4'] ) ) {
2823                  // Two charsets, but they're utf8 and utf8mb4, use utf8.
2824                  $charset = 'utf8';
2825              } else {
2826                  // Two mixed character sets. ascii.
2827                  $charset = 'ascii';
2828              }
2829          }
2830  
2831          $this->table_charset[ $tablekey ] = $charset;
2832          return $charset;
2833      }
2834  
2835      /**
2836       * Retrieves the character set for the given column.
2837       *
2838       * @since 4.2.0
2839       *
2840       * @param string $table  Table name.
2841       * @param string $column Column name.
2842       * @return string|false|WP_Error Column character set as a string. False if the column has
2843       *                               no character set. WP_Error object if there was an error.
2844       */
2845  	public function get_col_charset( $table, $column ) {
2846          $tablekey  = strtolower( $table );
2847          $columnkey = strtolower( $column );
2848  
2849          /**
2850           * Filters the column charset value before the DB is checked.
2851           *
2852           * Passing a non-null value to the filter will short-circuit
2853           * checking the DB for the charset, returning that value instead.
2854           *
2855           * @since 4.2.0
2856           *
2857           * @param string|null $charset The character set to use. Default null.
2858           * @param string      $table   The name of the table being checked.
2859           * @param string      $column  The name of the column being checked.
2860           */
2861          $charset = apply_filters( 'pre_get_col_charset', null, $table, $column );
2862          if ( null !== $charset ) {
2863              return $charset;
2864          }
2865  
2866          // Skip this entirely if this isn't a MySQL database.
2867          if ( empty( $this->is_mysql ) ) {
2868              return false;
2869          }
2870  
2871          if ( empty( $this->table_charset[ $tablekey ] ) ) {
2872              // This primes column information for us.
2873              $table_charset = $this->get_table_charset( $table );
2874              if ( is_wp_error( $table_charset ) ) {
2875                  return $table_charset;
2876              }
2877          }
2878  
2879          // If still no column information, return the table charset.
2880          if ( empty( $this->col_meta[ $tablekey ] ) ) {
2881              return $this->table_charset[ $tablekey ];
2882          }
2883  
2884          // If this column doesn't exist, return the table charset.
2885          if ( empty( $this->col_meta[ $tablekey ][ $columnkey ] ) ) {
2886              return $this->table_charset[ $tablekey ];
2887          }
2888  
2889          // Return false when it's not a string column.
2890          if ( empty( $this->col_meta[ $tablekey ][ $columnkey ]->Collation ) ) {
2891              return false;
2892          }
2893  
2894          list( $charset ) = explode( '_', $this->col_meta[ $tablekey ][ $columnkey ]->Collation );
2895          return $charset;
2896      }
2897  
2898      /**
2899       * Retrieves the maximum string length allowed in a given column.
2900       *
2901       * The length may either be specified as a byte length or a character length.
2902       *
2903       * @since 4.2.1
2904       *
2905       * @param string $table  Table name.
2906       * @param string $column Column name.
2907       * @return array|false|WP_Error array( 'length' => (int), 'type' => 'byte' | 'char' ).
2908       *                              False if the column has no length (for example, numeric column).
2909       *                              WP_Error object if there was an error.
2910       */
2911  	public function get_col_length( $table, $column ) {
2912          $tablekey  = strtolower( $table );
2913          $columnkey = strtolower( $column );
2914  
2915          // Skip this entirely if this isn't a MySQL database.
2916          if ( empty( $this->is_mysql ) ) {
2917              return false;
2918          }
2919  
2920          if ( empty( $this->col_meta[ $tablekey ] ) ) {
2921              // This primes column information for us.
2922              $table_charset = $this->get_table_charset( $table );
2923              if ( is_wp_error( $table_charset ) ) {
2924                  return $table_charset;
2925              }
2926          }
2927  
2928          if ( empty( $this->col_meta[ $tablekey ][ $columnkey ] ) ) {
2929              return false;
2930          }
2931  
2932          $typeinfo = explode( '(', $this->col_meta[ $tablekey ][ $columnkey ]->Type );
2933  
2934          $type = strtolower( $typeinfo[0] );
2935          if ( ! empty( $typeinfo[1] ) ) {
2936              $length = trim( $typeinfo[1], ')' );
2937          } else {
2938              $length = false;
2939          }
2940  
2941          switch ( $type ) {
2942              case 'char':
2943              case 'varchar':
2944                  return array(
2945                      'type'   => 'char',
2946                      'length' => (int) $length,
2947                  );
2948  
2949              case 'binary':
2950              case 'varbinary':
2951                  return array(
2952                      'type'   => 'byte',
2953                      'length' => (int) $length,
2954                  );
2955  
2956              case 'tinyblob':
2957              case 'tinytext':
2958                  return array(
2959                      'type'   => 'byte',
2960                      'length' => 255,        // 2^8 - 1
2961                  );
2962  
2963              case 'blob':
2964              case 'text':
2965                  return array(
2966                      'type'   => 'byte',
2967                      'length' => 65535,      // 2^16 - 1
2968                  );
2969  
2970              case 'mediumblob':
2971              case 'mediumtext':
2972                  return array(
2973                      'type'   => 'byte',
2974                      'length' => 16777215,   // 2^24 - 1
2975                  );
2976  
2977              case 'longblob':
2978              case 'longtext':
2979                  return array(
2980                      'type'   => 'byte',
2981                      'length' => 4294967295, // 2^32 - 1
2982                  );
2983  
2984              default:
2985                  return false;
2986          }
2987      }
2988  
2989      /**
2990       * Checks if a string is ASCII.
2991       *
2992       * The negative regex is faster for non-ASCII strings, as it allows
2993       * the search to finish as soon as it encounters a non-ASCII character.
2994       *
2995       * @since 4.2.0
2996       *
2997       * @param string $string String to check.
2998       * @return bool True if ASCII, false if not.
2999       */
3000  	protected function check_ascii( $string ) {
3001          if ( function_exists( 'mb_check_encoding' ) ) {
3002              if ( mb_check_encoding( $string, 'ASCII' ) ) {
3003                  return true;
3004              }
3005          } elseif ( ! preg_match( '/[^\x00-\x7F]/', $string ) ) {
3006              return true;
3007          }
3008  
3009          return false;
3010      }
3011  
3012      /**
3013       * Checks if the query is accessing a collation considered safe on the current version of MySQL.
3014       *
3015       * @since 4.2.0
3016       *
3017       * @param string $query The query to check.
3018       * @return bool True if the collation is safe, false if it isn't.
3019       */
3020  	protected function check_safe_collation( $query ) {
3021          if ( $this->checking_collation ) {
3022              return true;
3023          }
3024  
3025          // We don't need to check the collation for queries that don't read data.
3026          $query = ltrim( $query, "\r\n\t (" );
3027          if ( preg_match( '/^(?:SHOW|DESCRIBE|DESC|EXPLAIN|CREATE)\s/i', $query ) ) {
3028              return true;
3029          }
3030  
3031          // All-ASCII queries don't need extra checking.
3032          if ( $this->check_ascii( $query ) ) {
3033              return true;
3034          }
3035  
3036          $table = $this->get_table_from_query( $query );
3037          if ( ! $table ) {
3038              return false;
3039          }
3040  
3041          $this->checking_collation = true;
3042          $collation                = $this->get_table_charset( $table );
3043          $this->checking_collation = false;
3044  
3045          // Tables with no collation, or latin1 only, don't need extra checking.
3046          if ( false === $collation || 'latin1' === $collation ) {
3047              return true;
3048          }
3049  
3050          $table = strtolower( $table );
3051          if ( empty( $this->col_meta[ $table ] ) ) {
3052              return false;
3053          }
3054  
3055          // If any of the columns don't have one of these collations, it needs more sanity checking.
3056          foreach ( $this->col_meta[ $table ] as $col ) {
3057              if ( empty( $col->Collation ) ) {
3058                  continue;
3059              }
3060  
3061              if ( ! in_array( $col->Collation, array( 'utf8_general_ci', 'utf8_bin', 'utf8mb4_general_ci', 'utf8mb4_bin' ), true ) ) {
3062                  return false;
3063              }
3064          }
3065  
3066          return true;
3067      }
3068  
3069      /**
3070       * Strips any invalid characters based on value/charset pairs.
3071       *
3072       * @since 4.2.0
3073       *
3074       * @param array $data Array of value arrays. Each value array has the keys 'value' and 'charset'.
3075       *                    An optional 'ascii' key can be set to false to avoid redundant ASCII checks.
3076       * @return array|WP_Error The $data parameter, with invalid characters removed from each value.
3077       *                        This works as a passthrough: any additional keys such as 'field' are
3078       *                        retained in each value array. If we cannot remove invalid characters,
3079       *                        a WP_Error object is returned.
3080       */
3081  	protected function strip_invalid_text( $data ) {
3082          $db_check_string = false;
3083  
3084          foreach ( $data as &$value ) {
3085              $charset = $value['charset'];
3086  
3087              if ( is_array( $value['length'] ) ) {
3088                  $length                  = $value['length']['length'];
3089                  $truncate_by_byte_length = 'byte' === $value['length']['type'];
3090              } else {
3091                  $length = false;
3092                  // Since we have no length, we'll never truncate. Initialize the variable to false.
3093                  // True would take us through an unnecessary (for this case) codepath below.
3094                  $truncate_by_byte_length = false;
3095              }
3096  
3097              // There's no charset to work with.
3098              if ( false === $charset ) {
3099                  continue;
3100              }
3101  
3102              // Column isn't a string.
3103              if ( ! is_string( $value['value'] ) ) {
3104                  continue;
3105              }
3106  
3107              $needs_validation = true;
3108              if (
3109                  // latin1 can store any byte sequence.
3110                  'latin1' === $charset
3111              ||
3112                  // ASCII is always OK.
3113                  ( ! isset( $value['ascii'] ) && $this->check_ascii( $value['value'] ) )
3114              ) {
3115                  $truncate_by_byte_length = true;
3116                  $needs_validation        = false;
3117              }
3118  
3119              if ( $truncate_by_byte_length ) {
3120                  mbstring_binary_safe_encoding();
3121                  if ( false !== $length && strlen( $value['value'] ) > $length ) {
3122                      $value['value'] = substr( $value['value'], 0, $length );
3123                  }
3124                  reset_mbstring_encoding();
3125  
3126                  if ( ! $needs_validation ) {
3127                      continue;
3128                  }
3129              }
3130  
3131              // utf8 can be handled by regex, which is a bunch faster than a DB lookup.
3132              if ( ( 'utf8' === $charset || 'utf8mb3' === $charset || 'utf8mb4' === $charset ) && function_exists( 'mb_strlen' ) ) {
3133                  $regex = '/
3134                      (
3135                          (?: [\x00-\x7F]                  # single-byte sequences   0xxxxxxx
3136                          |   [\xC2-\xDF][\x80-\xBF]       # double-byte sequences   110xxxxx 10xxxxxx
3137                          |   \xE0[\xA0-\xBF][\x80-\xBF]   # triple-byte sequences   1110xxxx 10xxxxxx * 2
3138                          |   [\xE1-\xEC][\x80-\xBF]{2}
3139                          |   \xED[\x80-\x9F][\x80-\xBF]
3140                          |   [\xEE-\xEF][\x80-\xBF]{2}';
3141  
3142                  if ( 'utf8mb4' === $charset ) {
3143                      $regex .= '
3144                          |    \xF0[\x90-\xBF][\x80-\xBF]{2} # four-byte sequences   11110xxx 10xxxxxx * 3
3145                          |    [\xF1-\xF3][\x80-\xBF]{3}
3146                          |    \xF4[\x80-\x8F][\x80-\xBF]{2}
3147                      ';
3148                  }
3149  
3150                  $regex         .= '){1,40}                          # ...one or more times
3151                      )
3152                      | .                                  # anything else
3153                      /x';
3154                  $value['value'] = preg_replace( $regex, '$1', $value['value'] );
3155  
3156                  if ( false !== $length && mb_strlen( $value['value'], 'UTF-8' ) > $length ) {
3157                      $value['value'] = mb_substr( $value['value'], 0, $length, 'UTF-8' );
3158                  }
3159                  continue;
3160              }
3161  
3162              // We couldn't use any local conversions, send it to the DB.
3163              $value['db']     = true;
3164              $db_check_string = true;
3165          }
3166          unset( $value ); // Remove by reference.
3167  
3168          if ( $db_check_string ) {
3169              $queries = array();
3170              foreach ( $data as $col => $value ) {
3171                  if ( ! empty( $value['db'] ) ) {
3172                      // We're going to need to truncate by characters or bytes, depending on the length value we have.
3173                      if ( isset( $value['length']['type'] ) && 'byte' === $value['length']['type'] ) {
3174                          // Using binary causes LEFT() to truncate by bytes.
3175                          $charset = 'binary';
3176                      } else {
3177                          $charset = $value['charset'];
3178                      }
3179  
3180                      if ( $this->charset ) {
3181                          $connection_charset = $this->charset;
3182                      } else {
3183                          if ( $this->use_mysqli ) {
3184                              $connection_charset = mysqli_character_set_name( $this->dbh );
3185                          } else {
3186                              $connection_charset = mysql_client_encoding();
3187                          }
3188                      }
3189  
3190                      if ( is_array( $value['length'] ) ) {
3191                          $length          = sprintf( '%.0f', $value['length']['length'] );
3192                          $queries[ $col ] = $this->prepare( "CONVERT( LEFT( CONVERT( %s USING $charset ), $length ) USING $connection_charset )", $value['value'] );
3193                      } elseif ( 'binary' !== $charset ) {
3194                          // If we don't have a length, there's no need to convert binary - it will always return the same result.
3195                          $queries[ $col ] = $this->prepare( "CONVERT( CONVERT( %s USING $charset ) USING $connection_charset )", $value['value'] );
3196                      }
3197  
3198                      unset( $data[ $col ]['db'] );
3199                  }
3200              }
3201  
3202              $sql = array();
3203              foreach ( $queries as $column => $query ) {
3204                  if ( ! $query ) {
3205                      continue;
3206                  }
3207  
3208                  $sql[] = $query . " AS x_$column";
3209              }
3210  
3211              $this->check_current_query = false;
3212              $row                       = $this->get_row( 'SELECT ' . implode( ', ', $sql ), ARRAY_A );
3213              if ( ! $row ) {
3214                  return new WP_Error( 'wpdb_strip_invalid_text_failure' );
3215              }
3216  
3217              foreach ( array_keys( $data ) as $column ) {
3218                  if ( isset( $row[ "x_$column" ] ) ) {
3219                      $data[ $column ]['value'] = $row[ "x_$column" ];
3220                  }
3221              }
3222          }
3223  
3224          return $data;
3225      }
3226  
3227      /**
3228       * Strips any invalid characters from the query.
3229       *
3230       * @since 4.2.0
3231       *
3232       * @param string $query Query to convert.
3233       * @return string|WP_Error The converted query, or a WP_Error object if the conversion fails.
3234       */
3235  	protected function strip_invalid_text_from_query( $query ) {
3236          // We don't need to check the collation for queries that don't read data.
3237          $trimmed_query = ltrim( $query, "\r\n\t (" );
3238          if ( preg_match( '/^(?:SHOW|DESCRIBE|DESC|EXPLAIN|CREATE)\s/i', $trimmed_query ) ) {
3239              return $query;
3240          }
3241  
3242          $table = $this->get_table_from_query( $query );
3243          if ( $table ) {
3244              $charset = $this->get_table_charset( $table );
3245              if ( is_wp_error( $charset ) ) {
3246                  return $charset;
3247              }
3248  
3249              // We can't reliably strip text from tables containing binary/blob columns.
3250              if ( 'binary' === $charset ) {
3251                  return $query;
3252              }
3253          } else {
3254              $charset = $this->charset;
3255          }
3256  
3257          $data = array(
3258              'value'   => $query,
3259              'charset' => $charset,
3260              'ascii'   => false,
3261              'length'  => false,
3262          );
3263  
3264          $data = $this->strip_invalid_text( array( $data ) );
3265          if ( is_wp_error( $data ) ) {
3266              return $data;
3267          }
3268  
3269          return $data[0]['value'];
3270      }
3271  
3272      /**
3273       * Strips any invalid characters from the string for a given table and column.
3274       *
3275       * @since 4.2.0
3276       *
3277       * @param string $table  Table name.
3278       * @param string $column Column name.
3279       * @param string $value  The text to check.
3280       * @return string|WP_Error The converted string, or a WP_Error object if the conversion fails.
3281       */
3282  	public function strip_invalid_text_for_column( $table, $column, $value ) {
3283          if ( ! is_string( $value ) ) {
3284              return $value;
3285          }
3286  
3287          $charset = $this->get_col_charset( $table, $column );
3288          if ( ! $charset ) {
3289              // Not a string column.
3290              return $value;
3291          } elseif ( is_wp_error( $charset ) ) {
3292              // Bail on real errors.
3293              return $charset;
3294          }
3295  
3296          $data = array(
3297              $column => array(
3298                  'value'   => $value,
3299                  'charset' => $charset,
3300                  'length'  => $this->get_col_length( $table, $column ),
3301              ),
3302          );
3303  
3304          $data = $this->strip_invalid_text( $data );
3305          if ( is_wp_error( $data ) ) {
3306              return $data;
3307          }
3308  
3309          return $data[ $column ]['value'];
3310      }
3311  
3312      /**
3313       * Finds the first table name referenced in a query.
3314       *
3315       * @since 4.2.0
3316       *
3317       * @param string $query The query to search.
3318       * @return string|false The table name found, or false if a table couldn't be found.
3319       */
3320  	protected function get_table_from_query( $query ) {
3321          // Remove characters that can legally trail the table name.
3322          $query = rtrim( $query, ';/-#' );
3323  
3324          // Allow (select...) union [...] style queries. Use the first query's table name.
3325          $query = ltrim( $query, "\r\n\t (" );
3326  
3327          // Strip everything between parentheses except nested selects.
3328          $query = preg_replace( '/\((?!\s*select)[^(]*?\)/is', '()', $query );
3329  
3330          // Quickly match most common queries.
3331          if ( preg_match(
3332              '/^\s*(?:'
3333                  . 'SELECT.*?\s+FROM'
3334                  . '|INSERT(?:\s+LOW_PRIORITY|\s+DELAYED|\s+HIGH_PRIORITY)?(?:\s+IGNORE)?(?:\s+INTO)?'
3335                  . '|REPLACE(?:\s+LOW_PRIORITY|\s+DELAYED)?(?:\s+INTO)?'
3336                  . '|UPDATE(?:\s+LOW_PRIORITY)?(?:\s+IGNORE)?'
3337                  . '|DELETE(?:\s+LOW_PRIORITY|\s+QUICK|\s+IGNORE)*(?:.+?FROM)?'
3338              . ')\s+((?:[0-9a-zA-Z$_.`-]|[\xC2-\xDF][\x80-\xBF])+)/is',
3339              $query,
3340              $maybe
3341          ) ) {
3342              return str_replace( '`', '', $maybe[1] );
3343          }
3344  
3345          // SHOW TABLE STATUS and SHOW TABLES WHERE Name = 'wp_posts'
3346          if ( preg_match( '/^\s*SHOW\s+(?:TABLE\s+STATUS|(?:FULL\s+)?TABLES).+WHERE\s+Name\s*=\s*("|\')((?:[0-9a-zA-Z$_.-]|[\xC2-\xDF][\x80-\xBF])+)\\1/is', $query, $maybe ) ) {
3347              return $maybe[2];
3348          }
3349  
3350          /*
3351           * SHOW TABLE STATUS LIKE and SHOW TABLES LIKE 'wp\_123\_%'
3352           * This quoted LIKE operand seldom holds a full table name.
3353           * It is usually a pattern for matching a prefix so we just
3354           * strip the trailing % and unescape the _ to get 'wp_123_'
3355           * which drop-ins can use for routing these SQL statements.
3356           */
3357          if ( preg_match( '/^\s*SHOW\s+(?:TABLE\s+STATUS|(?:FULL\s+)?TABLES)\s+(?:WHERE\s+Name\s+)?LIKE\s*("|\')((?:[\\\\0-9a-zA-Z$_.-]|[\xC2-\xDF][\x80-\xBF])+)%?\\1/is', $query, $maybe ) ) {
3358              return str_replace( '\\_', '_', $maybe[2] );
3359          }
3360  
3361          // Big pattern for the rest of the table-related queries.
3362          if ( preg_match(
3363              '/^\s*(?:'
3364                  . '(?:EXPLAIN\s+(?:EXTENDED\s+)?)?SELECT.*?\s+FROM'
3365                  . '|DESCRIBE|DESC|EXPLAIN|HANDLER'
3366                  . '|(?:LOCK|UNLOCK)\s+TABLE(?:S)?'
3367                  . '|(?:RENAME|OPTIMIZE|BACKUP|RESTORE|CHECK|CHECKSUM|ANALYZE|REPAIR).*\s+TABLE'
3368                  . '|TRUNCATE(?:\s+TABLE)?'
3369                  . '|CREATE(?:\s+TEMPORARY)?\s+TABLE(?:\s+IF\s+NOT\s+EXISTS)?'
3370                  . '|ALTER(?:\s+IGNORE)?\s+TABLE'
3371                  . '|DROP\s+TABLE(?:\s+IF\s+EXISTS)?'
3372                  . '|CREATE(?:\s+\w+)?\s+INDEX.*\s+ON'
3373                  . '|DROP\s+INDEX.*\s+ON'
3374                  . '|LOAD\s+DATA.*INFILE.*INTO\s+TABLE'
3375                  . '|(?:GRANT|REVOKE).*ON\s+TABLE'
3376                  . '|SHOW\s+(?:.*FROM|.*TABLE)'
3377              . ')\s+\(*\s*((?:[0-9a-zA-Z$_.`-]|[\xC2-\xDF][\x80-\xBF])+)\s*\)*/is',
3378              $query,
3379              $maybe
3380          ) ) {
3381              return str_replace( '`', '', $maybe[1] );
3382          }
3383  
3384          return false;
3385      }
3386  
3387      /**
3388       * Loads the column metadata from the last query.
3389       *
3390       * @since 3.5.0
3391       */
3392  	protected function load_col_info() {
3393          if ( $this->col_info ) {
3394              return;
3395          }
3396  
3397          if ( $this->use_mysqli ) {
3398              $num_fields = mysqli_num_fields( $this->result );
3399              for ( $i = 0; $i < $num_fields; $i++ ) {
3400                  $this->col_info[ $i ] = mysqli_fetch_field( $this->result );
3401              }
3402          } else {
3403              $num_fields = mysql_num_fields( $this->result );
3404              for ( $i = 0; $i < $num_fields; $i++ ) {
3405                  $this->col_info[ $i ] = mysql_fetch_field( $this->result, $i );
3406              }
3407          }
3408      }
3409  
3410      /**
3411       * Retrieves column metadata from the last query.
3412       *
3413       * @since 0.71
3414       *
3415       * @param string $info_type  Optional. Possible values include 'name', 'table', 'def', 'max_length',
3416       *                           'not_null', 'primary_key', 'multiple_key', 'unique_key', 'numeric',
3417       *                           'blob', 'type', 'unsigned', 'zerofill'. Default 'name'.
3418       * @param int    $col_offset Optional. 0: col name. 1: which table the col's in. 2: col's max length.
3419       *                           3: if the col is numeric. 4: col's type. Default -1.
3420       * @return mixed Column results.
3421       */
3422  	public function get_col_info( $info_type = 'name', $col_offset = -1 ) {
3423          $this->load_col_info();
3424  
3425          if ( $this->col_info ) {
3426              if ( -1 === $col_offset ) {
3427                  $i         = 0;
3428                  $new_array = array();
3429                  foreach ( (array) $this->col_info as $col ) {
3430                      $new_array[ $i ] = $col->{$info_type};
3431                      $i++;
3432                  }
3433                  return $new_array;
3434              } else {
3435                  return $this->col_info[ $col_offset ]->{$info_type};
3436              }
3437          }
3438      }
3439  
3440      /**
3441       * Starts the timer, for debugging purposes.
3442       *
3443       * @since 1.5.0
3444       *
3445       * @return true
3446       */
3447  	public function timer_start() {
3448          $this->time_start = microtime( true );
3449          return true;
3450      }
3451  
3452      /**
3453       * Stops the debugging timer.
3454       *
3455       * @since 1.5.0
3456       *
3457       * @return float Total time spent on the query, in seconds.
3458       */
3459  	public function timer_stop() {
3460          return ( microtime( true ) - $this->time_start );
3461      }
3462  
3463      /**
3464       * Wraps errors in a nice header and footer and dies.
3465       *
3466       * Will not die if wpdb::$show_errors is false.
3467       *
3468       * @since 1.5.0
3469       *
3470       * @param string $message    The error message.
3471       * @param string $error_code Optional. A computer-readable string to identify the error.
3472       *                           Default '500'.
3473       * @return void|false Void if the showing of errors is enabled, false if disabled.
3474       */
3475  	public function bail( $message, $error_code = '500' ) {
3476          if ( $this->show_errors ) {
3477              $error = '';
3478  
3479              if ( $this->use_mysqli ) {
3480                  if ( $this->dbh instanceof mysqli ) {
3481                      $error = mysqli_error( $this->dbh );
3482                  } elseif ( mysqli_connect_errno() ) {
3483                      $error = mysqli_connect_error();
3484                  }
3485              } else {
3486                  if ( is_resource( $this->dbh ) ) {
3487                      $error = mysql_error( $this->dbh );
3488                  } else {
3489                      $error = mysql_error();
3490                  }
3491              }
3492  
3493              if ( $error ) {
3494                  $message = '<p><code>' . $error . "</code></p>\n" . $message;
3495              }
3496  
3497              wp_die( $message );
3498          } else {
3499              if ( class_exists( 'WP_Error', false ) ) {
3500                  $this->error = new WP_Error( $error_code, $message );
3501              } else {
3502                  $this->error = $message;
3503              }
3504  
3505              return false;
3506          }
3507      }
3508  
3509  
3510      /**
3511       * Closes the current database connection.
3512       *
3513       * @since 4.5.0
3514       *
3515       * @return bool True if the connection was successfully closed,
3516       *              false if it wasn't, or if the connection doesn't exist.
3517       */
3518  	public function close() {
3519          if ( ! $this->dbh ) {
3520              return false;
3521          }
3522  
3523          if ( $this->use_mysqli ) {
3524              $closed = mysqli_close( $this->dbh );
3525          } else {
3526              $closed = mysql_close( $this->dbh );
3527          }
3528  
3529          if ( $closed ) {
3530              $this->dbh           = null;
3531              $this->ready         = false;
3532              $this->has_connected = false;
3533          }
3534  
3535          return $closed;
3536      }
3537  
3538      /**
3539       * Determines whether MySQL database is at least the required minimum version.
3540       *
3541       * @since 2.5.0
3542       *
3543       * @global string $wp_version             The WordPress version string.
3544       * @global string $required_mysql_version The required MySQL version string.
3545       * @return void|WP_Error
3546       */
3547  	public function check_database_version() {
3548          global $wp_version, $required_mysql_version;
3549          // Make sure the server has the required MySQL version.
3550          if ( version_compare( $this->db_version(), $required_mysql_version, '<' ) ) {
3551              /* translators: 1: WordPress version number, 2: Minimum required MySQL version number. */
3552              return new WP_Error( 'database_version', sprintf( __( '<strong>Error</strong>: WordPress %1$s requires MySQL %2$s or higher' ), $wp_version, $required_mysql_version ) );
3553          }
3554      }
3555  
3556      /**
3557       * Determines whether the database supports collation.
3558       *
3559       * Called when WordPress is generating the table scheme.
3560       *
3561       * Use `wpdb::has_cap( 'collation' )`.
3562       *
3563       * @since 2.5.0
3564       * @deprecated 3.5.0 Use wpdb::has_cap()
3565       *
3566       * @return bool True if collation is supported, false if not.
3567       */
3568  	public function supports_collation() {
3569          _deprecated_function( __FUNCTION__, '3.5.0', 'wpdb::has_cap( \'collation\' )' );
3570          return $this->has_cap( 'collation' );
3571      }
3572  
3573      /**
3574       * Retrieves the database character collate.
3575       *
3576       * @since 3.5.0
3577       *
3578       * @return string The database character collate.
3579       */
3580  	public function get_charset_collate() {
3581          $charset_collate = '';
3582  
3583          if ( ! empty( $this->charset ) ) {
3584              $charset_collate = "DEFAULT CHARACTER SET $this->charset";
3585          }
3586          if ( ! empty( $this->collate ) ) {
3587              $charset_collate .= " COLLATE $this->collate";
3588          }
3589  
3590          return $charset_collate;
3591      }
3592  
3593      /**
3594       * Determines if a database supports a particular feature.
3595       *
3596       * @since 2.7.0
3597       * @since 4.1.0 Added support for the 'utf8mb4' feature.
3598       * @since 4.6.0 Added support for the 'utf8mb4_520' feature.
3599       *
3600       * @see wpdb::db_version()
3601       *
3602       * @param string $db_cap The feature to check for. Accepts 'collation', 'group_concat',
3603       *                       'subqueries', 'set_charset', 'utf8mb4', or 'utf8mb4_520'.
3604       * @return int|false Whether the database feature is supported, false otherwise.
3605       */
3606  	public function has_cap( $db_cap ) {
3607          $version = $this->db_version();
3608  
3609          switch ( strtolower( $db_cap ) ) {
3610              case 'collation':    // @since 2.5.0
3611              case 'group_concat': // @since 2.7.0
3612              case 'subqueries':   // @since 2.7.0
3613                  return version_compare( $version, '4.1', '>=' );
3614              case 'set_charset':
3615                  return version_compare( $version, '5.0.7', '>=' );
3616              case 'utf8mb4':      // @since 4.1.0
3617                  if ( version_compare( $version, '5.5.3', '<' ) ) {
3618                      return false;
3619                  }
3620                  if ( $this->use_mysqli ) {
3621                      $client_version = mysqli_get_client_info();
3622                  } else {
3623                      $client_version = mysql_get_client_info();
3624                  }
3625  
3626                  /*
3627                   * libmysql has supported utf8mb4 since 5.5.3, same as the MySQL server.
3628                   * mysqlnd has supported utf8mb4 since 5.0.9.
3629                   */
3630                  if ( false !== strpos( $client_version, 'mysqlnd' ) ) {
3631                      $client_version = preg_replace( '/^\D+([\d.]+).*/', '$1', $client_version );
3632                      return version_compare( $client_version, '5.0.9', '>=' );
3633                  } else {
3634                      return version_compare( $client_version, '5.5.3', '>=' );
3635                  }
3636              case 'utf8mb4_520': // @since 4.6.0
3637                  return version_compare( $version, '5.6', '>=' );
3638          }
3639  
3640          return false;
3641      }
3642  
3643      /**
3644       * Retrieves the name of the function that called wpdb.
3645       *
3646       * Searches up the list of functions until it reaches the one that would
3647       * most logically had called this method.
3648       *
3649       * @since 2.5.0
3650       *
3651       * @return string Comma-separated list of the calling functions.
3652       */
3653  	public function get_caller() {
3654          return wp_debug_backtrace_summary( __CLASS__ );
3655      }
3656  
3657      /**
3658       * Retrieves the MySQL server version.
3659       *
3660       * @since 2.7.0
3661       *
3662       * @return string|null Version number on success, null on failure.
3663       */
3664  	public function db_version() {
3665          return preg_replace( '/[^0-9.].*/', '', $this->db_server_info() );
3666      }
3667  
3668      /**
3669       * Retrieves full MySQL server information.
3670       *
3671       * @since 5.5.0
3672       *
3673       * @return string|false Server info on success, false on failure.
3674       */
3675  	public function db_server_info() {
3676          if ( $this->use_mysqli ) {
3677              $server_info = mysqli_get_server_info( $this->dbh );
3678          } else {
3679              $server_info = mysql_get_server_info( $this->dbh );
3680          }
3681  
3682          return $server_info;
3683      }
3684  }


Generated: Thu Sep 24 01:02:16 2020 Cross-referenced by PHPXref 0.7.1