WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

wp_ajax_install_theme()

wp_ajax_install_theme()

In this article

Back to top

Handles installing a theme via AJAX.

Description

See also

Source

function wp_ajax_install_theme() {
	check_ajax_referer( 'updates' );

	if ( empty( $_POST['slug'] ) ) {
		wp_send_json_error(
			array(
				'slug'         => '',
				'errorCode'    => 'no_theme_specified',
				'errorMessage' => __( 'No theme specified.' ),
			)
		);
	}

	$slug = sanitize_key( wp_unslash( $_POST['slug'] ) );

	$status = array(
		'install' => 'theme',
		'slug'    => $slug,
	);

	if ( ! current_user_can( 'install_themes' ) ) {
		$status['errorMessage'] = __( 'Sorry, you are not allowed to install themes on this site.' );
		wp_send_json_error( $status );
	}

	require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
	require_once ABSPATH . 'wp-admin/includes/theme.php';

	$api = themes_api(
		'theme_information',
		array(
			'slug'   => $slug,
			'fields' => array( 'sections' => false ),
		)
	);

	if ( is_wp_error( $api ) ) {
		$status['errorMessage'] = $api->get_error_message();
		wp_send_json_error( $status );
	}

	$skin     = new WP_Ajax_Upgrader_Skin();
	$upgrader = new Theme_Upgrader( $skin );
	$result   = $upgrader->install( $api->download_link );

	if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
		$status['debug'] = $skin->get_upgrade_messages();
	}

	if ( is_wp_error( $result ) ) {
		$status['errorCode']    = $result->get_error_code();
		$status['errorMessage'] = $result->get_error_message();
		wp_send_json_error( $status );
	} elseif ( is_wp_error( $skin->result ) ) {
		$status['errorCode']    = $skin->result->get_error_code();
		$status['errorMessage'] = $skin->result->get_error_message();
		wp_send_json_error( $status );
	} elseif ( $skin->get_errors()->has_errors() ) {
		$status['errorMessage'] = $skin->get_error_messages();
		wp_send_json_error( $status );
	} elseif ( is_null( $result ) ) {
		global $wp_filesystem;

		$status['errorCode']    = 'unable_to_connect_to_filesystem';
		$status['errorMessage'] = __( 'Unable to connect to the filesystem. Please confirm your credentials.' );

		// Pass through the error from WP_Filesystem if one was raised.
		if ( $wp_filesystem instanceof WP_Filesystem_Base && is_wp_error( $wp_filesystem->errors ) && $wp_filesystem->errors->has_errors() ) {
			$status['errorMessage'] = esc_html( $wp_filesystem->errors->get_error_message() );
		}

		wp_send_json_error( $status );
	}

	$status['themeName'] = wp_get_theme( $slug )->get( 'Name' );

	if ( current_user_can( 'switch_themes' ) ) {
		if ( is_multisite() ) {
			$status['activateUrl'] = add_query_arg(
				array(
					'action'   => 'enable',
					'_wpnonce' => wp_create_nonce( 'enable-theme_' . $slug ),
					'theme'    => $slug,
				),
				network_admin_url( 'themes.php' )
			);
		} else {
			$status['activateUrl'] = add_query_arg(
				array(
					'action'     => 'activate',
					'_wpnonce'   => wp_create_nonce( 'switch-theme_' . $slug ),
					'stylesheet' => $slug,
				),
				admin_url( 'themes.php' )
			);
		}
	}

	$theme                = wp_get_theme( $slug );
	$status['blockTheme'] = $theme->is_block_theme();

	if ( ! is_multisite() && current_user_can( 'edit_theme_options' ) && current_user_can( 'customize' ) ) {
		$status['customizeUrl'] = add_query_arg(
			array(
				'return' => urlencode( network_admin_url( 'theme-install.php', 'relative' ) ),
			),
			wp_customize_url( $slug )
		);
	}

	/*
	 * See WP_Theme_Install_List_Table::_get_theme_status() if we wanted to check
	 * on post-installation status.
	 */
	wp_send_json_success( $status );
}

View all references View on Trac View on GitHub

UsesDescription
WP_Ajax_Upgrader_Skin::__construct()wp-admin/includes/class-wp-ajax-upgrader-skin.php

Constructor.

wp_customize_url()wp-includes/theme.php

Returns a URL to load the Customizer.

wp_get_theme()wp-includes/theme.php

Gets a WP_Theme object for a theme.

network_admin_url()wp-includes/link-template.php

Retrieves the URL to the admin area for the network.

themes_api()wp-admin/includes/theme.php

Retrieves theme installer pages from the WordPress.org Themes API.

is_multisite()wp-includes/load.php

Determines whether Multisite is enabled.

admin_url()wp-includes/link-template.php

Retrieves the URL to the admin area for the current site.

add_query_arg()wp-includes/functions.php

Retrieves a modified URL query string.

wp_send_json_success()wp-includes/functions.php

Sends a JSON response back to an Ajax request, indicating success.

wp_send_json_error()wp-includes/functions.php

Sends a JSON response back to an Ajax request, indicating failure.

wp_create_nonce()wp-includes/pluggable.php

Creates a cryptographic token tied to a specific action, user, user session, and window of time.

check_ajax_referer()wp-includes/pluggable.php

Verifies the Ajax request to prevent processing requests external of the blog.

sanitize_key()wp-includes/formatting.php

Sanitizes a string key.

esc_html()wp-includes/formatting.php

Escaping for HTML blocks.

wp_unslash()wp-includes/formatting.php

Removes slashes from a string or recursively removes slashes from strings within an array.

__()wp-includes/l10n.php

Retrieves the translation of $text.

current_user_can()wp-includes/capabilities.php

Returns whether the current user has the specified capability.

is_wp_error()wp-includes/load.php

Checks whether the given variable is a WordPress Error.

Show 13 moreShow less

Changelog

VersionDescription
4.6.0Introduced.

User Contributed Notes

  1. Skip to note 2 content
    Jahid Hasan
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    /**
 * Register and enqueue a custom script in the WordPress admin.
 */
function wpdocs_enqueue_admin_script() {
    wp_enqueue_script( 'wpdocs_custom_script', plugin_dir_url( __FILE__ ) . 'myscript.js', array(), '1.0.0' );
    wp_localize_script( 'wpdocs_custom_script', 'script_params',
    array(
        'nonce' => wp_create_nonce( 'updates' ), //nonce updates are not gonna changeable
        'ajax_url' => admin_url( 'admin-ajax.php' )
    )
);
}
add_action( 'admin_enqueue_scripts', 'wpdocs_enqueue_admin_script' );

// Callback wp_ajax_install_theme not gonna changeable.
add_action( 'wp_ajax_wp_ajax_install_theme', 'wp_ajax_install_theme' );

    Add this code to your myscript.js file.
    And Add the name of your selector, from where you want to install the theme by clicking. I’ve added .theme-install-button as an example.

    jQuery( document ).on('click', '.theme-install-button', function ( e ) {
    e.preventDefault();

    var data = {
        action: "wp_ajax_install_theme", // ajax action
        _ajax_nonce: script_params.nonce, // nonce
        slug: "blogfi", // theme slug
    };
    
    jQuery.post( script_params.ajax_url, data, function ( response ) {
        console.log( response );
    } );
} );

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