Changeset 20193

Timestamp:

03/15/2012 03:39:21 PM (11 years ago)

Author:

nacin

Message:

Updates to WP_Theme, wp_get_themes(), and related deprecated functions, after ​[UT570] ​[UT578] ​[UT579]. see #20103.

• Template Files? and Stylesheet Files? need to return files from the parent theme as well.
• Don't strip links from the Author header. Some themes rely on the previous behavior, such as to link multiple authors (Sandbox, for example.) Don't restore links to the Name, that's just a bad idea.
• Ensure we are always passing around arrays in get_files/scandir.
• Better inline doc for wp_get_themes() arguments.
• Introduce a 'force' flag for search_theme_directories() to re-scan, rather than return the cache. We will use this to re-build the theme_roots transient in get_theme_roots(), but it is more helpful for unit tests. Since search_theme_directories() is cached, don't cache again in wp_get_themes(). (Again benefits testing.)
• Handle duplicate theme names in the old get_themes() when two themes match (and neither are a default theme, which is already handled). wp_get_themes() will consider both names to be the same; this is just for back compat since get_themes() is keyed by name.
• Include an old array key in wp_broken_themes().

Location:

trunk

Files:

• wp-admin/includes/deprecated.php (modified) (1 diff)
• wp-includes/class-wp-theme.php (modified) (6 diffs)
• wp-includes/deprecated.php (modified) (1 diff)
• wp-includes/theme.php (modified) (5 diffs)

trunk/wp-admin/includes/deprecated.php

@@ -918 +918 @@
     $broken = array();
     foreach ( $themes as $theme ) {
-        $broken[ $theme->get('Name') ] = array(
-            'Title' => $theme->get('Name'),
+        $name = $theme->get('Name');
+        $broken[ $name ] = array(
+            'Name' => $name,
+            'Title' => $name,
             'Description' => $theme->errors()->get_error_message(),
         );

trunk/wp-includes/class-wp-theme.php

@@ -385 +385 @@
                 return $this->get_stylesheet();
             case 'Template Files' :
-                $files = $this->get_files('php');
+                $files = $this->get_files('php', true);
                 foreach ( $files as &$file )
                     $file = $this->theme_root . '/' . $file;
                 return $files;
             case 'Stylesheet Files' :
-                $files = $this->get_files('css');
+                $files = $this->get_files('css', true);
                 foreach ( $files as &$file )
                     $file = $this->theme_root . '/' . $file;
@@ -556 +556 @@
                 // Fall through otherwise.
             case 'Name' :
-            case 'Author' :
                 static $header_tags = array(
                     'abbr'    => array( 'title' => true ),
@@ -566 +565 @@
                 $value = wp_kses( $value, $header_tags );
                 break;
+            case 'Author' :
+                // There shouldn't be anchor tags in Author, but some themes like to be challenging.
             case 'Description' :
                 static $header_tags_with_a = array(
@@ -936 +937 @@
                 // Template files can be one level down for the purposes of the theme editor, so this should be $depth = 1.
                 // Todo: We ignore this for now, but this is why the branching is weird.
-                $files = (array) self::scandir( $this->get_template_directory(), $this->get_template(), array( 'php', 'css' ) );
+                $files = self::scandir( $this->get_template_directory(), $this->get_template(), array( 'php', 'css' ) );
+            else
+                $files = array();
             if ( $this->is_child_theme() )
                 $files = array_merge_recursive( $files, (array) self::scandir( $this->get_stylesheet_directory(), $this->get_stylesheet(), array( 'php', 'css' ) ) );
@@ -990 +993 @@
      */
     private static function scandir( $path, $relative_path, $extensions, $depth = 0 ) {
-        if ( is_array( $extensions ) )
-            $extensions = implode( '|', $extensions );
-
         if ( ! is_dir( $path ) )
             return false;
 
         $results = scandir( $path );
-        $files = array();
+
+        $extensions = (array) $extensions;
+        $files = array_fill_keys( $extensions, array() );
+        $extensions = implode( '|', $extensions );
 
         foreach ( $results as $result ) {
@@ -1008 +1011 @@
                 $files = array_merge_recursive( $files, $found );
             } elseif ( preg_match( '~\.(' . $extensions . ')$~', $result, $match ) ) {
-                if ( ! isset( $files[ $match[1] ] ) )
-                    $files[ $match[1] ] = array( $relative_path . '/'. $result );
-                else
-                    $files[ $match[1] ][] = $relative_path . '/' . $result;
+                $files[ $match[1] ][] = $relative_path . '/' . $result;
             }
         }

trunk/wp-includes/deprecated.php

@@ -2934 +2934 @@
 
     foreach ( $themes as $theme ) {
-        $wp_themes[ $theme->get('Name') ] = $theme;
+        $name = $theme->get('Name');
+        if ( isset( $wp_themes[ $name ] ) )
+            $wp_themes[ $name . '/' . $theme->get_stylesheet() ] = $theme;
+        else
+            $wp_themes[ $name ] = $theme;
     }
 

trunk/wp-includes/theme.php

@@ -10 +10 @@
  * Returns an array of WP_Theme objects based on the arguments.
  *
- * Despite advances over get_themes(), this function is still quite expensive, and grows
+ * Despite advances over get_themes(), this function is quite expensive, and grows
  * linearly with additional themes. Stick to wp_get_theme() if possible.
  *
  * @since 3.4.0
  *
- * @param array $args Arguments. Currently 'errors' (defaults to false), 'allowed'
- *  (true, false; null for either; defaults to null; only applies to multisite), and 'blog_id'
- *  (defaults to current blog; used to find allowed themes; only applies to multisite).
+ * @param array $args The search arguments. Optional.
+ * - errors      mixed  True to return themes with errors, false to return themes without errors, null
+ *                      to return all themes. Defaults to false.
+ * - allowed     mixed  (Multisite) True to return only allowed themes for a site. False to return only
+ *                      disallowed themes for a site. 'site' to return only site-allowed themes. 'network'
+ *                      to return only network-allowed themes. Null to return all themes. Defaults to null.
+ * - blog_id     int    (Multisite) The blog ID used to calculate which themes are allowed. Defaults to 0,
+ *                      synonymous for the current blog.
  * @return Array of WP_Theme objects.
  */
@@ -26 +31 @@
     $args = wp_parse_args( $args, $defaults );
 
-    static $_theme_directories, $_themes = array();
-    if ( ! isset( $_theme_directories ) ) {
-        $_theme_directories = search_theme_directories();
-        if ( count( $wp_theme_directories ) > 1 ) {
-            // Make sure the current theme wins out, in case search_theme_directories() picks the wrong
-            // one in the case of a conflict. (Normally, last registered theme root wins.)
-            $current_theme = get_stylesheet();
+    $theme_directories = search_theme_directories();
+
+    if ( count( $wp_theme_directories ) > 1 ) {
+        // Make sure the current theme wins out, in case search_theme_directories() picks the wrong
+        // one in the case of a conflict. (Normally, last registered theme root wins.)
+        $current_theme = get_stylesheet();
+        if ( isset( $theme_directories[ $current_theme ] ) ) {
             $root_of_current_theme = get_raw_theme_root( $current_theme );
             if ( ! in_array( $root_of_current_theme, $wp_theme_directories ) )
                 $root_of_current_theme = WP_CONTENT_DIR . $root_of_current_theme;
-            $_theme_directories[ $current_theme ]['theme_root'] = $root_of_current_theme;
+            $theme_directories[ $current_theme ]['theme_root'] = $root_of_current_theme;
         }
     }
 
-    if ( empty( $_theme_directories ) )
+    if ( empty( $theme_directories ) )
         return array();
-
-    $theme_directories = $_theme_directories;
 
     if ( is_multisite() && null !== $args['allowed'] ) {
@@ -356 +359 @@
     $theme_roots = get_site_transient( 'theme_roots' );
     if ( false === $theme_roots ) {
-        search_theme_directories(); // Regenerate the transient.
+        search_theme_directories( true ); // Regenerate the transient.
         $theme_roots = get_site_transient( 'theme_roots' );
     }
@@ -391 +394 @@
  * @since 2.9.0
  *
+ * @param bool $force Optional. Whether to force a new directory scan. Defaults to false.
  * @return array Valid themes found
  */
-function search_theme_directories() {
+function search_theme_directories( $force = false ) {
     global $wp_theme_directories;
     if ( empty( $wp_theme_directories ) )
@@ -399 +403 @@
 
     static $found_themes;
-    if ( isset( $found_themes ) )
+    if ( ! $force && isset( $found_themes ) )
         return $found_themes;