wp-db.php (106095B)
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 public $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 public $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 public $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 public $last_query; 121 122 /** 123 * Results of the last query. 124 * 125 * @since 0.71 126 * @var array|null 127 */ 128 public $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 public $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 public $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 public $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 public $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 public $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 public $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’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’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’t contact the database server at %2$s. This could mean your host’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’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’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’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 documentation page. 1891 * 1892 * @since 0.71 1893 * 1894 * @link https://developer.wordpress.org/reference/classes/wpdb/ 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 if ( ! $query ) { 1919 $this->insert_id = 0; 1920 return false; 1921 } 1922 1923 $this->flush(); 1924 1925 // Log how the function was called. 1926 $this->func_call = "\$db->query(\"$query\")"; 1927 1928 // If we're writing to the database, make sure the query will write safely. 1929 if ( $this->check_current_query && ! $this->check_ascii( $query ) ) { 1930 $stripped_query = $this->strip_invalid_text_from_query( $query ); 1931 // strip_invalid_text_from_query() can perform queries, so we need 1932 // to flush again, just to make sure everything is clear. 1933 $this->flush(); 1934 if ( $stripped_query !== $query ) { 1935 $this->insert_id = 0; 1936 return false; 1937 } 1938 } 1939 1940 $this->check_current_query = true; 1941 1942 // Keep track of the last query for debug. 1943 $this->last_query = $query; 1944 1945 $this->_do_query( $query ); 1946 1947 // MySQL server has gone away, try to reconnect. 1948 $mysql_errno = 0; 1949 if ( ! empty( $this->dbh ) ) { 1950 if ( $this->use_mysqli ) { 1951 if ( $this->dbh instanceof mysqli ) { 1952 $mysql_errno = mysqli_errno( $this->dbh ); 1953 } else { 1954 // $dbh is defined, but isn't a real connection. 1955 // Something has gone horribly wrong, let's try a reconnect. 1956 $mysql_errno = 2006; 1957 } 1958 } else { 1959 if ( is_resource( $this->dbh ) ) { 1960 $mysql_errno = mysql_errno( $this->dbh ); 1961 } else { 1962 $mysql_errno = 2006; 1963 } 1964 } 1965 } 1966 1967 if ( empty( $this->dbh ) || 2006 === $mysql_errno ) { 1968 if ( $this->check_connection() ) { 1969 $this->_do_query( $query ); 1970 } else { 1971 $this->insert_id = 0; 1972 return false; 1973 } 1974 } 1975 1976 // If there is an error then take note of it. 1977 if ( $this->use_mysqli ) { 1978 if ( $this->dbh instanceof mysqli ) { 1979 $this->last_error = mysqli_error( $this->dbh ); 1980 } else { 1981 $this->last_error = __( 'Unable to retrieve the error message from MySQL' ); 1982 } 1983 } else { 1984 if ( is_resource( $this->dbh ) ) { 1985 $this->last_error = mysql_error( $this->dbh ); 1986 } else { 1987 $this->last_error = __( 'Unable to retrieve the error message from MySQL' ); 1988 } 1989 } 1990 1991 if ( $this->last_error ) { 1992 // Clear insert_id on a subsequent failed insert. 1993 if ( $this->insert_id && preg_match( '/^\s*(insert|replace)\s/i', $query ) ) { 1994 $this->insert_id = 0; 1995 } 1996 1997 $this->print_error(); 1998 return false; 1999 } 2000 2001 if ( preg_match( '/^\s*(create|alter|truncate|drop)\s/i', $query ) ) { 2002 $return_val = $this->result; 2003 } elseif ( preg_match( '/^\s*(insert|delete|update|replace)\s/i', $query ) ) { 2004 if ( $this->use_mysqli ) { 2005 $this->rows_affected = mysqli_affected_rows( $this->dbh ); 2006 } else { 2007 $this->rows_affected = mysql_affected_rows( $this->dbh ); 2008 } 2009 // Take note of the insert_id. 2010 if ( preg_match( '/^\s*(insert|replace)\s/i', $query ) ) { 2011 if ( $this->use_mysqli ) { 2012 $this->insert_id = mysqli_insert_id( $this->dbh ); 2013 } else { 2014 $this->insert_id = mysql_insert_id( $this->dbh ); 2015 } 2016 } 2017 // Return number of rows affected. 2018 $return_val = $this->rows_affected; 2019 } else { 2020 $num_rows = 0; 2021 if ( $this->use_mysqli && $this->result instanceof mysqli_result ) { 2022 while ( $row = mysqli_fetch_object( $this->result ) ) { 2023 $this->last_result[ $num_rows ] = $row; 2024 $num_rows++; 2025 } 2026 } elseif ( is_resource( $this->result ) ) { 2027 while ( $row = mysql_fetch_object( $this->result ) ) { 2028 $this->last_result[ $num_rows ] = $row; 2029 $num_rows++; 2030 } 2031 } 2032 2033 // Log and return the number of rows selected. 2034 $this->num_rows = $num_rows; 2035 $return_val = $num_rows; 2036 } 2037 2038 return $return_val; 2039 } 2040 2041 /** 2042 * Internal function to perform the mysql_query() call. 2043 * 2044 * @since 3.9.0 2045 * 2046 * @see wpdb::query() 2047 * 2048 * @param string $query The query to run. 2049 */ 2050 private function _do_query( $query ) { 2051 if ( defined( 'SAVEQUERIES' ) && SAVEQUERIES ) { 2052 $this->timer_start(); 2053 } 2054 2055 if ( ! empty( $this->dbh ) && $this->use_mysqli ) { 2056 $this->result = mysqli_query( $this->dbh, $query ); 2057 } elseif ( ! empty( $this->dbh ) ) { 2058 $this->result = mysql_query( $query, $this->dbh ); 2059 } 2060 $this->num_queries++; 2061 2062 if ( defined( 'SAVEQUERIES' ) && SAVEQUERIES ) { 2063 $this->log_query( 2064 $query, 2065 $this->timer_stop(), 2066 $this->get_caller(), 2067 $this->time_start, 2068 array() 2069 ); 2070 } 2071 } 2072 2073 /** 2074 * Logs query data. 2075 * 2076 * @since 5.3.0 2077 * 2078 * @param string $query The query's SQL. 2079 * @param float $query_time Total time spent on the query, in seconds. 2080 * @param string $query_callstack Comma-separated list of the calling functions. 2081 * @param float $query_start Unix timestamp of the time at the start of the query. 2082 * @param array $query_data Custom query data. 2083 */ 2084 public function log_query( $query, $query_time, $query_callstack, $query_start, $query_data ) { 2085 /** 2086 * Filters the custom data to log alongside a query. 2087 * 2088 * Caution should be used when modifying any of this data, it is recommended that any additional 2089 * information you need to store about a query be added as a new associative array element. 2090 * 2091 * @since 5.3.0 2092 * 2093 * @param array $query_data Custom query data. 2094 * @param string $query The query's SQL. 2095 * @param float $query_time Total time spent on the query, in seconds. 2096 * @param string $query_callstack Comma-separated list of the calling functions. 2097 * @param float $query_start Unix timestamp of the time at the start of the query. 2098 */ 2099 $query_data = apply_filters( 'log_query_custom_data', $query_data, $query, $query_time, $query_callstack, $query_start ); 2100 2101 $this->queries[] = array( 2102 $query, 2103 $query_time, 2104 $query_callstack, 2105 $query_start, 2106 $query_data, 2107 ); 2108 } 2109 2110 /** 2111 * Generates and returns a placeholder escape string for use in queries returned by ::prepare(). 2112 * 2113 * @since 4.8.3 2114 * 2115 * @return string String to escape placeholders. 2116 */ 2117 public function placeholder_escape() { 2118 static $placeholder; 2119 2120 if ( ! $placeholder ) { 2121 // If ext/hash is not present, compat.php's hash_hmac() does not support sha256. 2122 $algo = function_exists( 'hash' ) ? 'sha256' : 'sha1'; 2123 // Old WP installs may not have AUTH_SALT defined. 2124 $salt = defined( 'AUTH_SALT' ) && AUTH_SALT ? AUTH_SALT : (string) rand(); 2125 2126 $placeholder = '{' . hash_hmac( $algo, uniqid( $salt, true ), $salt ) . '}'; 2127 } 2128 2129 /* 2130 * Add the filter to remove the placeholder escaper. Uses priority 0, so that anything 2131 * else attached to this filter will receive the query with the placeholder string removed. 2132 */ 2133 if ( false === has_filter( 'query', array( $this, 'remove_placeholder_escape' ) ) ) { 2134 add_filter( 'query', array( $this, 'remove_placeholder_escape' ), 0 ); 2135 } 2136 2137 return $placeholder; 2138 } 2139 2140 /** 2141 * Adds a placeholder escape string, to escape anything that resembles a printf() placeholder. 2142 * 2143 * @since 4.8.3 2144 * 2145 * @param string $query The query to escape. 2146 * @return string The query with the placeholder escape string inserted where necessary. 2147 */ 2148 public function add_placeholder_escape( $query ) { 2149 /* 2150 * To prevent returning anything that even vaguely resembles a placeholder, 2151 * we clobber every % we can find. 2152 */ 2153 return str_replace( '%', $this->placeholder_escape(), $query ); 2154 } 2155 2156 /** 2157 * Removes the placeholder escape strings from a query. 2158 * 2159 * @since 4.8.3 2160 * 2161 * @param string $query The query from which the placeholder will be removed. 2162 * @return string The query with the placeholder removed. 2163 */ 2164 public function remove_placeholder_escape( $query ) { 2165 return str_replace( $this->placeholder_escape(), '%', $query ); 2166 } 2167 2168 /** 2169 * Inserts a row into the table. 2170 * 2171 * Examples: 2172 * wpdb::insert( 'table', array( 'column' => 'foo', 'field' => 'bar' ) ) 2173 * wpdb::insert( 'table', array( 'column' => 'foo', 'field' => 1337 ), array( '%s', '%d' ) ) 2174 * 2175 * @since 2.5.0 2176 * 2177 * @see wpdb::prepare() 2178 * @see wpdb::$field_types 2179 * @see wp_set_wpdb_vars() 2180 * 2181 * @param string $table Table name. 2182 * @param array $data Data to insert (in column => value pairs). 2183 * Both $data columns and $data values should be "raw" (neither should be SQL escaped). 2184 * Sending a null value will cause the column to be set to NULL - the corresponding 2185 * format is ignored in this case. 2186 * @param array|string $format Optional. An array of formats to be mapped to each of the value in $data. 2187 * If string, that format will be used for all of the values in $data. 2188 * A format is one of '%d', '%f', '%s' (integer, float, string). 2189 * If omitted, all values in $data will be treated as strings unless otherwise 2190 * specified in wpdb::$field_types. 2191 * @return int|false The number of rows inserted, or false on error. 2192 */ 2193 public function insert( $table, $data, $format = null ) { 2194 return $this->_insert_replace_helper( $table, $data, $format, 'INSERT' ); 2195 } 2196 2197 /** 2198 * Replaces a row in the table. 2199 * 2200 * Examples: 2201 * wpdb::replace( 'table', array( 'column' => 'foo', 'field' => 'bar' ) ) 2202 * wpdb::replace( 'table', array( 'column' => 'foo', 'field' => 1337 ), array( '%s', '%d' ) ) 2203 * 2204 * @since 3.0.0 2205 * 2206 * @see wpdb::prepare() 2207 * @see wpdb::$field_types 2208 * @see wp_set_wpdb_vars() 2209 * 2210 * @param string $table Table name. 2211 * @param array $data Data to insert (in column => value pairs). 2212 * Both $data columns and $data values should be "raw" (neither should be SQL escaped). 2213 * Sending a null value will cause the column to be set to NULL - the corresponding 2214 * format is ignored in this case. 2215 * @param array|string $format Optional. An array of formats to be mapped to each of the value in $data. 2216 * If string, that format will be used for all of the values in $data. 2217 * A format is one of '%d', '%f', '%s' (integer, float, string). 2218 * If omitted, all values in $data will be treated as strings unless otherwise 2219 * specified in wpdb::$field_types. 2220 * @return int|false The number of rows affected, or false on error. 2221 */ 2222 public function replace( $table, $data, $format = null ) { 2223 return $this->_insert_replace_helper( $table, $data, $format, 'REPLACE' ); 2224 } 2225 2226 /** 2227 * Helper function for insert and replace. 2228 * 2229 * Runs an insert or replace query based on $type argument. 2230 * 2231 * @since 3.0.0 2232 * 2233 * @see wpdb::prepare() 2234 * @see wpdb::$field_types 2235 * @see wp_set_wpdb_vars() 2236 * 2237 * @param string $table Table name. 2238 * @param array $data Data to insert (in column => value pairs). 2239 * Both $data columns and $data values should be "raw" (neither should be SQL escaped). 2240 * Sending a null value will cause the column to be set to NULL - the corresponding 2241 * format is ignored in this case. 2242 * @param array|string $format Optional. An array of formats to be mapped to each of the value in $data. 2243 * If string, that format will be used for all of the values in $data. 2244 * A format is one of '%d', '%f', '%s' (integer, float, string). 2245 * If omitted, all values in $data will be treated as strings unless otherwise 2246 * specified in wpdb::$field_types. 2247 * @param string $type Optional. Type of operation. Possible values include 'INSERT' or 'REPLACE'. 2248 * Default 'INSERT'. 2249 * @return int|false The number of rows affected, or false on error. 2250 */ 2251 function _insert_replace_helper( $table, $data, $format = null, $type = 'INSERT' ) { 2252 $this->insert_id = 0; 2253 2254 if ( ! in_array( strtoupper( $type ), array( 'REPLACE', 'INSERT' ), true ) ) { 2255 return false; 2256 } 2257 2258 $data = $this->process_fields( $table, $data, $format ); 2259 if ( false === $data ) { 2260 return false; 2261 } 2262 2263 $formats = array(); 2264 $values = array(); 2265 foreach ( $data as $value ) { 2266 if ( is_null( $value['value'] ) ) { 2267 $formats[] = 'NULL'; 2268 continue; 2269 } 2270 2271 $formats[] = $value['format']; 2272 $values[] = $value['value']; 2273 } 2274 2275 $fields = '`' . implode( '`, `', array_keys( $data ) ) . '`'; 2276 $formats = implode( ', ', $formats ); 2277 2278 $sql = "$type INTO `$table` ($fields) VALUES ($formats)"; 2279 2280 $this->check_current_query = false; 2281 return $this->query( $this->prepare( $sql, $values ) ); 2282 } 2283 2284 /** 2285 * Updates a row in the table. 2286 * 2287 * Examples: 2288 * wpdb::update( 'table', array( 'column' => 'foo', 'field' => 'bar' ), array( 'ID' => 1 ) ) 2289 * wpdb::update( 'table', array( 'column' => 'foo', 'field' => 1337 ), array( 'ID' => 1 ), array( '%s', '%d' ), array( '%d' ) ) 2290 * 2291 * @since 2.5.0 2292 * 2293 * @see wpdb::prepare() 2294 * @see wpdb::$field_types 2295 * @see wp_set_wpdb_vars() 2296 * 2297 * @param string $table Table name. 2298 * @param array $data Data to update (in column => value pairs). 2299 * Both $data columns and $data values should be "raw" (neither should be SQL escaped). 2300 * Sending a null value will cause the column to be set to NULL - the corresponding 2301 * format is ignored in this case. 2302 * @param array $where A named array of WHERE clauses (in column => value pairs). 2303 * Multiple clauses will be joined with ANDs. 2304 * Both $where columns and $where values should be "raw". 2305 * Sending a null value will create an IS NULL comparison - the corresponding 2306 * format will be ignored in this case. 2307 * @param array|string $format Optional. An array of formats to be mapped to each of the values in $data. 2308 * If string, that format will be used for all of the values in $data. 2309 * A format is one of '%d', '%f', '%s' (integer, float, string). 2310 * If omitted, all values in $data will be treated as strings unless otherwise 2311 * specified in wpdb::$field_types. 2312 * @param array|string $where_format Optional. An array of formats to be mapped to each of the values in $where. 2313 * If string, that format will be used for all of the items in $where. 2314 * A format is one of '%d', '%f', '%s' (integer, float, string). 2315 * If omitted, all values in $where will be treated as strings. 2316 * @return int|false The number of rows updated, or false on error. 2317 */ 2318 public function update( $table, $data, $where, $format = null, $where_format = null ) { 2319 if ( ! is_array( $data ) || ! is_array( $where ) ) { 2320 return false; 2321 } 2322 2323 $data = $this->process_fields( $table, $data, $format ); 2324 if ( false === $data ) { 2325 return false; 2326 } 2327 $where = $this->process_fields( $table, $where, $where_format ); 2328 if ( false === $where ) { 2329 return false; 2330 } 2331 2332 $fields = array(); 2333 $conditions = array(); 2334 $values = array(); 2335 foreach ( $data as $field => $value ) { 2336 if ( is_null( $value['value'] ) ) { 2337 $fields[] = "`$field` = NULL"; 2338 continue; 2339 } 2340 2341 $fields[] = "`$field` = " . $value['format']; 2342 $values[] = $value['value']; 2343 } 2344 foreach ( $where as $field => $value ) { 2345 if ( is_null( $value['value'] ) ) { 2346 $conditions[] = "`$field` IS NULL"; 2347 continue; 2348 } 2349 2350 $conditions[] = "`$field` = " . $value['format']; 2351 $values[] = $value['value']; 2352 } 2353 2354 $fields = implode( ', ', $fields ); 2355 $conditions = implode( ' AND ', $conditions ); 2356 2357 $sql = "UPDATE `$table` SET $fields WHERE $conditions"; 2358 2359 $this->check_current_query = false; 2360 return $this->query( $this->prepare( $sql, $values ) ); 2361 } 2362 2363 /** 2364 * Deletes a row in the table. 2365 * 2366 * Examples: 2367 * wpdb::delete( 'table', array( 'ID' => 1 ) ) 2368 * wpdb::delete( 'table', array( 'ID' => 1 ), array( '%d' ) ) 2369 * 2370 * @since 3.4.0 2371 * 2372 * @see wpdb::prepare() 2373 * @see wpdb::$field_types 2374 * @see wp_set_wpdb_vars() 2375 * 2376 * @param string $table Table name. 2377 * @param array $where A named array of WHERE clauses (in column => value pairs). 2378 * Multiple clauses will be joined with ANDs. 2379 * Both $where columns and $where values should be "raw". 2380 * Sending a null value will create an IS NULL comparison - the corresponding 2381 * format will be ignored in this case. 2382 * @param array|string $where_format Optional. An array of formats to be mapped to each of the values in $where. 2383 * If string, that format will be used for all of the items in $where. 2384 * A format is one of '%d', '%f', '%s' (integer, float, string). 2385 * If omitted, all values in $data will be treated as strings unless otherwise 2386 * specified in wpdb::$field_types. 2387 * @return int|false The number of rows updated, or false on error. 2388 */ 2389 public function delete( $table, $where, $where_format = null ) { 2390 if ( ! is_array( $where ) ) { 2391 return false; 2392 } 2393 2394 $where = $this->process_fields( $table, $where, $where_format ); 2395 if ( false === $where ) { 2396 return false; 2397 } 2398 2399 $conditions = array(); 2400 $values = array(); 2401 foreach ( $where as $field => $value ) { 2402 if ( is_null( $value['value'] ) ) { 2403 $conditions[] = "`$field` IS NULL"; 2404 continue; 2405 } 2406 2407 $conditions[] = "`$field` = " . $value['format']; 2408 $values[] = $value['value']; 2409 } 2410 2411 $conditions = implode( ' AND ', $conditions ); 2412 2413 $sql = "DELETE FROM `$table` WHERE $conditions"; 2414 2415 $this->check_current_query = false; 2416 return $this->query( $this->prepare( $sql, $values ) ); 2417 } 2418 2419 /** 2420 * Processes arrays of field/value pairs and field formats. 2421 * 2422 * This is a helper method for wpdb's CRUD methods, which take field/value pairs 2423 * for inserts, updates, and where clauses. This method first pairs each value 2424 * with a format. Then it determines the charset of that field, using that 2425 * to determine if any invalid text would be stripped. If text is stripped, 2426 * then field processing is rejected and the query fails. 2427 * 2428 * @since 4.2.0 2429 * 2430 * @param string $table Table name. 2431 * @param array $data Field/value pair. 2432 * @param mixed $format Format for each field. 2433 * @return array|false An array of fields that contain paired value and formats. 2434 * False for invalid values. 2435 */ 2436 protected function process_fields( $table, $data, $format ) { 2437 $data = $this->process_field_formats( $data, $format ); 2438 if ( false === $data ) { 2439 return false; 2440 } 2441 2442 $data = $this->process_field_charsets( $data, $table ); 2443 if ( false === $data ) { 2444 return false; 2445 } 2446 2447 $data = $this->process_field_lengths( $data, $table ); 2448 if ( false === $data ) { 2449 return false; 2450 } 2451 2452 $converted_data = $this->strip_invalid_text( $data ); 2453 2454 if ( $data !== $converted_data ) { 2455 return false; 2456 } 2457 2458 return $data; 2459 } 2460 2461 /** 2462 * Prepares arrays of value/format pairs as passed to wpdb CRUD methods. 2463 * 2464 * @since 4.2.0 2465 * 2466 * @param array $data Array of fields to values. 2467 * @param mixed $format Formats to be mapped to the values in $data. 2468 * @return array Array, keyed by field names with values being an array 2469 * of 'value' and 'format' keys. 2470 */ 2471 protected function process_field_formats( $data, $format ) { 2472 $formats = (array) $format; 2473 $original_formats = $formats; 2474 2475 foreach ( $data as $field => $value ) { 2476 $value = array( 2477 'value' => $value, 2478 'format' => '%s', 2479 ); 2480 2481 if ( ! empty( $format ) ) { 2482 $value['format'] = array_shift( $formats ); 2483 if ( ! $value['format'] ) { 2484 $value['format'] = reset( $original_formats ); 2485 } 2486 } elseif ( isset( $this->field_types[ $field ] ) ) { 2487 $value['format'] = $this->field_types[ $field ]; 2488 } 2489 2490 $data[ $field ] = $value; 2491 } 2492 2493 return $data; 2494 } 2495 2496 /** 2497 * Adds field charsets to field/value/format arrays generated by wpdb::process_field_formats(). 2498 * 2499 * @since 4.2.0 2500 * 2501 * @param array $data As it comes from the wpdb::process_field_formats() method. 2502 * @param string $table Table name. 2503 * @return array|false The same array as $data with additional 'charset' keys. 2504 * False on failure. 2505 */ 2506 protected function process_field_charsets( $data, $table ) { 2507 foreach ( $data as $field => $value ) { 2508 if ( '%d' === $value['format'] || '%f' === $value['format'] ) { 2509 /* 2510 * We can skip this field if we know it isn't a string. 2511 * This checks %d/%f versus ! %s because its sprintf() could take more. 2512 */ 2513 $value['charset'] = false; 2514 } else { 2515 $value['charset'] = $this->get_col_charset( $table, $field ); 2516 if ( is_wp_error( $value['charset'] ) ) { 2517 return false; 2518 } 2519 } 2520 2521 $data[ $field ] = $value; 2522 } 2523 2524 return $data; 2525 } 2526 2527 /** 2528 * For string fields, records the maximum string length that field can safely save. 2529 * 2530 * @since 4.2.1 2531 * 2532 * @param array $data As it comes from the wpdb::process_field_charsets() method. 2533 * @param string $table Table name. 2534 * @return array|false The same array as $data with additional 'length' keys, or false if 2535 * any of the values were too long for their corresponding field. 2536 */ 2537 protected function process_field_lengths( $data, $table ) { 2538 foreach ( $data as $field => $value ) { 2539 if ( '%d' === $value['format'] || '%f' === $value['format'] ) { 2540 /* 2541 * We can skip this field if we know it isn't a string. 2542 * This checks %d/%f versus ! %s because its sprintf() could take more. 2543 */ 2544 $value['length'] = false; 2545 } else { 2546 $value['length'] = $this->get_col_length( $table, $field ); 2547 if ( is_wp_error( $value['length'] ) ) { 2548 return false; 2549 } 2550 } 2551 2552 $data[ $field ] = $value; 2553 } 2554 2555 return $data; 2556 } 2557 2558 /** 2559 * Retrieves one variable from the database. 2560 * 2561 * Executes a SQL query and returns the value from the SQL result. 2562 * If the SQL result contains more than one column and/or more than one row, 2563 * the value in the column and row specified is returned. If $query is null, 2564 * the value in the specified column and row from the previous SQL result is returned. 2565 * 2566 * @since 0.71 2567 * 2568 * @param string|null $query Optional. SQL query. Defaults to null, use the result from the previous query. 2569 * @param int $x Optional. Column of value to return. Indexed from 0. 2570 * @param int $y Optional. Row of value to return. Indexed from 0. 2571 * @return string|null Database query result (as string), or null on failure. 2572 */ 2573 public function get_var( $query = null, $x = 0, $y = 0 ) { 2574 $this->func_call = "\$db->get_var(\"$query\", $x, $y)"; 2575 2576 if ( $this->check_current_query && $this->check_safe_collation( $query ) ) { 2577 $this->check_current_query = false; 2578 } 2579 2580 if ( $query ) { 2581 $this->query( $query ); 2582 } 2583 2584 // Extract var out of cached results based on x,y vals. 2585 if ( ! empty( $this->last_result[ $y ] ) ) { 2586 $values = array_values( get_object_vars( $this->last_result[ $y ] ) ); 2587 } 2588 2589 // If there is a value return it, else return null. 2590 return ( isset( $values[ $x ] ) && '' !== $values[ $x ] ) ? $values[ $x ] : null; 2591 } 2592 2593 /** 2594 * Retrieves one row from the database. 2595 * 2596 * Executes a SQL query and returns the row from the SQL result. 2597 * 2598 * @since 0.71 2599 * 2600 * @param string|null $query SQL query. 2601 * @param string $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which 2602 * correspond to an stdClass object, an associative array, or a numeric array, 2603 * respectively. Default OBJECT. 2604 * @param int $y Optional. Row to return. Indexed from 0. 2605 * @return array|object|null|void Database query result in format specified by $output or null on failure. 2606 */ 2607 public function get_row( $query = null, $output = OBJECT, $y = 0 ) { 2608 $this->func_call = "\$db->get_row(\"$query\",$output,$y)"; 2609 2610 if ( $this->check_current_query && $this->check_safe_collation( $query ) ) { 2611 $this->check_current_query = false; 2612 } 2613 2614 if ( $query ) { 2615 $this->query( $query ); 2616 } else { 2617 return null; 2618 } 2619 2620 if ( ! isset( $this->last_result[ $y ] ) ) { 2621 return null; 2622 } 2623 2624 if ( OBJECT === $output ) { 2625 return $this->last_result[ $y ] ? $this->last_result[ $y ] : null; 2626 } elseif ( ARRAY_A === $output ) { 2627 return $this->last_result[ $y ] ? get_object_vars( $this->last_result[ $y ] ) : null; 2628 } elseif ( ARRAY_N === $output ) { 2629 return $this->last_result[ $y ] ? array_values( get_object_vars( $this->last_result[ $y ] ) ) : null; 2630 } elseif ( OBJECT === strtoupper( $output ) ) { 2631 // Back compat for OBJECT being previously case-insensitive. 2632 return $this->last_result[ $y ] ? $this->last_result[ $y ] : null; 2633 } else { 2634 $this->print_error( ' $db->get_row(string query, output type, int offset) -- Output type must be one of: OBJECT, ARRAY_A, ARRAY_N' ); 2635 } 2636 } 2637 2638 /** 2639 * Retrieves one column from the database. 2640 * 2641 * Executes a SQL query and returns the column from the SQL result. 2642 * If the SQL result contains more than one column, the column specified is returned. 2643 * If $query is null, the specified column from the previous SQL result is returned. 2644 * 2645 * @since 0.71 2646 * 2647 * @param string|null $query Optional. SQL query. Defaults to previous query. 2648 * @param int $x Optional. Column to return. Indexed from 0. 2649 * @return array Database query result. Array indexed from 0 by SQL result row number. 2650 */ 2651 public function get_col( $query = null, $x = 0 ) { 2652 if ( $this->check_current_query && $this->check_safe_collation( $query ) ) { 2653 $this->check_current_query = false; 2654 } 2655 2656 if ( $query ) { 2657 $this->query( $query ); 2658 } 2659 2660 $new_array = array(); 2661 // Extract the column values. 2662 if ( $this->last_result ) { 2663 for ( $i = 0, $j = count( $this->last_result ); $i < $j; $i++ ) { 2664 $new_array[ $i ] = $this->get_var( null, $x, $i ); 2665 } 2666 } 2667 return $new_array; 2668 } 2669 2670 /** 2671 * Retrieves an entire SQL result set from the database (i.e., many rows). 2672 * 2673 * Executes a SQL query and returns the entire SQL result. 2674 * 2675 * @since 0.71 2676 * 2677 * @param string $query SQL query. 2678 * @param string $output Optional. Any of ARRAY_A | ARRAY_N | OBJECT | OBJECT_K constants. 2679 * With one of the first three, return an array of rows indexed 2680 * from 0 by SQL result row number. Each row is an associative array 2681 * (column => value, ...), a numerically indexed array (0 => value, ...), 2682 * or an object ( ->column = value ), respectively. With OBJECT_K, 2683 * return an associative array of row objects keyed by the value 2684 * of each row's first column's value. Duplicate keys are discarded. 2685 * @return array|object|null Database query results. 2686 */ 2687 public function get_results( $query = null, $output = OBJECT ) { 2688 $this->func_call = "\$db->get_results(\"$query\", $output)"; 2689 2690 if ( $this->check_current_query && $this->check_safe_collation( $query ) ) { 2691 $this->check_current_query = false; 2692 } 2693 2694 if ( $query ) { 2695 $this->query( $query ); 2696 } else { 2697 return null; 2698 } 2699 2700 $new_array = array(); 2701 if ( OBJECT === $output ) { 2702 // Return an integer-keyed array of row objects. 2703 return $this->last_result; 2704 } elseif ( OBJECT_K === $output ) { 2705 // Return an array of row objects with keys from column 1. 2706 // (Duplicates are discarded.) 2707 if ( $this->last_result ) { 2708 foreach ( $this->last_result as $row ) { 2709 $var_by_ref = get_object_vars( $row ); 2710 $key = array_shift( $var_by_ref ); 2711 if ( ! isset( $new_array[ $key ] ) ) { 2712 $new_array[ $key ] = $row; 2713 } 2714 } 2715 } 2716 return $new_array; 2717 } elseif ( ARRAY_A === $output || ARRAY_N === $output ) { 2718 // Return an integer-keyed array of... 2719 if ( $this->last_result ) { 2720 foreach ( (array) $this->last_result as $row ) { 2721 if ( ARRAY_N === $output ) { 2722 // ...integer-keyed row arrays. 2723 $new_array[] = array_values( get_object_vars( $row ) ); 2724 } else { 2725 // ...column name-keyed row arrays. 2726 $new_array[] = get_object_vars( $row ); 2727 } 2728 } 2729 } 2730 return $new_array; 2731 } elseif ( strtoupper( $output ) === OBJECT ) { 2732 // Back compat for OBJECT being previously case-insensitive. 2733 return $this->last_result; 2734 } 2735 return null; 2736 } 2737 2738 /** 2739 * Retrieves the character set for the given table. 2740 * 2741 * @since 4.2.0 2742 * 2743 * @param string $table Table name. 2744 * @return string|WP_Error Table character set, WP_Error object if it couldn't be found. 2745 */ 2746 protected function get_table_charset( $table ) { 2747 $tablekey = strtolower( $table ); 2748 2749 /** 2750 * Filters the table charset value before the DB is checked. 2751 * 2752 * Passing a non-null value to the filter will effectively short-circuit 2753 * checking the DB for the charset, returning that value instead. 2754 * 2755 * @since 4.2.0 2756 * 2757 * @param string|null $charset The character set to use. Default null. 2758 * @param string $table The name of the table being checked. 2759 */ 2760 $charset = apply_filters( 'pre_get_table_charset', null, $table ); 2761 if ( null !== $charset ) { 2762 return $charset; 2763 } 2764 2765 if ( isset( $this->table_charset[ $tablekey ] ) ) { 2766 return $this->table_charset[ $tablekey ]; 2767 } 2768 2769 $charsets = array(); 2770 $columns = array(); 2771 2772 $table_parts = explode( '.', $table ); 2773 $table = '`' . implode( '`.`', $table_parts ) . '`'; 2774 $results = $this->get_results( "SHOW FULL COLUMNS FROM $table" ); 2775 if ( ! $results ) { 2776 return new WP_Error( 'wpdb_get_table_charset_failure' ); 2777 } 2778 2779 foreach ( $results as $column ) { 2780 $columns[ strtolower( $column->Field ) ] = $column; 2781 } 2782 2783 $this->col_meta[ $tablekey ] = $columns; 2784 2785 foreach ( $columns as $column ) { 2786 if ( ! empty( $column->Collation ) ) { 2787 list( $charset ) = explode( '_', $column->Collation ); 2788 2789 // If the current connection can't support utf8mb4 characters, let's only send 3-byte utf8 characters. 2790 if ( 'utf8mb4' === $charset && ! $this->has_cap( 'utf8mb4' ) ) { 2791 $charset = 'utf8'; 2792 } 2793 2794 $charsets[ strtolower( $charset ) ] = true; 2795 } 2796 2797 list( $type ) = explode( '(', $column->Type ); 2798 2799 // A binary/blob means the whole query gets treated like this. 2800 if ( in_array( strtoupper( $type ), array( 'BINARY', 'VARBINARY', 'TINYBLOB', 'MEDIUMBLOB', 'BLOB', 'LONGBLOB' ), true ) ) { 2801 $this->table_charset[ $tablekey ] = 'binary'; 2802 return 'binary'; 2803 } 2804 } 2805 2806 // utf8mb3 is an alias for utf8. 2807 if ( isset( $charsets['utf8mb3'] ) ) { 2808 $charsets['utf8'] = true; 2809 unset( $charsets['utf8mb3'] ); 2810 } 2811 2812 // Check if we have more than one charset in play. 2813 $count = count( $charsets ); 2814 if ( 1 === $count ) { 2815 $charset = key( $charsets ); 2816 } elseif ( 0 === $count ) { 2817 // No charsets, assume this table can store whatever. 2818 $charset = false; 2819 } else { 2820 // More than one charset. Remove latin1 if present and recalculate. 2821 unset( $charsets['latin1'] ); 2822 $count = count( $charsets ); 2823 if ( 1 === $count ) { 2824 // Only one charset (besides latin1). 2825 $charset = key( $charsets ); 2826 } elseif ( 2 === $count && isset( $charsets['utf8'], $charsets['utf8mb4'] ) ) { 2827 // Two charsets, but they're utf8 and utf8mb4, use utf8. 2828 $charset = 'utf8'; 2829 } else { 2830 // Two mixed character sets. ascii. 2831 $charset = 'ascii'; 2832 } 2833 } 2834 2835 $this->table_charset[ $tablekey ] = $charset; 2836 return $charset; 2837 } 2838 2839 /** 2840 * Retrieves the character set for the given column. 2841 * 2842 * @since 4.2.0 2843 * 2844 * @param string $table Table name. 2845 * @param string $column Column name. 2846 * @return string|false|WP_Error Column character set as a string. False if the column has 2847 * no character set. WP_Error object if there was an error. 2848 */ 2849 public function get_col_charset( $table, $column ) { 2850 $tablekey = strtolower( $table ); 2851 $columnkey = strtolower( $column ); 2852 2853 /** 2854 * Filters the column charset value before the DB is checked. 2855 * 2856 * Passing a non-null value to the filter will short-circuit 2857 * checking the DB for the charset, returning that value instead. 2858 * 2859 * @since 4.2.0 2860 * 2861 * @param string|null $charset The character set to use. Default null. 2862 * @param string $table The name of the table being checked. 2863 * @param string $column The name of the column being checked. 2864 */ 2865 $charset = apply_filters( 'pre_get_col_charset', null, $table, $column ); 2866 if ( null !== $charset ) { 2867 return $charset; 2868 } 2869 2870 // Skip this entirely if this isn't a MySQL database. 2871 if ( empty( $this->is_mysql ) ) { 2872 return false; 2873 } 2874 2875 if ( empty( $this->table_charset[ $tablekey ] ) ) { 2876 // This primes column information for us. 2877 $table_charset = $this->get_table_charset( $table ); 2878 if ( is_wp_error( $table_charset ) ) { 2879 return $table_charset; 2880 } 2881 } 2882 2883 // If still no column information, return the table charset. 2884 if ( empty( $this->col_meta[ $tablekey ] ) ) { 2885 return $this->table_charset[ $tablekey ]; 2886 } 2887 2888 // If this column doesn't exist, return the table charset. 2889 if ( empty( $this->col_meta[ $tablekey ][ $columnkey ] ) ) { 2890 return $this->table_charset[ $tablekey ]; 2891 } 2892 2893 // Return false when it's not a string column. 2894 if ( empty( $this->col_meta[ $tablekey ][ $columnkey ]->Collation ) ) { 2895 return false; 2896 } 2897 2898 list( $charset ) = explode( '_', $this->col_meta[ $tablekey ][ $columnkey ]->Collation ); 2899 return $charset; 2900 } 2901 2902 /** 2903 * Retrieves the maximum string length allowed in a given column. 2904 * 2905 * The length may either be specified as a byte length or a character length. 2906 * 2907 * @since 4.2.1 2908 * 2909 * @param string $table Table name. 2910 * @param string $column Column name. 2911 * @return array|false|WP_Error array( 'length' => (int), 'type' => 'byte' | 'char' ). 2912 * False if the column has no length (for example, numeric column). 2913 * WP_Error object if there was an error. 2914 */ 2915 public function get_col_length( $table, $column ) { 2916 $tablekey = strtolower( $table ); 2917 $columnkey = strtolower( $column ); 2918 2919 // Skip this entirely if this isn't a MySQL database. 2920 if ( empty( $this->is_mysql ) ) { 2921 return false; 2922 } 2923 2924 if ( empty( $this->col_meta[ $tablekey ] ) ) { 2925 // This primes column information for us. 2926 $table_charset = $this->get_table_charset( $table ); 2927 if ( is_wp_error( $table_charset ) ) { 2928 return $table_charset; 2929 } 2930 } 2931 2932 if ( empty( $this->col_meta[ $tablekey ][ $columnkey ] ) ) { 2933 return false; 2934 } 2935 2936 $typeinfo = explode( '(', $this->col_meta[ $tablekey ][ $columnkey ]->Type ); 2937 2938 $type = strtolower( $typeinfo[0] ); 2939 if ( ! empty( $typeinfo[1] ) ) { 2940 $length = trim( $typeinfo[1], ')' ); 2941 } else { 2942 $length = false; 2943 } 2944 2945 switch ( $type ) { 2946 case 'char': 2947 case 'varchar': 2948 return array( 2949 'type' => 'char', 2950 'length' => (int) $length, 2951 ); 2952 2953 case 'binary': 2954 case 'varbinary': 2955 return array( 2956 'type' => 'byte', 2957 'length' => (int) $length, 2958 ); 2959 2960 case 'tinyblob': 2961 case 'tinytext': 2962 return array( 2963 'type' => 'byte', 2964 'length' => 255, // 2^8 - 1 2965 ); 2966 2967 case 'blob': 2968 case 'text': 2969 return array( 2970 'type' => 'byte', 2971 'length' => 65535, // 2^16 - 1 2972 ); 2973 2974 case 'mediumblob': 2975 case 'mediumtext': 2976 return array( 2977 'type' => 'byte', 2978 'length' => 16777215, // 2^24 - 1 2979 ); 2980 2981 case 'longblob': 2982 case 'longtext': 2983 return array( 2984 'type' => 'byte', 2985 'length' => 4294967295, // 2^32 - 1 2986 ); 2987 2988 default: 2989 return false; 2990 } 2991 } 2992 2993 /** 2994 * Checks if a string is ASCII. 2995 * 2996 * The negative regex is faster for non-ASCII strings, as it allows 2997 * the search to finish as soon as it encounters a non-ASCII character. 2998 * 2999 * @since 4.2.0 3000 * 3001 * @param string $string String to check. 3002 * @return bool True if ASCII, false if not. 3003 */ 3004 protected function check_ascii( $string ) { 3005 if ( function_exists( 'mb_check_encoding' ) ) { 3006 if ( mb_check_encoding( $string, 'ASCII' ) ) { 3007 return true; 3008 } 3009 } elseif ( ! preg_match( '/[^\x00-\x7F]/', $string ) ) { 3010 return true; 3011 } 3012 3013 return false; 3014 } 3015 3016 /** 3017 * Checks if the query is accessing a collation considered safe on the current version of MySQL. 3018 * 3019 * @since 4.2.0 3020 * 3021 * @param string $query The query to check. 3022 * @return bool True if the collation is safe, false if it isn't. 3023 */ 3024 protected function check_safe_collation( $query ) { 3025 if ( $this->checking_collation ) { 3026 return true; 3027 } 3028 3029 // We don't need to check the collation for queries that don't read data. 3030 $query = ltrim( $query, "\r\n\t (" ); 3031 if ( preg_match( '/^(?:SHOW|DESCRIBE|DESC|EXPLAIN|CREATE)\s/i', $query ) ) { 3032 return true; 3033 } 3034 3035 // All-ASCII queries don't need extra checking. 3036 if ( $this->check_ascii( $query ) ) { 3037 return true; 3038 } 3039 3040 $table = $this->get_table_from_query( $query ); 3041 if ( ! $table ) { 3042 return false; 3043 } 3044 3045 $this->checking_collation = true; 3046 $collation = $this->get_table_charset( $table ); 3047 $this->checking_collation = false; 3048 3049 // Tables with no collation, or latin1 only, don't need extra checking. 3050 if ( false === $collation || 'latin1' === $collation ) { 3051 return true; 3052 } 3053 3054 $table = strtolower( $table ); 3055 if ( empty( $this->col_meta[ $table ] ) ) { 3056 return false; 3057 } 3058 3059 // If any of the columns don't have one of these collations, it needs more sanity checking. 3060 foreach ( $this->col_meta[ $table ] as $col ) { 3061 if ( empty( $col->Collation ) ) { 3062 continue; 3063 } 3064 3065 if ( ! in_array( $col->Collation, array( 'utf8_general_ci', 'utf8_bin', 'utf8mb4_general_ci', 'utf8mb4_bin' ), true ) ) { 3066 return false; 3067 } 3068 } 3069 3070 return true; 3071 } 3072 3073 /** 3074 * Strips any invalid characters based on value/charset pairs. 3075 * 3076 * @since 4.2.0 3077 * 3078 * @param array $data Array of value arrays. Each value array has the keys 'value' and 'charset'. 3079 * An optional 'ascii' key can be set to false to avoid redundant ASCII checks. 3080 * @return array|WP_Error The $data parameter, with invalid characters removed from each value. 3081 * This works as a passthrough: any additional keys such as 'field' are 3082 * retained in each value array. If we cannot remove invalid characters, 3083 * a WP_Error object is returned. 3084 */ 3085 protected function strip_invalid_text( $data ) { 3086 $db_check_string = false; 3087 3088 foreach ( $data as &$value ) { 3089 $charset = $value['charset']; 3090 3091 if ( is_array( $value['length'] ) ) { 3092 $length = $value['length']['length']; 3093 $truncate_by_byte_length = 'byte' === $value['length']['type']; 3094 } else { 3095 $length = false; 3096 // Since we have no length, we'll never truncate. Initialize the variable to false. 3097 // True would take us through an unnecessary (for this case) codepath below. 3098 $truncate_by_byte_length = false; 3099 } 3100 3101 // There's no charset to work with. 3102 if ( false === $charset ) { 3103 continue; 3104 } 3105 3106 // Column isn't a string. 3107 if ( ! is_string( $value['value'] ) ) { 3108 continue; 3109 } 3110 3111 $needs_validation = true; 3112 if ( 3113 // latin1 can store any byte sequence. 3114 'latin1' === $charset 3115 || 3116 // ASCII is always OK. 3117 ( ! isset( $value['ascii'] ) && $this->check_ascii( $value['value'] ) ) 3118 ) { 3119 $truncate_by_byte_length = true; 3120 $needs_validation = false; 3121 } 3122 3123 if ( $truncate_by_byte_length ) { 3124 mbstring_binary_safe_encoding(); 3125 if ( false !== $length && strlen( $value['value'] ) > $length ) { 3126 $value['value'] = substr( $value['value'], 0, $length ); 3127 } 3128 reset_mbstring_encoding(); 3129 3130 if ( ! $needs_validation ) { 3131 continue; 3132 } 3133 } 3134 3135 // utf8 can be handled by regex, which is a bunch faster than a DB lookup. 3136 if ( ( 'utf8' === $charset || 'utf8mb3' === $charset || 'utf8mb4' === $charset ) && function_exists( 'mb_strlen' ) ) { 3137 $regex = '/ 3138 ( 3139 (?: [\x00-\x7F] # single-byte sequences 0xxxxxxx 3140 | [\xC2-\xDF][\x80-\xBF] # double-byte sequences 110xxxxx 10xxxxxx 3141 | \xE0[\xA0-\xBF][\x80-\xBF] # triple-byte sequences 1110xxxx 10xxxxxx * 2 3142 | [\xE1-\xEC][\x80-\xBF]{2} 3143 | \xED[\x80-\x9F][\x80-\xBF] 3144 | [\xEE-\xEF][\x80-\xBF]{2}'; 3145 3146 if ( 'utf8mb4' === $charset ) { 3147 $regex .= ' 3148 | \xF0[\x90-\xBF][\x80-\xBF]{2} # four-byte sequences 11110xxx 10xxxxxx * 3 3149 | [\xF1-\xF3][\x80-\xBF]{3} 3150 | \xF4[\x80-\x8F][\x80-\xBF]{2} 3151 '; 3152 } 3153 3154 $regex .= '){1,40} # ...one or more times 3155 ) 3156 | . # anything else 3157 /x'; 3158 $value['value'] = preg_replace( $regex, '$1', $value['value'] ); 3159 3160 if ( false !== $length && mb_strlen( $value['value'], 'UTF-8' ) > $length ) { 3161 $value['value'] = mb_substr( $value['value'], 0, $length, 'UTF-8' ); 3162 } 3163 continue; 3164 } 3165 3166 // We couldn't use any local conversions, send it to the DB. 3167 $value['db'] = true; 3168 $db_check_string = true; 3169 } 3170 unset( $value ); // Remove by reference. 3171 3172 if ( $db_check_string ) { 3173 $queries = array(); 3174 foreach ( $data as $col => $value ) { 3175 if ( ! empty( $value['db'] ) ) { 3176 // We're going to need to truncate by characters or bytes, depending on the length value we have. 3177 if ( isset( $value['length']['type'] ) && 'byte' === $value['length']['type'] ) { 3178 // Using binary causes LEFT() to truncate by bytes. 3179 $charset = 'binary'; 3180 } else { 3181 $charset = $value['charset']; 3182 } 3183 3184 if ( $this->charset ) { 3185 $connection_charset = $this->charset; 3186 } else { 3187 if ( $this->use_mysqli ) { 3188 $connection_charset = mysqli_character_set_name( $this->dbh ); 3189 } else { 3190 $connection_charset = mysql_client_encoding(); 3191 } 3192 } 3193 3194 if ( is_array( $value['length'] ) ) { 3195 $length = sprintf( '%.0f', $value['length']['length'] ); 3196 $queries[ $col ] = $this->prepare( "CONVERT( LEFT( CONVERT( %s USING $charset ), $length ) USING $connection_charset )", $value['value'] ); 3197 } elseif ( 'binary' !== $charset ) { 3198 // If we don't have a length, there's no need to convert binary - it will always return the same result. 3199 $queries[ $col ] = $this->prepare( "CONVERT( CONVERT( %s USING $charset ) USING $connection_charset )", $value['value'] ); 3200 } 3201 3202 unset( $data[ $col ]['db'] ); 3203 } 3204 } 3205 3206 $sql = array(); 3207 foreach ( $queries as $column => $query ) { 3208 if ( ! $query ) { 3209 continue; 3210 } 3211 3212 $sql[] = $query . " AS x_$column"; 3213 } 3214 3215 $this->check_current_query = false; 3216 $row = $this->get_row( 'SELECT ' . implode( ', ', $sql ), ARRAY_A ); 3217 if ( ! $row ) { 3218 return new WP_Error( 'wpdb_strip_invalid_text_failure' ); 3219 } 3220 3221 foreach ( array_keys( $data ) as $column ) { 3222 if ( isset( $row[ "x_$column" ] ) ) { 3223 $data[ $column ]['value'] = $row[ "x_$column" ]; 3224 } 3225 } 3226 } 3227 3228 return $data; 3229 } 3230 3231 /** 3232 * Strips any invalid characters from the query. 3233 * 3234 * @since 4.2.0 3235 * 3236 * @param string $query Query to convert. 3237 * @return string|WP_Error The converted query, or a WP_Error object if the conversion fails. 3238 */ 3239 protected function strip_invalid_text_from_query( $query ) { 3240 // We don't need to check the collation for queries that don't read data. 3241 $trimmed_query = ltrim( $query, "\r\n\t (" ); 3242 if ( preg_match( '/^(?:SHOW|DESCRIBE|DESC|EXPLAIN|CREATE)\s/i', $trimmed_query ) ) { 3243 return $query; 3244 } 3245 3246 $table = $this->get_table_from_query( $query ); 3247 if ( $table ) { 3248 $charset = $this->get_table_charset( $table ); 3249 if ( is_wp_error( $charset ) ) { 3250 return $charset; 3251 } 3252 3253 // We can't reliably strip text from tables containing binary/blob columns. 3254 if ( 'binary' === $charset ) { 3255 return $query; 3256 } 3257 } else { 3258 $charset = $this->charset; 3259 } 3260 3261 $data = array( 3262 'value' => $query, 3263 'charset' => $charset, 3264 'ascii' => false, 3265 'length' => false, 3266 ); 3267 3268 $data = $this->strip_invalid_text( array( $data ) ); 3269 if ( is_wp_error( $data ) ) { 3270 return $data; 3271 } 3272 3273 return $data[0]['value']; 3274 } 3275 3276 /** 3277 * Strips any invalid characters from the string for a given table and column. 3278 * 3279 * @since 4.2.0 3280 * 3281 * @param string $table Table name. 3282 * @param string $column Column name. 3283 * @param string $value The text to check. 3284 * @return string|WP_Error The converted string, or a WP_Error object if the conversion fails. 3285 */ 3286 public function strip_invalid_text_for_column( $table, $column, $value ) { 3287 if ( ! is_string( $value ) ) { 3288 return $value; 3289 } 3290 3291 $charset = $this->get_col_charset( $table, $column ); 3292 if ( ! $charset ) { 3293 // Not a string column. 3294 return $value; 3295 } elseif ( is_wp_error( $charset ) ) { 3296 // Bail on real errors. 3297 return $charset; 3298 } 3299 3300 $data = array( 3301 $column => array( 3302 'value' => $value, 3303 'charset' => $charset, 3304 'length' => $this->get_col_length( $table, $column ), 3305 ), 3306 ); 3307 3308 $data = $this->strip_invalid_text( $data ); 3309 if ( is_wp_error( $data ) ) { 3310 return $data; 3311 } 3312 3313 return $data[ $column ]['value']; 3314 } 3315 3316 /** 3317 * Finds the first table name referenced in a query. 3318 * 3319 * @since 4.2.0 3320 * 3321 * @param string $query The query to search. 3322 * @return string|false The table name found, or false if a table couldn't be found. 3323 */ 3324 protected function get_table_from_query( $query ) { 3325 // Remove characters that can legally trail the table name. 3326 $query = rtrim( $query, ';/-#' ); 3327 3328 // Allow (select...) union [...] style queries. Use the first query's table name. 3329 $query = ltrim( $query, "\r\n\t (" ); 3330 3331 // Strip everything between parentheses except nested selects. 3332 $query = preg_replace( '/\((?!\s*select)[^(]*?\)/is', '()', $query ); 3333 3334 // Quickly match most common queries. 3335 if ( preg_match( 3336 '/^\s*(?:' 3337 . 'SELECT.*?\s+FROM' 3338 . '|INSERT(?:\s+LOW_PRIORITY|\s+DELAYED|\s+HIGH_PRIORITY)?(?:\s+IGNORE)?(?:\s+INTO)?' 3339 . '|REPLACE(?:\s+LOW_PRIORITY|\s+DELAYED)?(?:\s+INTO)?' 3340 . '|UPDATE(?:\s+LOW_PRIORITY)?(?:\s+IGNORE)?' 3341 . '|DELETE(?:\s+LOW_PRIORITY|\s+QUICK|\s+IGNORE)*(?:.+?FROM)?' 3342 . ')\s+((?:[0-9a-zA-Z$_.`-]|[\xC2-\xDF][\x80-\xBF])+)/is', 3343 $query, 3344 $maybe 3345 ) ) { 3346 return str_replace( '`', '', $maybe[1] ); 3347 } 3348 3349 // SHOW TABLE STATUS and SHOW TABLES WHERE Name = 'wp_posts' 3350 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 ) ) { 3351 return $maybe[2]; 3352 } 3353 3354 /* 3355 * SHOW TABLE STATUS LIKE and SHOW TABLES LIKE 'wp\_123\_%' 3356 * This quoted LIKE operand seldom holds a full table name. 3357 * It is usually a pattern for matching a prefix so we just 3358 * strip the trailing % and unescape the _ to get 'wp_123_' 3359 * which drop-ins can use for routing these SQL statements. 3360 */ 3361 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 ) ) { 3362 return str_replace( '\\_', '_', $maybe[2] ); 3363 } 3364 3365 // Big pattern for the rest of the table-related queries. 3366 if ( preg_match( 3367 '/^\s*(?:' 3368 . '(?:EXPLAIN\s+(?:EXTENDED\s+)?)?SELECT.*?\s+FROM' 3369 . '|DESCRIBE|DESC|EXPLAIN|HANDLER' 3370 . '|(?:LOCK|UNLOCK)\s+TABLE(?:S)?' 3371 . '|(?:RENAME|OPTIMIZE|BACKUP|RESTORE|CHECK|CHECKSUM|ANALYZE|REPAIR).*\s+TABLE' 3372 . '|TRUNCATE(?:\s+TABLE)?' 3373 . '|CREATE(?:\s+TEMPORARY)?\s+TABLE(?:\s+IF\s+NOT\s+EXISTS)?' 3374 . '|ALTER(?:\s+IGNORE)?\s+TABLE' 3375 . '|DROP\s+TABLE(?:\s+IF\s+EXISTS)?' 3376 . '|CREATE(?:\s+\w+)?\s+INDEX.*\s+ON' 3377 . '|DROP\s+INDEX.*\s+ON' 3378 . '|LOAD\s+DATA.*INFILE.*INTO\s+TABLE' 3379 . '|(?:GRANT|REVOKE).*ON\s+TABLE' 3380 . '|SHOW\s+(?:.*FROM|.*TABLE)' 3381 . ')\s+\(*\s*((?:[0-9a-zA-Z$_.`-]|[\xC2-\xDF][\x80-\xBF])+)\s*\)*/is', 3382 $query, 3383 $maybe 3384 ) ) { 3385 return str_replace( '`', '', $maybe[1] ); 3386 } 3387 3388 return false; 3389 } 3390 3391 /** 3392 * Loads the column metadata from the last query. 3393 * 3394 * @since 3.5.0 3395 */ 3396 protected function load_col_info() { 3397 if ( $this->col_info ) { 3398 return; 3399 } 3400 3401 if ( $this->use_mysqli ) { 3402 $num_fields = mysqli_num_fields( $this->result ); 3403 for ( $i = 0; $i < $num_fields; $i++ ) { 3404 $this->col_info[ $i ] = mysqli_fetch_field( $this->result ); 3405 } 3406 } else { 3407 $num_fields = mysql_num_fields( $this->result ); 3408 for ( $i = 0; $i < $num_fields; $i++ ) { 3409 $this->col_info[ $i ] = mysql_fetch_field( $this->result, $i ); 3410 } 3411 } 3412 } 3413 3414 /** 3415 * Retrieves column metadata from the last query. 3416 * 3417 * @since 0.71 3418 * 3419 * @param string $info_type Optional. Possible values include 'name', 'table', 'def', 'max_length', 3420 * 'not_null', 'primary_key', 'multiple_key', 'unique_key', 'numeric', 3421 * 'blob', 'type', 'unsigned', 'zerofill'. Default 'name'. 3422 * @param int $col_offset Optional. 0: col name. 1: which table the col's in. 2: col's max length. 3423 * 3: if the col is numeric. 4: col's type. Default -1. 3424 * @return mixed Column results. 3425 */ 3426 public function get_col_info( $info_type = 'name', $col_offset = -1 ) { 3427 $this->load_col_info(); 3428 3429 if ( $this->col_info ) { 3430 if ( -1 === $col_offset ) { 3431 $i = 0; 3432 $new_array = array(); 3433 foreach ( (array) $this->col_info as $col ) { 3434 $new_array[ $i ] = $col->{$info_type}; 3435 $i++; 3436 } 3437 return $new_array; 3438 } else { 3439 return $this->col_info[ $col_offset ]->{$info_type}; 3440 } 3441 } 3442 } 3443 3444 /** 3445 * Starts the timer, for debugging purposes. 3446 * 3447 * @since 1.5.0 3448 * 3449 * @return true 3450 */ 3451 public function timer_start() { 3452 $this->time_start = microtime( true ); 3453 return true; 3454 } 3455 3456 /** 3457 * Stops the debugging timer. 3458 * 3459 * @since 1.5.0 3460 * 3461 * @return float Total time spent on the query, in seconds. 3462 */ 3463 public function timer_stop() { 3464 return ( microtime( true ) - $this->time_start ); 3465 } 3466 3467 /** 3468 * Wraps errors in a nice header and footer and dies. 3469 * 3470 * Will not die if wpdb::$show_errors is false. 3471 * 3472 * @since 1.5.0 3473 * 3474 * @param string $message The error message. 3475 * @param string $error_code Optional. A computer-readable string to identify the error. 3476 * Default '500'. 3477 * @return void|false Void if the showing of errors is enabled, false if disabled. 3478 */ 3479 public function bail( $message, $error_code = '500' ) { 3480 if ( $this->show_errors ) { 3481 $error = ''; 3482 3483 if ( $this->use_mysqli ) { 3484 if ( $this->dbh instanceof mysqli ) { 3485 $error = mysqli_error( $this->dbh ); 3486 } elseif ( mysqli_connect_errno() ) { 3487 $error = mysqli_connect_error(); 3488 } 3489 } else { 3490 if ( is_resource( $this->dbh ) ) { 3491 $error = mysql_error( $this->dbh ); 3492 } else { 3493 $error = mysql_error(); 3494 } 3495 } 3496 3497 if ( $error ) { 3498 $message = '<p><code>' . $error . "</code></p>\n" . $message; 3499 } 3500 3501 wp_die( $message ); 3502 } else { 3503 if ( class_exists( 'WP_Error', false ) ) { 3504 $this->error = new WP_Error( $error_code, $message ); 3505 } else { 3506 $this->error = $message; 3507 } 3508 3509 return false; 3510 } 3511 } 3512 3513 3514 /** 3515 * Closes the current database connection. 3516 * 3517 * @since 4.5.0 3518 * 3519 * @return bool True if the connection was successfully closed, 3520 * false if it wasn't, or if the connection doesn't exist. 3521 */ 3522 public function close() { 3523 if ( ! $this->dbh ) { 3524 return false; 3525 } 3526 3527 if ( $this->use_mysqli ) { 3528 $closed = mysqli_close( $this->dbh ); 3529 } else { 3530 $closed = mysql_close( $this->dbh ); 3531 } 3532 3533 if ( $closed ) { 3534 $this->dbh = null; 3535 $this->ready = false; 3536 $this->has_connected = false; 3537 } 3538 3539 return $closed; 3540 } 3541 3542 /** 3543 * Determines whether MySQL database is at least the required minimum version. 3544 * 3545 * @since 2.5.0 3546 * 3547 * @global string $wp_version The WordPress version string. 3548 * @global string $required_mysql_version The required MySQL version string. 3549 * @return void|WP_Error 3550 */ 3551 public function check_database_version() { 3552 global $wp_version, $required_mysql_version; 3553 // Make sure the server has the required MySQL version. 3554 if ( version_compare( $this->db_version(), $required_mysql_version, '<' ) ) { 3555 /* translators: 1: WordPress version number, 2: Minimum required MySQL version number. */ 3556 return new WP_Error( 'database_version', sprintf( __( '<strong>Error</strong>: WordPress %1$s requires MySQL %2$s or higher' ), $wp_version, $required_mysql_version ) ); 3557 } 3558 } 3559 3560 /** 3561 * Determines whether the database supports collation. 3562 * 3563 * Called when WordPress is generating the table scheme. 3564 * 3565 * Use `wpdb::has_cap( 'collation' )`. 3566 * 3567 * @since 2.5.0 3568 * @deprecated 3.5.0 Use wpdb::has_cap() 3569 * 3570 * @return bool True if collation is supported, false if not. 3571 */ 3572 public function supports_collation() { 3573 _deprecated_function( __FUNCTION__, '3.5.0', 'wpdb::has_cap( \'collation\' )' ); 3574 return $this->has_cap( 'collation' ); 3575 } 3576 3577 /** 3578 * Retrieves the database character collate. 3579 * 3580 * @since 3.5.0 3581 * 3582 * @return string The database character collate. 3583 */ 3584 public function get_charset_collate() { 3585 $charset_collate = ''; 3586 3587 if ( ! empty( $this->charset ) ) { 3588 $charset_collate = "DEFAULT CHARACTER SET $this->charset"; 3589 } 3590 if ( ! empty( $this->collate ) ) { 3591 $charset_collate .= " COLLATE $this->collate"; 3592 } 3593 3594 return $charset_collate; 3595 } 3596 3597 /** 3598 * Determines if a database supports a particular feature. 3599 * 3600 * @since 2.7.0 3601 * @since 4.1.0 Added support for the 'utf8mb4' feature. 3602 * @since 4.6.0 Added support for the 'utf8mb4_520' feature. 3603 * 3604 * @see wpdb::db_version() 3605 * 3606 * @param string $db_cap The feature to check for. Accepts 'collation', 'group_concat', 3607 * 'subqueries', 'set_charset', 'utf8mb4', or 'utf8mb4_520'. 3608 * @return int|false Whether the database feature is supported, false otherwise. 3609 */ 3610 public function has_cap( $db_cap ) { 3611 $version = $this->db_version(); 3612 3613 switch ( strtolower( $db_cap ) ) { 3614 case 'collation': // @since 2.5.0 3615 case 'group_concat': // @since 2.7.0 3616 case 'subqueries': // @since 2.7.0 3617 return version_compare( $version, '4.1', '>=' ); 3618 case 'set_charset': 3619 return version_compare( $version, '5.0.7', '>=' ); 3620 case 'utf8mb4': // @since 4.1.0 3621 if ( version_compare( $version, '5.5.3', '<' ) ) { 3622 return false; 3623 } 3624 if ( $this->use_mysqli ) { 3625 $client_version = mysqli_get_client_info(); 3626 } else { 3627 $client_version = mysql_get_client_info(); 3628 } 3629 3630 /* 3631 * libmysql has supported utf8mb4 since 5.5.3, same as the MySQL server. 3632 * mysqlnd has supported utf8mb4 since 5.0.9. 3633 */ 3634 if ( false !== strpos( $client_version, 'mysqlnd' ) ) { 3635 $client_version = preg_replace( '/^\D+([\d.]+).*/', '$1', $client_version ); 3636 return version_compare( $client_version, '5.0.9', '>=' ); 3637 } else { 3638 return version_compare( $client_version, '5.5.3', '>=' ); 3639 } 3640 case 'utf8mb4_520': // @since 4.6.0 3641 return version_compare( $version, '5.6', '>=' ); 3642 } 3643 3644 return false; 3645 } 3646 3647 /** 3648 * Retrieves a comma-separated list of the names of the functions that called wpdb. 3649 * 3650 * @since 2.5.0 3651 * 3652 * @return string Comma-separated list of the calling functions. 3653 */ 3654 public function get_caller() { 3655 return wp_debug_backtrace_summary( __CLASS__ ); 3656 } 3657 3658 /** 3659 * Retrieves the MySQL server version. 3660 * 3661 * @since 2.7.0 3662 * 3663 * @return string|null Version number on success, null on failure. 3664 */ 3665 public function db_version() { 3666 return preg_replace( '/[^0-9.].*/', '', $this->db_server_info() ); 3667 } 3668 3669 /** 3670 * Retrieves full MySQL server information. 3671 * 3672 * @since 5.5.0 3673 * 3674 * @return string|false Server info on success, false on failure. 3675 */ 3676 public function db_server_info() { 3677 if ( $this->use_mysqli ) { 3678 $server_info = mysqli_get_server_info( $this->dbh ); 3679 } else { 3680 $server_info = mysql_get_server_info( $this->dbh ); 3681 } 3682 3683 return $server_info; 3684 } 3685 }