<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[20588] trunk/wp-includes/class-wp-theme.php: Make WP_Theme::get_files() a general method for retrieving any file types, at any depth, optionally to include parent files.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg > ul, #logmsg > ol { margin-left: 0; margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/20588">20588</a></dd>
<dt>Author</dt> <dd>nacin</dd>
<dt>Date</dt> <dd>2012-04-25 17:31:39 +0000 (Wed, 25 Apr 2012)</dd>
</dl>
<h3>Log Message</h3>
<pre>Make WP_Theme::get_files() a general method for retrieving any file types, at any depth, optionally to include parent files. see <a href="http://core.trac.wordpress.org/ticket/20546">#20546</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpincludesclasswpthemephp">trunk/wp-includes/class-wp-theme.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwpincludesclasswpthemephp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/class-wp-theme.php (20587 => 20588)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/class-wp-theme.php 2012-04-25 16:58:21 UTC (rev 20587)
+++ trunk/wp-includes/class-wp-theme.php 2012-04-25 17:31:39 UTC (rev 20588)
</span><span class="lines">@@ -401,15 +401,9 @@
</span><span class="cx"> case 'Stylesheet' :
</span><span class="cx"> return $this->get_stylesheet();
</span><span class="cx"> case 'Template Files' :
</span><del>- $files = $this->get_files( 'php' );
- if ( $this->parent() )
- $files = array_merge( $this->parent()->get_files( 'php' ), $files );
- return $files;
</del><ins>+ return $this->get_files( 'php', 1, true );
</ins><span class="cx"> case 'Stylesheet Files' :
</span><del>- $files = $this->get_files( 'css' );
- if ( $this->parent() )
- $files = array_merge( $this->parent()->get_files( 'css' ), $files );
- return $files;
</del><ins>+ return $this->get_files( 'css', 0, false );
</ins><span class="cx"> case 'Template Dir' :
</span><span class="cx"> return $this->get_template_directory();
</span><span class="cx"> case 'Stylesheet Dir' :
</span><span class="lines">@@ -506,7 +500,7 @@
</span><span class="cx"> * @since 3.4.0
</span><span class="cx"> */
</span><span class="cx"> public function cache_delete() {
</span><del>- foreach ( array( 'theme', 'screenshot', 'screenshot_count', 'files', 'headers', 'page_templates' ) as $key )
</del><ins>+ foreach ( array( 'theme', 'screenshot', 'screenshot_count', 'headers', 'page_templates' ) as $key )
</ins><span class="cx"> wp_cache_delete( $key . '-' . $this->cache_hash, 'themes' );
</span><span class="cx"> $this->template = $this->textdomain_loaded = $this->theme_root_uri = $this->parent = $this->errors = $this->headers_sanitized = $this->name_translated = null;
</span><span class="cx"> $this->headers = array();
</span><span class="lines">@@ -966,30 +960,24 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Return files in the theme's directory. Does not return files found in the parent theme.
</del><ins>+ * Return files in the theme's directory.
</ins><span class="cx"> *
</span><span class="cx"> * @since 3.4.0
</span><span class="cx"> * @access public
</span><span class="cx"> *
</span><del>- * @param string|null $type Optional. Type of files to return, either 'php' or 'css'. Defaults to null, for both.
- * @return array If a specific $type is requested, returns an array of PHP files. If no $type is requested,
- * returns an array, with the keys being the file types, and the values being an array of files for those type.
</del><ins>+ * @param mixed $type Optional. Array of extensions to return. Defaults to all files (null).
+ * @param int $depth Optional. How deep to search for files. Defaults to a flat scan (0 depth). -1 depth is infinite.
+ * @param bool $search_parent Optional. Whether to return parent files. Defaults to false.
+ * @return array Array of files, keyed by the path to the file relative to the theme's directory, with the values
+ * being absolute paths.
</ins><span class="cx"> */
</span><del>- public function get_files( $type ) {
- $files = $this->cache_get( 'files' );
- if ( ! is_array( $files ) ) {
- $files = (array) self::scandir( $this->get_stylesheet_directory(), array( 'php', 'css' ), 1 );
- foreach ( $files as &$group )
- ksort( $group );
- $this->cache_add( 'files', $files );
- }
</del><ins>+ public function get_files( $type = null, $depth = 0, $search_parent = false ) {
+ $files = (array) self::scandir( $this->get_stylesheet_directory(), $type, $depth );
</ins><span class="cx">
</span><del>- if ( null === $type )
- return $files;
- elseif ( isset( $files[ $type ] ) )
- return $files[ $type ];
</del><ins>+ if ( $search_parent && $this->parent() )
+ $files += (array) self::scandir( $this->get_template_directory(), $type, $depth );
</ins><span class="cx">
</span><del>- return array();
</del><ins>+ return $files;
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -1010,9 +998,9 @@
</span><span class="cx"> if ( ! is_array( $page_templates ) ) {
</span><span class="cx"> $page_templates = array();
</span><span class="cx">
</span><del>- $files = (array) self::scandir( $this->get_stylesheet_directory(), 'php', 1 );
</del><ins>+ $files = (array) $this->get_files( 'php', 1 );
</ins><span class="cx">
</span><del>- foreach ( $files['php'] as $file => $full_path ) {
</del><ins>+ foreach ( $files as $file => $full_path ) {
</ins><span class="cx"> $headers = get_file_data( $full_path, array( 'Template Name' => 'Template Name' ) );
</span><span class="cx"> if ( empty( $headers['Template Name'] ) )
</span><span class="cx"> continue;
</span><span class="lines">@@ -1046,20 +1034,22 @@
</span><span class="cx"> * @param string $relative_path The basename of the absolute path. Used to control the returned path
</span><span class="cx"> * for the found files, particularly when this function recurses to lower depths.
</span><span class="cx"> */
</span><del>- private static function scandir( $path, $extensions, $depth = 0, $relative_path = '' ) {
</del><ins>+ private static function scandir( $path, $extensions = null, $depth = 0, $relative_path = '' ) {
</ins><span class="cx"> if ( ! is_dir( $path ) )
</span><span class="cx"> return false;
</span><span class="cx">
</span><del>- $results = scandir( $path );
</del><ins>+ if ( $extensions ) {
+ $extensions = (array) $extensions;
+ $_extensions = implode( '|', $extensions );
+ }
</ins><span class="cx">
</span><del>- $extensions = (array) $extensions;
- $files = array_fill_keys( $extensions, array() );
- $_extensions = implode( '|', $extensions );
-
</del><span class="cx"> $relative_path = trailingslashit( $relative_path );
</span><span class="cx"> if ( '/' == $relative_path )
</span><span class="cx"> $relative_path = '';
</span><span class="cx">
</span><ins>+ $results = scandir( $path );
+ $files = array();
+
</ins><span class="cx"> foreach ( $results as $result ) {
</span><span class="cx"> if ( '.' == $result[0] )
</span><span class="cx"> continue;
</span><span class="lines">@@ -1068,8 +1058,8 @@
</span><span class="cx"> continue;
</span><span class="cx"> $found = self::scandir( $path . '/' . $result, $extensions, $depth - 1 , $relative_path . $result );
</span><span class="cx"> $files = array_merge_recursive( $files, $found );
</span><del>- } elseif ( preg_match( '~\.(' . $_extensions . ')$~', $result, $match ) ) {
- $files[ $match[1] ][ $relative_path . $result ] = $path . '/' . $result;
</del><ins>+ } elseif ( ! $extensions || preg_match( '~\.(' . $_extensions . ')$~', $result ) ) {
+ $files[ $relative_path . $result ] = $path . '/' . $result;
</ins><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>