register_theme_directory() – Function

Registers a directory that contains themes.

Parameters

$directorystringrequired: Either the full filesystem path to a theme folder or a folder within WP_CONTENT_DIR.

Return

bool True if successfully registered a directory that contains themes, false if the directory does not exist.

Source

function register_theme_directory( $directory ) {
	global $wp_theme_directories;

	if ( ! file_exists( $directory ) ) {
		// Try prepending as the theme directory could be relative to the content directory.
		$directory = WP_CONTENT_DIR . '/' . $directory;
		// If this directory does not exist, return and do not register.
		if ( ! file_exists( $directory ) ) {
			return false;
		}
	}

	if ( ! is_array( $wp_theme_directories ) ) {
		$wp_theme_directories = array();
	}

	$untrailed = untrailingslashit( $directory );
	if ( ! empty( $untrailed ) && ! in_array( $untrailed, $wp_theme_directories, true ) ) {
		$wp_theme_directories[] = $untrailed;
	}

	return true;
}

View all references View on Trac View on GitHub

Uses	Description
untrailingslashit()`wp-includes/formatting.php`	Removes trailing forward slashes and backslashes if they exist.

Changelog

Version	Description
2.9.0	Introduced.

User Contributed Notes

Skip to note 2 content

Codex 9 years ago

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
Example

Register a plugin’s subdirectory as a theme folder
```
<?php

/*
 * For directory structure like:
 * 
 * /my-plugin/
 * - /my-plugin.php
 * - /themes/
 *
 * You would put this in my-plugin.php.
 */
register_theme_directory( dirname( __FILE__ ) . '/themes' );
```
Log in to add feedback

register_theme_directory( string $directory ): bool

In this article

Parameters

Return

Source

Changelog

User Contributed Notes

register_theme_directory( string $directory ): bool

In this article

Parameters

Return

Source

Related

Changelog

User Contributed Notes