WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

get_home_path()

get_home_path(): string

In this article

Back to top

Gets the absolute filesystem path to the root of the WordPress installation.

Return

string Full filesystem path to the root of the WordPress installation.

Source

function get_home_path() {
	$home    = set_url_scheme( get_option( 'home' ), 'http' );
	$siteurl = set_url_scheme( get_option( 'siteurl' ), 'http' );

	if ( ! empty( $home ) && 0 !== strcasecmp( $home, $siteurl ) ) {
		$wp_path_rel_to_home = str_ireplace( $home, '', $siteurl ); /* $siteurl - $home */
		$pos                 = strripos( str_replace( '\\', '/', $_SERVER['SCRIPT_FILENAME'] ), trailingslashit( $wp_path_rel_to_home ) );
		$home_path           = substr( $_SERVER['SCRIPT_FILENAME'], 0, $pos );
		$home_path           = trailingslashit( $home_path );
	} else {
		$home_path = ABSPATH;
	}

	return str_replace( '\\', '/', $home_path );
}

View all references View on Trac View on GitHub

UsesDescription
set_url_scheme()wp-includes/link-template.php

Sets the scheme for a URL.

trailingslashit()wp-includes/formatting.php

Appends a trailing slash.

get_option()wp-includes/option.php

Retrieves an option value based on an option name.

Show 1 moreShow less
Used byDescription
network_step2()wp-admin/includes/network.php

Prints step 2 for Network installation process.

save_mod_rewrite_rules()wp-admin/includes/misc.php

Updates the htaccess file with the current rules if it is writable.

iis7_save_url_rewrite_rules()wp-admin/includes/misc.php

Updates the IIS web.config file with the current rules if it is writable.

make_site_theme_from_oldschool()wp-admin/includes/upgrade.php

Creates a site theme from an existing theme.

Changelog

VersionDescription
1.5.0Introduced.

User Contributed Notes

  1. Skip to note 4 content
    Codex
    You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

    Default Usage

    // Return "Path: /var/www/htdocs/" or "Path: /var/www/htdocs/wordpress/" if it is subfolder.
printf( 'Path: %s', get_home_path() );
  3. Skip to note 6 content
    Rolf Allard van Hagen
    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

    Note that get_home_path() is declared in wp-admin/includes/file.php which is not included by default, except on admin pages when wp-admin/includes/admin.php has been included.

    // Ensure get_home_path() is declared.
require_once ABSPATH . 'wp-admin/includes/file.php';

$home_path = get_home_path();

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