WordPress 4.2
[autoinstalls/wordpress.git] / wp-includes / theme.php
index e1091259012f4b09631b63ec77ce5205ed61a329..1b372da37ab28aecb2942cfd8b3a0f9767afe14d 100644 (file)
@@ -137,7 +137,7 @@ function is_child_theme() {
  * The theme name that the administrator has currently set the front end theme
  * as.
  *
- * For all extensive purposes, the template name and the stylesheet name are
+ * For all intents and purposes, the template name and the stylesheet name are
  * going to be the same for most cases.
  *
  * @since 1.5.0
@@ -187,7 +187,7 @@ function get_stylesheet_directory() {
  * @return string
  */
 function get_stylesheet_directory_uri() {
-       $stylesheet = get_stylesheet();
+       $stylesheet = str_replace( '%2F', '/', rawurlencode( get_stylesheet() ) );
        $theme_root_uri = get_theme_root_uri( $stylesheet );
        $stylesheet_dir_uri = "$theme_root_uri/$stylesheet";
 
@@ -271,7 +271,6 @@ function get_locale_stylesheet_uri() {
  * Retrieve name of the current theme.
  *
  * @since 1.5.0
- * @uses apply_filters() Calls 'template' filter on template option.
  *
  * @return string Template name.
  */
@@ -318,7 +317,7 @@ function get_template_directory() {
  * @return string Template directory URI.
  */
 function get_template_directory_uri() {
-       $template = get_template();
+       $template = str_replace( '%2F', '/', rawurlencode( get_template() ) );
        $theme_root_uri = get_theme_root_uri( $template );
        $template_dir_uri = "$theme_root_uri/$template";
 
@@ -370,11 +369,19 @@ function register_theme_directory( $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 ) )
+               if ( ! file_exists( $directory ) ) {
                        return false;
+               }
        }
 
-       $wp_theme_directories[] = $directory;
+       if ( ! is_array( $wp_theme_directories ) ) {
+               $wp_theme_directories = array();
+       }
+
+       $untrailed = untrailingslashit( $directory );
+       if ( ! empty( $untrailed ) && ! in_array( $untrailed, $wp_theme_directories ) ) {
+               $wp_theme_directories[] = $untrailed;
+       }
 
        return true;
 }
@@ -399,6 +406,7 @@ function search_theme_directories( $force = false ) {
        $found_themes = array();
 
        $wp_theme_directories = (array) $wp_theme_directories;
+       $relative_theme_roots = array();
 
        // Set up maybe-relative, maybe-absolute array of theme directories.
        // We always want to return absolute, but we need to cache relative
@@ -668,7 +676,6 @@ function preview_theme() {
 
        ob_start( 'preview_theme_ob_filter' );
 }
-add_action('setup_theme', 'preview_theme');
 
 /**
  * Private function to modify the current template when previewing a theme
@@ -752,10 +759,18 @@ function preview_theme_ob_filter_callback( $matches ) {
  * @param string $stylesheet Stylesheet name
  */
 function switch_theme( $stylesheet ) {
-       global $wp_theme_directories, $sidebars_widgets;
+       global $wp_theme_directories, $wp_customize, $sidebars_widgets;
 
-       if ( is_array( $sidebars_widgets ) )
-               set_theme_mod( 'sidebars_widgets', array( 'time' => time(), 'data' => $sidebars_widgets ) );
+       $_sidebars_widgets = null;
+       if ( 'wp_ajax_customize_save' === current_action() ) {
+               $_sidebars_widgets = $wp_customize->post_value( $wp_customize->get_setting( 'old_sidebars_widgets_data' ) );
+       } elseif ( is_array( $sidebars_widgets ) ) {
+               $_sidebars_widgets = $sidebars_widgets;
+       }
+
+       if ( is_array( $_sidebars_widgets ) ) {
+               set_theme_mod( 'sidebars_widgets', array( 'time' => time(), 'data' => $_sidebars_widgets ) );
+       }
 
        $old_theme  = wp_get_theme();
        $new_theme = wp_get_theme( $stylesheet );
@@ -782,9 +797,19 @@ function switch_theme( $stylesheet ) {
 
        update_option( 'current_theme', $new_name );
 
+       // Migrate from the old mods_{name} option to theme_mods_{slug}.
        if ( is_admin() && false === get_option( 'theme_mods_' . $stylesheet ) ) {
                $default_theme_mods = (array) get_option( 'mods_' . $new_name );
                add_option( "theme_mods_$stylesheet", $default_theme_mods );
+       } else {
+               /*
+                * Since retrieve_widgets() is called when initializing a theme in the Customizer,
+                * we need to to remove the theme mods to avoid overwriting changes made via
+                * the Customizer when accessing wp-admin/widgets.php.
+                */
+               if ( 'wp_ajax_customize_save' === current_action() ) {
+                       remove_theme_mod( 'sidebars_widgets' );
+               }
        }
 
        update_option( 'theme_switched', $old_theme->get_stylesheet() );
@@ -846,7 +871,7 @@ function validate_current_theme() {
  *
  * @since 3.1.0
  *
- * @return array Theme modifications.
+ * @return array|null Theme modifications.
  */
 function get_theme_mods() {
        $theme_slug = get_option( 'stylesheet' );
@@ -884,7 +909,7 @@ function get_theme_mod( $name, $default = false ) {
                /**
                 * Filter the theme modification, or 'theme_mod', value.
                 *
-                * The dynamic portion of the hook name, $name, refers to
+                * The dynamic portion of the hook name, `$name`, refers to
                 * the key name of the modification array. For example,
                 * 'header_textcolor', 'header_image', and so on depending
                 * on the theme options.
@@ -909,12 +934,25 @@ function get_theme_mod( $name, $default = false ) {
  * @since 2.1.0
  *
  * @param string $name Theme modification name.
- * @param string $value theme modification value.
+ * @param mixed  $value theme modification value.
  */
 function set_theme_mod( $name, $value ) {
        $mods = get_theme_mods();
+       $old_value = isset( $mods[ $name ] ) ? $mods[ $name ] : false;
 
-       $mods[ $name ] = $value;
+       /**
+        * Filter the theme mod value on save.
+        *
+        * The dynamic portion of the hook name, `$name`, refers to the key name of
+        * the modification array. For example, 'header_textcolor', 'header_image',
+        * and so on depending on the theme options.
+        *
+        * @since 3.9.0
+        *
+        * @param string $value     The new value of the theme mod.
+        * @param string $old_value The current value of the theme mod.
+        */
+       $mods[ $name ] = apply_filters( "pre_set_theme_mod_$name", $value, $old_value );
 
        $theme = get_option( 'stylesheet' );
        update_option( "theme_mods_$theme", $mods );
@@ -996,12 +1034,25 @@ function display_header_text() {
        return 'blank' != $text_color;
 }
 
+/**
+ * Check whether a header image is set or not.
+ *
+ * @since 4.2.0
+ *
+ * @see get_header_image()
+ *
+ * @return bool Whether a header image is set or not.
+ */
+function has_header_image() {
+       return (bool) get_header_image();
+}
+
 /**
  * Retrieve header image for custom header.
  *
  * @since 2.1.0
  *
- * @return string
+ * @return string|false
  */
 function get_header_image() {
        $url = get_theme_mod( 'header_image', get_theme_support( 'custom-header', 'default-image' ) );
@@ -1104,7 +1155,10 @@ function is_random_header_image( $type = 'any' ) {
  * @since 2.1.0
  */
 function header_image() {
-       echo esc_url( get_header_image() );
+       $image = get_header_image();
+       if ( $image ) {
+               echo esc_url( $image );
+       }
 }
 
 /**
@@ -1124,7 +1178,7 @@ function get_uploaded_header_images() {
                return array();
 
        foreach ( (array) $headers as $header ) {
-               $url = esc_url_raw( $header->guid );
+               $url = esc_url_raw( wp_get_attachment_url( $header->ID ) );
                $header_data = wp_get_attachment_metadata( $header->ID );
                $header_index = basename($url);
                $header_images[$header_index] = array();
@@ -1204,7 +1258,8 @@ function register_default_headers( $headers ) {
  * @since 3.0.0
  *
  * @param string|array $header The header string id (key of array) to remove, or an array thereof.
- * @return True on success, false on failure.
+ * @return bool|void A single header returns true on success, false on failure.
+ *                   There is currently no return value for multiple headers.
  */
 function unregister_default_headers( $header ) {
        global $_wp_default_headers;
@@ -1270,7 +1325,11 @@ function _custom_background_cb() {
 
        // $color is the saved custom color.
        // A default has to be specified in style.css. It will not be printed here.
-       $color = get_theme_mod( 'background_color' );
+       $color = get_background_color();
+
+       if ( $color === get_theme_support( 'custom-background', 'default-color' ) ) {
+               $color = false;
+       }
 
        if ( ! $background && ! $color )
                return;
@@ -1321,7 +1380,7 @@ body.custom-background { <?php echo trim( $style ); ?> }
  *
  * @since 3.0.0
  *
- * @param mixed $stylesheet Optional. Stylesheet name or array thereof, relative to theme root.
+ * @param array|string $stylesheet Optional. Stylesheet name or array thereof, relative to theme root.
  *     Defaults to 'editor-style.css'
  */
 function add_editor_style( $stylesheet = 'editor-style.css' ) {
@@ -1358,6 +1417,54 @@ function remove_editor_styles() {
        return true;
 }
 
+/**
+ * Retrieve any registered editor stylesheets
+ *
+ * @since 4.0.0
+ *
+ * @global $editor_styles Registered editor stylesheets
+ *
+ * @return array If registered, a list of editor stylesheet URLs.
+ */
+function get_editor_stylesheets() {
+       $stylesheets = array();
+       // load editor_style.css if the current theme supports it
+       if ( ! empty( $GLOBALS['editor_styles'] ) && is_array( $GLOBALS['editor_styles'] ) ) {
+               $editor_styles = $GLOBALS['editor_styles'];
+
+               $editor_styles = array_unique( array_filter( $editor_styles ) );
+               $style_uri = get_stylesheet_directory_uri();
+               $style_dir = get_stylesheet_directory();
+
+               // Support externally referenced styles (like, say, fonts).
+               foreach ( $editor_styles as $key => $file ) {
+                       if ( preg_match( '~^(https?:)?//~', $file ) ) {
+                               $stylesheets[] = esc_url_raw( $file );
+                               unset( $editor_styles[ $key ] );
+                       }
+               }
+
+               // Look in a parent theme first, that way child theme CSS overrides.
+               if ( is_child_theme() ) {
+                       $template_uri = get_template_directory_uri();
+                       $template_dir = get_template_directory();
+
+                       foreach ( $editor_styles as $key => $file ) {
+                               if ( $file && file_exists( "$template_dir/$file" ) ) {
+                                       $stylesheets[] = "$template_uri/$file";
+                               }
+                       }
+               }
+
+               foreach ( $editor_styles as $file ) {
+                       if ( $file && file_exists( "$style_dir/$file" ) ) {
+                               $stylesheets[] = "$style_uri/$file";
+                       }
+               }
+       }
+       return $stylesheets;
+}
+
 /**
  * Allows a theme to register its support of a certain feature
  *
@@ -1366,7 +1473,9 @@ function remove_editor_styles() {
  * The init hook may be too late for some features.
  *
  * @since 2.9.0
- * @param string $feature the feature being added
+ *
+ * @param string $feature The feature being added.
+ * @return void|bool False on failure, void otherwise.
  */
 function add_theme_support( $feature ) {
        global $_wp_theme_features;
@@ -1378,16 +1487,21 @@ function add_theme_support( $feature ) {
 
        switch ( $feature ) {
                case 'post-formats' :
-                       if ( is_array( $args[0] ) )
-                               $args[0] = array_intersect( $args[0], array_keys( get_post_format_slugs() ) );
+                       if ( is_array( $args[0] ) ) {
+                               $post_formats = get_post_format_slugs();
+                               unset( $post_formats['standard'] );
+
+                               $args[0] = array_intersect( $args[0], array_keys( $post_formats ) );
+                       }
                        break;
 
                case 'html5' :
                        // You can't just pass 'html5', you need to pass an array of types.
                        if ( empty( $args[0] ) ) {
+                               // Build an array of types for back-compat.
                                $args = array( 0 => array( 'comment-list', 'comment-form', 'search-form' ) );
                        } elseif ( ! is_array( $args[0] ) ) {
-                               _doing_it_wrong( "add_theme_support( 'html5' )", 'You need to pass an array of types.', '3.6.1' );
+                               _doing_it_wrong( "add_theme_support( 'html5' )", __( 'You need to pass an array of types.' ), '3.6.1' );
                                return false;
                        }
 
@@ -1398,7 +1512,6 @@ function add_theme_support( $feature ) {
 
                case 'custom-header-uploads' :
                        return add_theme_support( 'custom-header', array( 'uploads' => true ) );
-                       break;
 
                case 'custom-header' :
                        if ( ! is_array( $args ) )
@@ -1513,6 +1626,17 @@ function add_theme_support( $feature ) {
                                define( 'BACKGROUND_IMAGE', $args[0]['default-image'] );
 
                        break;
+
+               // Ensure that 'title-tag' is accessible in the admin.
+               case 'title-tag' :
+                       // Can be called in functions.php but must happen before wp_loaded, i.e. not in header.php.
+                       if ( did_action( 'wp_loaded' ) ) {
+                               /* translators: 1: Theme support 2: hook name */
+                               _doing_it_wrong( "add_theme_support( 'title-tag' )", sprintf( __( 'Theme support for %1$s should be registered before the %2$s hook.' ),
+                                       '<code>title-tag</code>', '<code>wp_loaded</code>' ), '4.1' );
+
+                               return false;
+                       }
        }
 
        $_wp_theme_features[ $feature ] = $args;
@@ -1554,14 +1678,14 @@ function _custom_header_background_just_in_time() {
                }
        }
 }
-add_action( 'wp_loaded', '_custom_header_background_just_in_time' );
 
 /**
  * Gets the theme support arguments passed when registering that support
  *
- * @since 3.1
+ * @since 3.1.0
+ *
  * @param string $feature the feature to check
- * @return array The array of extra arguments
+ * @return mixed The array of extra arguments or the value for the registered feature.
  */
 function get_theme_support( $feature ) {
        global $_wp_theme_features;
@@ -1578,10 +1702,9 @@ function get_theme_support( $feature ) {
                        if ( isset( $_wp_theme_features[ $feature ][0][ $args[0] ] ) )
                                return $_wp_theme_features[ $feature ][0][ $args[0] ];
                        return false;
-                       break;
+
                default :
                        return $_wp_theme_features[ $feature ];
-                       break;
        }
 }
 
@@ -1594,7 +1717,7 @@ function get_theme_support( $feature ) {
  * @since 3.0.0
  * @see add_theme_support()
  * @param string $feature the feature being added
- * @return bool Whether feature was removed.
+ * @return null|bool Whether feature was removed.
  */
 function remove_theme_support( $feature ) {
        // Blacklist: for internal registrations not used directly by themes.
@@ -1609,6 +1732,7 @@ function remove_theme_support( $feature ) {
  *
  * @access private
  * @since 3.1.0
+ * @param string $feature
  */
 function _remove_theme_support( $feature ) {
        global $_wp_theme_features;
@@ -1665,6 +1789,14 @@ function current_theme_supports( $feature ) {
        if ( !isset( $_wp_theme_features[$feature] ) )
                return false;
 
+       if ( 'title-tag' == $feature ) {
+               // Don't confirm support unless called internally.
+               $trace = debug_backtrace();
+               if ( ! in_array( $trace[1]['function'], array( '_wp_render_title_tag', 'wp_title' ) ) ) {
+                       return false;
+               }
+       }
+
        // If no args passed then no extra checks need be performed
        if ( func_num_args() <= 1 )
                return true;
@@ -1680,7 +1812,6 @@ function current_theme_supports( $feature ) {
                                return true;
                        $content_type = $args[0];
                        return in_array( $content_type, $_wp_theme_features[$feature][0] );
-                       break;
 
                case 'html5':
                case 'post-formats':
@@ -1691,7 +1822,6 @@ function current_theme_supports( $feature ) {
 
                        $type = $args[0];
                        return in_array( $type, $_wp_theme_features[$feature][0] );
-                       break;
 
                case 'custom-header':
                case 'custom-background' :
@@ -1699,16 +1829,14 @@ function current_theme_supports( $feature ) {
                        // an array to add_theme_support()
                        $header_support = $args[0];
                        return ( isset( $_wp_theme_features[$feature][0][$header_support] ) && $_wp_theme_features[$feature][0][$header_support] );
-                       break;
        }
 
        /**
         * Filter whether the current theme supports a specific feature.
         *
-        * The dynamic portion of the hook name, $feature, refers to
-        * the specific theme feature. Possible values include 'post-formats',
-        * 'post-thumbnails', 'custom-background', 'custom-header', 'menus',
-        * 'automatic-feed-links', and 'html5'.
+        * The dynamic portion of the hook name, `$feature`, refers to the specific theme
+        * feature. Possible values include 'post-formats', 'post-thumbnails', 'custom-background',
+        * 'custom-header', 'menus', 'automatic-feed-links', and 'html5'.
         *
         * @since 3.4.0
         *
@@ -1723,12 +1851,17 @@ function current_theme_supports( $feature ) {
  * Checks a theme's support for a given feature before loading the functions which implement it.
  *
  * @since 2.9.0
- * @param string $feature the feature being checked
- * @param string $include the file containing the functions that implement the feature
+ *
+ * @param string $feature The feature being checked.
+ * @param string $include Path to the file.
+ * @return bool True if the current theme supports the supplied feature, false otherwise.
  */
-function require_if_theme_supports( $feature, $include) {
-       if ( current_theme_supports( $feature ) )
+function require_if_theme_supports( $feature, $include ) {
+       if ( current_theme_supports( $feature ) ) {
                require ( $include );
+               return true;
+       }
+       return false;
 }
 
 /**
@@ -1753,8 +1886,6 @@ function _delete_attachment_theme_mod( $id ) {
                remove_theme_mod( 'background_image' );
 }
 
-add_action( 'delete_attachment', '_delete_attachment_theme_mod' );
-
 /**
  * Checks if a theme has been changed and runs 'after_switch_theme' hook on the next WP load
  *
@@ -1764,6 +1895,12 @@ function check_theme_switched() {
        if ( $stylesheet = get_option( 'theme_switched' ) ) {
                $old_theme = wp_get_theme( $stylesheet );
 
+               // Prevent retrieve_widgets() from running since Customizer already called it up front
+               if ( get_option( 'theme_switched_via_customizer' ) ) {
+                       remove_action( 'after_switch_theme', '_wp_sidebars_changed' );
+                       update_option( 'theme_switched_via_customizer', false );
+               }
+
                if ( $old_theme->exists() ) {
                        /**
                         * Fires on the first WP load after a theme switch if the old theme still exists.
@@ -1805,7 +1942,6 @@ function _wp_customize_include() {
        // Init Customize class
        $GLOBALS['wp_customize'] = new WP_Customize_Manager;
 }
-add_action( 'plugins_loaded', '_wp_customize_include' );
 
 /**
  * Adds settings for the customize-loader script.
@@ -1828,9 +1964,13 @@ function _wp_customize_loader_settings() {
                'url'           => esc_url( admin_url( 'customize.php' ) ),
                'isCrossDomain' => $cross_domain,
                'browser'       => $browser,
+               'l10n'          => array(
+                       'saveAlert'       => __( 'The changes you made will be lost if you navigate away from this page.' ),
+                       'mainIframeTitle' => __( 'Customizer' ),
+               ),
        );
 
-       $script = 'var _wpCustomizeLoaderSettings = ' . json_encode( $settings ) . ';';
+       $script = 'var _wpCustomizeLoaderSettings = ' . wp_json_encode( $settings ) . ';';
 
        $data = $wp_scripts->get_data( 'customize-loader', 'data' );
        if ( $data )
@@ -1838,10 +1978,9 @@ function _wp_customize_loader_settings() {
 
        $wp_scripts->add_data( 'customize-loader', 'data', $script );
 }
-add_action( 'admin_enqueue_scripts', '_wp_customize_loader_settings' );
 
 /**
- * Returns a URL to load the theme customizer.
+ * Returns a URL to load the Customizer.
  *
  * @since 3.4.0
  *
@@ -1856,7 +1995,7 @@ function wp_customize_url( $stylesheet = null ) {
 }
 
 /**
- * Prints a script to check whether or not the customizer is supported,
+ * Prints a script to check whether or not the Customizer is supported,
  * and apply either the no-customize-support or customize-support class
  * to the body.
  *
@@ -1891,4 +2030,19 @@ function wp_customize_support_script() {
                }());
        </script>
        <?php
-}
\ No newline at end of file
+}
+
+/**
+ * Whether the site is being previewed in the Customizer.
+ *
+ * @since 4.0.0
+ *
+ * @global WP_Customize_Manager $wp_customize Customizer instance.
+ *
+ * @return bool True if the site is being previewed in the Customizer, false otherwise.
+ */
+function is_customize_preview() {
+       global $wp_customize;
+
+       return ( $wp_customize instanceof WP_Customize_Manager ) && $wp_customize->is_preview();
+}