populate_options( array $options = array() )

Create WordPress options and set the default values.


Description Description


Parameters Parameters

$options

(array) (Optional) Custom option $key => $value pairs to use.

Default value: array()


Top ↑

Source Source

File: wp-admin/includes/schema.php

367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
function populate_options( array $options = array() ) {
    global $wpdb, $wp_db_version, $wp_current_db_version;
 
    $guessurl = wp_guess_url();
    /**
     * Fires before creating WordPress options and populating their default values.
     *
     * @since 2.6.0
     */
    do_action( 'populate_options' );
 
    if ( ini_get( 'safe_mode' ) ) {
        // Safe mode can break mkdir() so use a flat structure by default.
        $uploads_use_yearmonth_folders = 0;
    } else {
        $uploads_use_yearmonth_folders = 1;
    }
 
    // If WP_DEFAULT_THEME doesn't exist, fall back to the latest core default theme.
    $stylesheet = WP_DEFAULT_THEME;
    $template   = WP_DEFAULT_THEME;
    $theme      = wp_get_theme( WP_DEFAULT_THEME );
    if ( ! $theme->exists() ) {
        $theme = WP_Theme::get_core_default_theme();
    }
 
    // If we can't find a core default theme, WP_DEFAULT_THEME is the best we can do.
    if ( $theme ) {
        $stylesheet = $theme->get_stylesheet();
        $template   = $theme->get_template();
    }
 
    $timezone_string = '';
    $gmt_offset      = 0;
    /*
     * translators: default GMT offset or timezone string. Must be either a valid offset (-12 to 14)
     * or a valid timezone string (America/New_York). See https://secure.php.net/manual/en/timezones.php
     * for all timezone strings supported by PHP.
     */
    $offset_or_tz = _x( '0', 'default GMT offset or timezone string' ); // phpcs:ignore WordPress.WP.I18n.NoEmptyStrings
    if ( is_numeric( $offset_or_tz ) ) {
        $gmt_offset = $offset_or_tz;
    } elseif ( $offset_or_tz && in_array( $offset_or_tz, timezone_identifiers_list() ) ) {
            $timezone_string = $offset_or_tz;
    }
 
    $defaults = array(
        'siteurl'                         => $guessurl,
        'home'                            => $guessurl,
        'blogname'                        => __( 'My Site' ),
        /* translators: site tagline */
        'blogdescription'                 => __( 'Just another WordPress site' ),
        'users_can_register'              => 0,
        'admin_email'                     => 'you@example.com',
        /* translators: default start of the week. 0 = Sunday, 1 = Monday */
        'start_of_week'                   => _x( '1', 'start of week' ),
        'use_balanceTags'                 => 0,
        'use_smilies'                     => 1,
        'require_name_email'              => 1,
        'comments_notify'                 => 1,
        'posts_per_rss'                   => 10,
        'rss_use_excerpt'                 => 0,
        'mailserver_url'                  => 'mail.example.com',
        'mailserver_login'                => 'login@example.com',
        'mailserver_pass'                 => 'password',
        'mailserver_port'                 => 110,
        'default_category'                => 1,
        'default_comment_status'          => 'open',
        'default_ping_status'             => 'open',
        'default_pingback_flag'           => 1,
        'posts_per_page'                  => 10,
        /* translators: default date format, see https://secure.php.net/date */
        'date_format'                     => __( 'F j, Y' ),
        /* translators: default time format, see https://secure.php.net/date */
        'time_format'                     => __( 'g:i a' ),
        /* translators: links last updated date format, see https://secure.php.net/date */
        'links_updated_date_format'       => __( 'F j, Y g:i a' ),
        'comment_moderation'              => 0,
        'moderation_notify'               => 1,
        'permalink_structure'             => '',
        'rewrite_rules'                   => '',
        'hack_file'                       => 0,
        'blog_charset'                    => 'UTF-8',
        'moderation_keys'                 => '',
        'active_plugins'                  => array(),
        'category_base'                   => '',
        'ping_sites'                      => 'http://rpc.pingomatic.com/',
        'comment_max_links'               => 2,
        'gmt_offset'                      => $gmt_offset,
 
        // 1.5
        'default_email_category'          => 1,
        'recently_edited'                 => '',
        'template'                        => $template,
        'stylesheet'                      => $stylesheet,
        'comment_whitelist'               => 1,
        'blacklist_keys'                  => '',
        'comment_registration'            => 0,
        'html_type'                       => 'text/html',
 
        // 1.5.1
        'use_trackback'                   => 0,
 
        // 2.0
        'default_role'                    => 'subscriber',
        'db_version'                      => $wp_db_version,
 
        // 2.0.1
        'uploads_use_yearmonth_folders'   => $uploads_use_yearmonth_folders,
        'upload_path'                     => '',
 
        // 2.1
        'blog_public'                     => '1',
        'default_link_category'           => 2,
        'show_on_front'                   => 'posts',
 
        // 2.2
        'tag_base'                        => '',
 
        // 2.5
        'show_avatars'                    => '1',
        'avatar_rating'                   => 'G',
        'upload_url_path'                 => '',
        'thumbnail_size_w'                => 150,
        'thumbnail_size_h'                => 150,
        'thumbnail_crop'                  => 1,
        'medium_size_w'                   => 300,
        'medium_size_h'                   => 300,
 
        // 2.6
        'avatar_default'                  => 'mystery',
 
        // 2.7
        'large_size_w'                    => 1024,
        'large_size_h'                    => 1024,
        'image_default_link_type'         => 'none',
        'image_default_size'              => '',
        'image_default_align'             => '',
        'close_comments_for_old_posts'    => 0,
        'close_comments_days_old'         => 14,
        'thread_comments'                 => 1,
        'thread_comments_depth'           => 5,
        'page_comments'                   => 0,
        'comments_per_page'               => 50,
        'default_comments_page'           => 'newest',
        'comment_order'                   => 'asc',
        'sticky_posts'                    => array(),
        'widget_categories'               => array(),
        'widget_text'                     => array(),
        'widget_rss'                      => array(),
        'uninstall_plugins'               => array(),
 
        // 2.8
        'timezone_string'                 => $timezone_string,
 
        // 3.0
        'page_for_posts'                  => 0,
        'page_on_front'                   => 0,
 
        // 3.1
        'default_post_format'             => 0,
 
        // 3.5
        'link_manager_enabled'            => 0,
 
        // 4.3.0
        'finished_splitting_shared_terms' => 1,
        'site_icon'                       => 0,
 
        // 4.4.0
        'medium_large_size_w'             => 768,
        'medium_large_size_h'             => 0,
 
        // 4.9.6
        'wp_page_for_privacy_policy'      => 0,
 
        // 4.9.8
        'show_comments_cookies_opt_in'    => 1,
    );
 
    // 3.3
    if ( ! is_multisite() ) {
        $defaults['initial_db_version'] = ! empty( $wp_current_db_version ) && $wp_current_db_version < $wp_db_version
            ? $wp_current_db_version : $wp_db_version;
    }
 
    // 3.0 multisite
    if ( is_multisite() ) {
        /* translators: site tagline */
        $defaults['blogdescription']     = sprintf( __( 'Just another %s site' ), get_network()->site_name );
        $defaults['permalink_structure'] = '/%year%/%monthnum%/%day%/%postname%/';
    }
 
    $options = wp_parse_args( $options, $defaults );
 
    // Set autoload to no for these options
    $fat_options = array( 'moderation_keys', 'recently_edited', 'blacklist_keys', 'uninstall_plugins' );
 
    $keys             = "'" . implode( "', '", array_keys( $options ) ) . "'";
    $existing_options = $wpdb->get_col( "SELECT option_name FROM $wpdb->options WHERE option_name in ( $keys )" ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
 
    $insert = '';
    foreach ( $options as $option => $value ) {
        if ( in_array( $option, $existing_options ) ) {
            continue;
        }
        if ( in_array( $option, $fat_options ) ) {
            $autoload = 'no';
        } else {
            $autoload = 'yes';
        }
 
        if ( is_array( $value ) ) {
            $value = serialize( $value );
        }
        if ( ! empty( $insert ) ) {
            $insert .= ', ';
        }
        $insert .= $wpdb->prepare( '(%s, %s, %s)', $option, $value, $autoload );
    }
 
    if ( ! empty( $insert ) ) {
        $wpdb->query( "INSERT INTO $wpdb->options (option_name, option_value, autoload) VALUES " . $insert ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
    }
 
    // In case it is set, but blank, update "home".
    if ( ! __get_option( 'home' ) ) {
        update_option( 'home', $guessurl );
    }
 
    // Delete unused options.
    $unusedoptions = array(
        'blodotgsping_url',
        'bodyterminator',
        'emailtestonly',
        'phoneemail_separator',
        'smilies_directory',
        'subjectprefix',
        'use_bbcode',
        'use_blodotgsping',
        'use_phoneemail',
        'use_quicktags',
        'use_weblogsping',
        'weblogs_cache_file',
        'use_preview',
        'use_htmltrans',
        'smilies_directory',
        'fileupload_allowedusers',
        'use_phoneemail',
        'default_post_status',
        'default_post_category',
        'archive_mode',
        'time_difference',
        'links_minadminlevel',
        'links_use_adminlevels',
        'links_rating_type',
        'links_rating_char',
        'links_rating_ignore_zero',
        'links_rating_single_image',
        'links_rating_image0',
        'links_rating_image1',
        'links_rating_image2',
        'links_rating_image3',
        'links_rating_image4',
        'links_rating_image5',
        'links_rating_image6',
        'links_rating_image7',
        'links_rating_image8',
        'links_rating_image9',
        'links_recently_updated_time',
        'links_recently_updated_prepend',
        'links_recently_updated_append',
        'weblogs_cacheminutes',
        'comment_allowed_tags',
        'search_engine_friendly_urls',
        'default_geourl_lat',
        'default_geourl_lon',
        'use_default_geourl',
        'weblogs_xml_url',
        'new_users_can_blog',
        '_wpnonce',
        '_wp_http_referer',
        'Update',
        'action',
        'rich_editing',
        'autosave_interval',
        'deactivated_plugins',
        'can_compress_scripts',
        'page_uris',
        'update_core',
        'update_plugins',
        'update_themes',
        'doing_cron',
        'random_seed',
        'rss_excerpt_length',
        'secret',
        'use_linksupdate',
        'default_comment_status_page',
        'wporg_popular_tags',
        'what_to_show',
        'rss_language',
        'language',
        'enable_xmlrpc',
        'enable_app',
        'embed_autourls',
        'default_post_edit_rows',
        'gzipcompression',
        'advanced_edit',
    );
    foreach ( $unusedoptions as $option ) {
        delete_option( $option );
    }
 
    // Delete obsolete magpie stuff.
    $wpdb->query( "DELETE FROM $wpdb->options WHERE option_name REGEXP '^rss_[0-9a-f]{32}(_ts)?$'" );
 
    // Clear expired transients
    delete_expired_transients( true );
}

Top ↑

Changelog Changelog

Changelog
Version Description
5.1.0 The $options parameter has been added.
1.5.0 Introduced.


Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.