WordPress at a glance

wp_install_defaults() WP 2.1.0

Creates the initial content for a newly-installed site: categories, posts, pages etc.

Adds:

  • "Uncategorized" category;
  • the first post (with a comment);
  • the first page;
  • Privacy Policy page;
  • Default widgets for the default theme.

The main point of this function is that you can redefine it in your plugin. Thus, you can specify what default content to add to the newly-installed website.

  • Global. wpdb. $wpdb
  • Global. WP_Rewrite. $wp_rewrite
  • Global. String. $table_prefix

No Hooks.

Return

Null. Nothing.

Usage

wp_install_defaults( $user_id );
$user_id(int) (required)
User ID.

Examples

#1 Default options for the website

This example shows how to add default options for a newly-installed website. For that you need to create a plugin with the following content:

<?php

/*
 * Plugin Name: Custom Installation Script
 * Description: A plugin that automatically setups newly-created websites
 */

function wp_install_defaults( $user_id ){

	// Permalink structure
	update_option( 'permalink_structure', '/%postname%/' );

	// Don't show the welcome panel
	update_user_meta( $user_id, 'show_welcome_panel', 0 );

	// Theme Activation
	update_option( 'template', 'hb-base-theme' );
	update_option( 'stylesheet', 'hb-event' );
	update_option( 'current_theme', 'hb-event' );
}

Notes

  • Global. wpdb. $wpdb
  • Global. WP_Rewrite. $wp_rewrite
  • Global. String. $table_prefix

Changelog

Since 2.1.0 Introduced.

Code of wp install defaults: wp-admin/includes/upgrade.php WP 5.2.2

<?php
function wp_install_defaults( $user_id ) {
	global $wpdb, $wp_rewrite, $table_prefix;

	// Default category
	$cat_name = __( 'Uncategorized' );
	/* translators: Default category slug */
	$cat_slug = sanitize_title( _x( 'Uncategorized', 'Default category slug' ) );

	if ( global_terms_enabled() ) {
		$cat_id = $wpdb->get_var( $wpdb->prepare( "SELECT cat_ID FROM {$wpdb->sitecategories} WHERE category_nicename = %s", $cat_slug ) );
		if ( $cat_id == null ) {
			$wpdb->insert(
				$wpdb->sitecategories,
				array(
					'cat_ID'            => 0,
					'cat_name'          => $cat_name,
					'category_nicename' => $cat_slug,
					'last_updated'      => current_time( 'mysql', true ),
				)
			);
			$cat_id = $wpdb->insert_id;
		}
		update_option( 'default_category', $cat_id );
	} else {
		$cat_id = 1;
	}

	$wpdb->insert(
		$wpdb->terms,
		array(
			'term_id'    => $cat_id,
			'name'       => $cat_name,
			'slug'       => $cat_slug,
			'term_group' => 0,
		)
	);
	$wpdb->insert(
		$wpdb->term_taxonomy,
		array(
			'term_id'     => $cat_id,
			'taxonomy'    => 'category',
			'description' => '',
			'parent'      => 0,
			'count'       => 1,
		)
	);
	$cat_tt_id = $wpdb->insert_id;

	// First post
	$now             = current_time( 'mysql' );
	$now_gmt         = current_time( 'mysql', 1 );
	$first_post_guid = get_option( 'home' ) . '/?p=1';

	if ( is_multisite() ) {
		$first_post = get_site_option( 'first_post' );

		if ( ! $first_post ) {
			$first_post = "<!-- wp:paragraph -->\n<p>" .
			/* translators: first post content, %s: site link */
			__( 'Welcome to %s. This is your first post. Edit or delete it, then start writing!' ) .
			"</p>\n<!-- /wp:paragraph -->";
		}

		$first_post = sprintf(
			$first_post,
			sprintf( '<a href="%s">%s</a>', esc_url( network_home_url() ), get_network()->site_name )
		);

		// Back-compat for pre-4.4
		$first_post = str_replace( 'SITE_URL', esc_url( network_home_url() ), $first_post );
		$first_post = str_replace( 'SITE_NAME', get_network()->site_name, $first_post );
	} else {
		$first_post = "<!-- wp:paragraph -->\n<p>" .
		/* translators: first post content, %s: site link */
		__( 'Welcome to WordPress. This is your first post. Edit or delete it, then start writing!' ) .
		"</p>\n<!-- /wp:paragraph -->";
	}

	$wpdb->insert(
		$wpdb->posts,
		array(
			'post_author'           => $user_id,
			'post_date'             => $now,
			'post_date_gmt'         => $now_gmt,
			'post_content'          => $first_post,
			'post_excerpt'          => '',
			'post_title'            => __( 'Hello world!' ),
			/* translators: Default post slug */
			'post_name'             => sanitize_title( _x( 'hello-world', 'Default post slug' ) ),
			'post_modified'         => $now,
			'post_modified_gmt'     => $now_gmt,
			'guid'                  => $first_post_guid,
			'comment_count'         => 1,
			'to_ping'               => '',
			'pinged'                => '',
			'post_content_filtered' => '',
		)
	);
	$wpdb->insert(
		$wpdb->term_relationships,
		array(
			'term_taxonomy_id' => $cat_tt_id,
			'object_id'        => 1,
		)
	);

	// Default comment
	if ( is_multisite() ) {
		$first_comment_author = get_site_option( 'first_comment_author' );
		$first_comment_email  = get_site_option( 'first_comment_email' );
		$first_comment_url    = get_site_option( 'first_comment_url', network_home_url() );
		$first_comment        = get_site_option( 'first_comment' );
	}

	$first_comment_author = ! empty( $first_comment_author ) ? $first_comment_author : __( 'A WordPress Commenter' );
	$first_comment_email  = ! empty( $first_comment_email ) ? $first_comment_email : 'wapuu@wordpress.example';
	$first_comment_url    = ! empty( $first_comment_url ) ? $first_comment_url : 'https://wordpress.org/';
	$first_comment        = ! empty( $first_comment ) ? $first_comment : __(
		'Hi, this is a comment.
To get started with moderating, editing, and deleting comments, please visit the Comments screen in the dashboard.
Commenter avatars come from <a href="https://gravatar.com">Gravatar</a>.'
	);
	$wpdb->insert(
		$wpdb->comments,
		array(
			'comment_post_ID'      => 1,
			'comment_author'       => $first_comment_author,
			'comment_author_email' => $first_comment_email,
			'comment_author_url'   => $first_comment_url,
			'comment_date'         => $now,
			'comment_date_gmt'     => $now_gmt,
			'comment_content'      => $first_comment,
		)
	);

	// First Page
	if ( is_multisite() ) {
		$first_page = get_site_option( 'first_page' );
	}

	if ( empty( $first_page ) ) {
		$first_page = "<!-- wp:paragraph -->\n<p>";
		/* translators: first page content */
		$first_page .= __( "This is an example page. It's different from a blog post because it will stay in one place and will show up in your site navigation (in most themes). Most people start with an About page that introduces them to potential site visitors. It might say something like this:" );
		$first_page .= "</p>\n<!-- /wp:paragraph -->\n\n";

		$first_page .= "<!-- wp:quote -->\n<blockquote class=\"wp-block-quote\"><p>";
		/* translators: first page content */
		$first_page .= __( "Hi there! I'm a bike messenger by day, aspiring actor by night, and this is my website. I live in Los Angeles, have a great dog named Jack, and I like pi&#241;a coladas. (And gettin' caught in the rain.)" );
		$first_page .= "</p></blockquote>\n<!-- /wp:quote -->\n\n";

		$first_page .= "<!-- wp:paragraph -->\n<p>";
		/* translators: first page content */
		$first_page .= __( '...or something like this:' );
		$first_page .= "</p>\n<!-- /wp:paragraph -->\n\n";

		$first_page .= "<!-- wp:quote -->\n<blockquote class=\"wp-block-quote\"><p>";
		/* translators: first page content */
		$first_page .= __( 'The XYZ Doohickey Company was founded in 1971, and has been providing quality doohickeys to the public ever since. Located in Gotham City, XYZ employs over 2,000 people and does all kinds of awesome things for the Gotham community.' );
		$first_page .= "</p></blockquote>\n<!-- /wp:quote -->\n\n";

		$first_page .= "<!-- wp:paragraph -->\n<p>";
		$first_page .= sprintf(
			/* translators: first page content, %s: site admin URL */
			__( 'As a new WordPress user, you should go to <a href="%s">your dashboard</a> to delete this page and create new pages for your content. Have fun!' ),
			admin_url()
		);
		$first_page .= "</p>\n<!-- /wp:paragraph -->";
	}

	$first_post_guid = get_option( 'home' ) . '/?page_id=2';
	$wpdb->insert(
		$wpdb->posts,
		array(
			'post_author'           => $user_id,
			'post_date'             => $now,
			'post_date_gmt'         => $now_gmt,
			'post_content'          => $first_page,
			'post_excerpt'          => '',
			'comment_status'        => 'closed',
			'post_title'            => __( 'Sample Page' ),
			/* translators: Default page slug */
			'post_name'             => __( 'sample-page' ),
			'post_modified'         => $now,
			'post_modified_gmt'     => $now_gmt,
			'guid'                  => $first_post_guid,
			'post_type'             => 'page',
			'to_ping'               => '',
			'pinged'                => '',
			'post_content_filtered' => '',
		)
	);
	$wpdb->insert(
		$wpdb->postmeta,
		array(
			'post_id'    => 2,
			'meta_key'   => '_wp_page_template',
			'meta_value' => 'default',
		)
	);

	// Privacy Policy page
	if ( is_multisite() ) {
		// Disable by default unless the suggested content is provided.
		$privacy_policy_content = get_site_option( 'default_privacy_policy_content' );
	} else {
		if ( ! class_exists( 'WP_Privacy_Policy_Content' ) ) {
			include_once( ABSPATH . 'wp-admin/includes/misc.php' );
		}

		$privacy_policy_content = WP_Privacy_Policy_Content::get_default_content();
	}

	if ( ! empty( $privacy_policy_content ) ) {
		$privacy_policy_guid = get_option( 'home' ) . '/?page_id=3';

		$wpdb->insert(
			$wpdb->posts,
			array(
				'post_author'           => $user_id,
				'post_date'             => $now,
				'post_date_gmt'         => $now_gmt,
				'post_content'          => $privacy_policy_content,
				'post_excerpt'          => '',
				'comment_status'        => 'closed',
				'post_title'            => __( 'Privacy Policy' ),
				/* translators: Privacy Policy page slug */
				'post_name'             => __( 'privacy-policy' ),
				'post_modified'         => $now,
				'post_modified_gmt'     => $now_gmt,
				'guid'                  => $privacy_policy_guid,
				'post_type'             => 'page',
				'post_status'           => 'draft',
				'to_ping'               => '',
				'pinged'                => '',
				'post_content_filtered' => '',
			)
		);
		$wpdb->insert(
			$wpdb->postmeta,
			array(
				'post_id'    => 3,
				'meta_key'   => '_wp_page_template',
				'meta_value' => 'default',
			)
		);
		update_option( 'wp_page_for_privacy_policy', 3 );
	}

	// Set up default widgets for default theme.
	update_option(
		'widget_search',
		array(
			2              => array( 'title' => '' ),
			'_multiwidget' => 1,
		)
	);
	update_option(
		'widget_recent-posts',
		array(
			2              => array(
				'title'  => '',
				'number' => 5,
			),
			'_multiwidget' => 1,
		)
	);
	update_option(
		'widget_recent-comments',
		array(
			2              => array(
				'title'  => '',
				'number' => 5,
			),
			'_multiwidget' => 1,
		)
	);
	update_option(
		'widget_archives',
		array(
			2              => array(
				'title'    => '',
				'count'    => 0,
				'dropdown' => 0,
			),
			'_multiwidget' => 1,
		)
	);
	update_option(
		'widget_categories',
		array(
			2              => array(
				'title'        => '',
				'count'        => 0,
				'hierarchical' => 0,
				'dropdown'     => 0,
			),
			'_multiwidget' => 1,
		)
	);
	update_option(
		'widget_meta',
		array(
			2              => array( 'title' => '' ),
			'_multiwidget' => 1,
		)
	);
	update_option(
		'sidebars_widgets',
		array(
			'wp_inactive_widgets' => array(),
			'sidebar-1'           => array(
				0 => 'search-2',
				1 => 'recent-posts-2',
				2 => 'recent-comments-2',
				3 => 'archives-2',
				4 => 'categories-2',
				5 => 'meta-2',
			),
			'array_version'       => 3,
		)
	);
	if ( ! is_multisite() ) {
		update_user_meta( $user_id, 'show_welcome_panel', 1 );
	} elseif ( ! is_super_admin( $user_id ) && ! metadata_exists( 'user', $user_id, 'show_welcome_panel' ) ) {
		update_user_meta( $user_id, 'show_welcome_panel', 2 );
	}

	if ( is_multisite() ) {
		// Flush rules to pick up the new page.
		$wp_rewrite->init();
		$wp_rewrite->flush_rules();

		$user = new WP_User( $user_id );
		$wpdb->update( $wpdb->options, array( 'option_value' => $user->user_email ), array( 'option_name' => 'admin_email' ) );

		// Remove all perms except for the login user.
		$wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->usermeta WHERE user_id != %d AND meta_key = %s", $user_id, $table_prefix . 'user_level' ) );
		$wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->usermeta WHERE user_id != %d AND meta_key = %s", $user_id, $table_prefix . 'capabilities' ) );

		// Delete any caps that snuck into the previously active blog. (Hardcoded to blog 1 for now.) TODO: Get previous_blog_id.
		if ( ! is_super_admin( $user_id ) && $user_id != 1 ) {
			$wpdb->delete(
				$wpdb->usermeta,
				array(
					'user_id'  => $user_id,
					'meta_key' => $wpdb->base_prefix . '1_capabilities',
				)
			);
		}
	}
}

Related Functions

From tag: WP extension (enhancement)

More from category: Uncategorized

No comments
    Hello, !     Log In . Register