X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/85ad385665744d9cc3bcd939906309be7268edb3..3194d1bb103c2d8db4f44feeced5e58ee2756658:/wp-admin/includes/theme.php diff --git a/wp-admin/includes/theme.php b/wp-admin/includes/theme.php index 2d989204..dda79cbd 100644 --- a/wp-admin/includes/theme.php +++ b/wp-admin/includes/theme.php @@ -11,9 +11,11 @@ * * @since 2.8.0 * + * @global WP_Filesystem_Base $wp_filesystem Subclass + * * @param string $stylesheet Stylesheet of the theme to delete * @param string $redirect Redirect to page when complete. - * @return mixed + * @return void|bool|WP_Error When void, echoes content. */ function delete_theme($stylesheet, $redirect = '') { global $wp_filesystem; @@ -25,8 +27,8 @@ function delete_theme($stylesheet, $redirect = '') { if ( empty( $redirect ) ) $redirect = wp_nonce_url('themes.php?action=delete&stylesheet=' . urlencode( $stylesheet ), 'delete-theme_' . $stylesheet); if ( false === ($credentials = request_filesystem_credentials($redirect)) ) { - $data = ob_get_contents(); - ob_end_clean(); + $data = ob_get_clean(); + if ( ! empty($data) ){ include_once( ABSPATH . 'wp-admin/admin-header.php'); echo $data; @@ -38,8 +40,8 @@ function delete_theme($stylesheet, $redirect = '') { if ( ! WP_Filesystem($credentials) ) { request_filesystem_credentials($redirect, '', true); // Failed to connect, Error and request again - $data = ob_get_contents(); - ob_end_clean(); + $data = ob_get_clean(); + if ( ! empty($data) ) { include_once( ABSPATH . 'wp-admin/admin-header.php'); echo $data; @@ -55,20 +57,34 @@ function delete_theme($stylesheet, $redirect = '') { if ( is_wp_error($wp_filesystem->errors) && $wp_filesystem->errors->get_error_code() ) return new WP_Error('fs_error', __('Filesystem error.'), $wp_filesystem->errors); - //Get the base plugin folder + // Get the base plugin folder. $themes_dir = $wp_filesystem->wp_themes_dir(); - if ( empty($themes_dir) ) - return new WP_Error('fs_no_themes_dir', __('Unable to locate WordPress theme directory.')); + if ( empty( $themes_dir ) ) { + return new WP_Error( 'fs_no_themes_dir', __( 'Unable to locate WordPress theme directory.' ) ); + } $themes_dir = trailingslashit( $themes_dir ); - $theme_dir = trailingslashit($themes_dir . $stylesheet); - $deleted = $wp_filesystem->delete($theme_dir, true); + $theme_dir = trailingslashit( $themes_dir . $stylesheet ); + $deleted = $wp_filesystem->delete( $theme_dir, true ); + + if ( ! $deleted ) { + return new WP_Error( 'could_not_remove_theme', sprintf( __( 'Could not fully remove the theme %s.' ), $stylesheet ) ); + } + + $theme_translations = wp_get_installed_translations( 'themes' ); + + // Remove language files, silently. + if ( ! empty( $theme_translations[ $stylesheet ] ) ) { + $translations = $theme_translations[ $stylesheet ]; - if ( ! $deleted ) - return new WP_Error('could_not_remove_theme', sprintf(__('Could not fully remove the theme %s.'), $stylesheet) ); + foreach ( $translations as $translation => $data ) { + $wp_filesystem->delete( WP_LANG_DIR . '/themes/' . $stylesheet . '-' . $translation . '.po' ); + $wp_filesystem->delete( WP_LANG_DIR . '/themes/' . $stylesheet . '-' . $translation . '.mo' ); + } + } - // Force refresh of theme update information - delete_site_transient('update_themes'); + // Force refresh of theme update information. + delete_site_transient( 'update_themes' ); return true; } @@ -78,10 +94,11 @@ function delete_theme($stylesheet, $redirect = '') { * * @since 1.5.0 * + * @param WP_Post|null $post Optional. The post being edited, provided for context. * @return array Key is the template name, value is the filename of the template */ -function get_page_templates() { - return array_flip( wp_get_theme()->get_page_templates() ); +function get_page_templates( $post = null ) { + return array_flip( wp_get_theme()->get_page_templates( $post ) ); } /** @@ -106,7 +123,7 @@ function _get_template_edit_filename($fullpath, $containingfolder) { * @since 2.7.0 * @see get_theme_update_available() * - * @param object $theme Theme data object. + * @param WP_Theme $theme Theme data object. */ function theme_update_available( $theme ) { echo get_theme_update_available( $theme ); @@ -119,11 +136,13 @@ function theme_update_available( $theme ) { * * @since 3.8.0 * + * @staticvar object $themes_update + * * @param WP_Theme $theme WP_Theme object. - * @return string|bool HTML for the update link, or false if invalid info was passed. + * @return false|string HTML for the update link, or false if invalid info was passed. */ function get_theme_update_available( $theme ) { - static $themes_update; + static $themes_update = null; if ( !current_user_can('update_themes' ) ) return false; @@ -131,8 +150,9 @@ function get_theme_update_available( $theme ) { if ( !isset($themes_update) ) $themes_update = get_site_transient('update_themes'); - if ( ! is_a( $theme, 'WP_Theme' ) ) + if ( ! ( $theme instanceof WP_Theme ) ) { return false; + } $stylesheet = $theme->get_stylesheet(); @@ -147,11 +167,14 @@ function get_theme_update_available( $theme ) { if ( !is_multisite() ) { if ( ! current_user_can('update_themes') ) { - $html = sprintf( '

' . __('There is a new version of %1$s available. View version %3$s details.') . '

', $theme_name, $details_url, $update['new_version']); - } else if ( empty( $update['package'] ) ) { - $html = sprintf( '

' . __('There is a new version of %1$s available. View version %3$s details. Automatic update is unavailable for this theme.') . '

', $theme_name, $details_url, $update['new_version']); + $html = sprintf( '

' . __( 'There is a new version of %1$s available. View version %4$s details.' ) . '

', + $theme_name, esc_url( $details_url ), esc_attr( $theme['Name'] ), $update['new_version'] ); + } elseif ( empty( $update['package'] ) ) { + $html = sprintf( '

' . __( 'There is a new version of %1$s available. View version %4$s details. Automatic update is unavailable for this theme.' ) . '

', + $theme_name, esc_url( $details_url ), esc_attr( $theme['Name'] ), $update['new_version'] ); } else { - $html = sprintf( '

' . __('There is a new version of %1$s available. View version %3$s details or update now.') . '

', $theme_name, $details_url, $update['new_version'], $update_url, $update_onclick ); + $html = sprintf( '

' . __( 'There is a new version of %1$s available. View version %4$s details or update now.' ) . '

', + $theme_name, esc_url( $details_url ), esc_attr( $theme['Name'] ), $update['new_version'], $update_url, $update_onclick ); } } } @@ -164,7 +187,7 @@ function get_theme_update_available( $theme ) { * * @since 3.1.0 * - * @param bool $api Optional. Whether try to fetch tags from the WP.org API. Defaults to true. + * @param bool $api Optional. Whether try to fetch tags from the WordPress.org API. Defaults to true. * @return array Array of features keyed by category with translations keyed by slug. */ function get_theme_feature_list( $api = true ) { @@ -188,7 +211,10 @@ function get_theme_feature_list( $api = true ) { 'light' => __( 'Light' ), ), - __( 'Columns' ) => array( + __( 'Layout' ) => array( + 'fixed-layout' => __( 'Fixed Layout' ), + 'fluid-layout' => __( 'Fluid Layout' ), + 'responsive-layout' => __( 'Responsive Layout' ), 'one-column' => __( 'One Column' ), 'two-columns' => __( 'Two Columns' ), 'three-columns' => __( 'Three Columns' ), @@ -197,12 +223,6 @@ function get_theme_feature_list( $api = true ) { 'right-sidebar' => __( 'Right Sidebar' ), ), - __( 'Layout' ) => array( - 'fixed-layout' => __( 'Fixed Layout' ), - 'fluid-layout' => __( 'Fluid Layout' ), - 'responsive-layout' => __( 'Responsive Layout' ), - ), - __( 'Features' ) => array( 'accessibility-ready' => __( 'Accessibility Ready' ), 'blavatar' => __( 'Blavatar' ), @@ -237,7 +257,7 @@ function get_theme_feature_list( $api = true ) { return $features; if ( !$feature_list = get_site_transient( 'wporg_theme_feature_list' ) ) - set_site_transient( 'wporg_theme_feature_list', array(), 10800); + set_site_transient( 'wporg_theme_feature_list', array(), 3 * HOUR_IN_SECONDS ); if ( !$feature_list ) { $feature_list = themes_api( 'feature_list', array() ); @@ -248,11 +268,10 @@ function get_theme_feature_list( $api = true ) { if ( !$feature_list ) return $features; - set_site_transient( 'wporg_theme_feature_list', $feature_list, 10800 ); + set_site_transient( 'wporg_theme_feature_list', $feature_list, 3 * HOUR_IN_SECONDS ); $category_translations = array( 'Colors' => __( 'Colors' ), - 'Columns' => __( 'Columns' ), 'Layout' => __( 'Layout' ), 'Features' => __( 'Features' ), 'Subject' => __( 'Subject' ) @@ -277,33 +296,100 @@ function get_theme_feature_list( $api = true ) { } /** - * Retrieve theme installer pages from WordPress Themes API. + * Retrieves theme installer pages from the WordPress.org Themes API. * * It is possible for a theme to override the Themes API result with three * filters. Assume this is for themes, which can extend on the Theme Info to * offer more choices. This is very powerful and must be used with care, when - * overridding the filters. + * overriding the filters. + * + * The first filter, {@see 'themes_api_args'}, is for the args and gives the action + * as the second parameter. The hook for {@see 'themes_api_args'} must ensure that + * an object is returned. + * + * The second filter, {@see 'themes_api'}, allows a plugin to override the WordPress.org + * Theme API entirely. If `$action` is 'query_themes', 'theme_information', or 'feature_list', + * an object MUST be passed. If `$action` is 'hot_tags`, an array should be passed. * - * The first filter, 'themes_api_args', is for the args and gives the action as - * the second parameter. The hook for 'themes_api_args' must ensure that an - * object is returned. + * Finally, the third filter, {@see 'themes_api_result'}, makes it possible to filter the + * response object or array, depending on the `$action` type. * - * The second filter, 'themes_api', is the result that would be returned. + * Supported arguments per action: + * + * | Argument Name | 'query_themes' | 'theme_information' | 'hot_tags' | 'feature_list' | + * | -------------------| :------------: | :-----------------: | :--------: | :--------------: | + * | `$slug` | No | Yes | No | No | + * | `$per_page` | Yes | No | No | No | + * | `$page` | Yes | No | No | No | + * | `$number` | No | No | Yes | No | + * | `$search` | Yes | No | No | No | + * | `$tag` | Yes | No | No | No | + * | `$author` | Yes | No | No | No | + * | `$user` | Yes | No | No | No | + * | `$browse` | Yes | No | No | No | + * | `$locale` | Yes | Yes | No | No | + * | `$fields` | Yes | Yes | No | No | * * @since 2.8.0 * - * @param string $action The requested action. Likely values are 'theme_information', - * 'feature_list', or 'query_themes'. - * @param array|object $args Optional. Arguments to serialize for the Theme Info API. - * @return mixed + * @param string $action API action to perform: 'query_themes', 'theme_information', + * 'hot_tags' or 'feature_list'. + * @param array|object $args { + * Optional. Array or object of arguments to serialize for the Plugin Info API. + * + * @type string $slug The plugin slug. Default empty. + * @type int $per_page Number of themes per page. Default 24. + * @type int $page Number of current page. Default 1. + * @type int $number Number of tags to be queried. + * @type string $search A search term. Default empty. + * @type string $tag Tag to filter themes. Default empty. + * @type string $author Username of an author to filter themes. Default empty. + * @type string $user Username to query for their favorites. Default empty. + * @type string $browse Browse view: 'featured', 'popular', 'updated', 'favorites'. + * @type string $locale Locale to provide context-sensitive results. Default is the value of get_locale(). + * @type array $fields { + * Array of fields which should or should not be returned. + * + * @type bool $description Whether to return the theme full description. Default false. + * @type bool $sections Whether to return the theme readme sections: description, installation, + * FAQ, screenshots, other notes, and changelog. Default false. + * @type bool $rating Whether to return the rating in percent and total number of ratings. + * Default false. + * @type bool $ratings Whether to return the number of rating for each star (1-5). Default false. + * @type bool $downloaded Whether to return the download count. Default false. + * @type bool $downloadlink Whether to return the download link for the package. Default false. + * @type bool $last_updated Whether to return the date of the last update. Default false. + * @type bool $tags Whether to return the assigned tags. Default false. + * @type bool $homepage Whether to return the theme homepage link. Default false. + * @type bool $screenshots Whether to return the screenshots. Default false. + * @type int $screenshot_count Number of screenshots to return. Default 1. + * @type bool $screenshot_url Whether to return the URL of the first screenshot. Default false. + * @type bool $photon_screenshots Whether to return the screenshots via Photon. Default false. + * @type bool $template Whether to return the slug of the parent theme. Default false. + * @type bool $parent Whether to return the slug, name and homepage of the parent theme. Default false. + * @type bool $versions Whether to return the list of all available versions. Default false. + * @type bool $theme_url Whether to return theme's URL. Default false. + * @type bool $extended_author Whether to return nicename or nicename and display name. Default false. + * } + * } + * @return object|array|WP_Error Response object or array on success, WP_Error on failure. See the + * {@link https://developer.wordpress.org/reference/functions/themes_api/ function reference article} + * for more information on the make-up of possible return objects depending on the value of `$action`. */ -function themes_api( $action, $args = null ) { +function themes_api( $action, $args = array() ) { - if ( is_array($args) ) - $args = (object)$args; + if ( is_array( $args ) ) { + $args = (object) $args; + } - if ( !isset($args->per_page) ) + if ( ! isset( $args->per_page ) ) { $args->per_page = 24; + } + + if ( ! isset( $args->locale ) ) { + $args->locale = get_locale(); + } + /** * Filter arguments used to query for installer pages from the WordPress.org Themes API. * @@ -314,21 +400,23 @@ function themes_api( $action, $args = null ) { * @param object $args Arguments used to query for installer pages from the WordPress.org Themes API. * @param string $action Requested action. Likely values are 'theme_information', * 'feature_list', or 'query_themes'. - */ + */ $args = apply_filters( 'themes_api_args', $args, $action ); /** * Filter whether to override the WordPress.org Themes API. * - * Returning a value of true to this filter allows a theme to completely - * override the built-in WordPress.org API. + * Passing a non-false value will effectively short-circuit the WordPress.org API request. + * + * If `$action` is 'query_themes', 'theme_information', or 'feature_list', an object MUST + * be passed. If `$action` is 'hot_tags`, an array should be passed. * * @since 2.8.0 * - * @param bool $bool Whether to override the WordPress.org Themes API. Default false. - * @param string $action Requested action. Likely values are 'theme_information', - * 'feature_list', or 'query_themes'. - * @param object $args Arguments used to query for installer pages from the Themes API. + * @param false|object|array $override Whether to override the WordPress.org Themes API. Default false. + * @param string $action Requested action. Likely values are 'theme_information', + * 'feature_list', or 'query_themes'. + * @param object $args Arguments used to query for installer pages from the Themes API. */ $res = apply_filters( 'themes_api', false, $action, $args ); @@ -337,25 +425,27 @@ function themes_api( $action, $args = null ) { if ( $ssl = wp_http_supports( array( 'ssl' ) ) ) $url = set_url_scheme( $url, 'https' ); - $args = array( + $http_args = array( 'body' => array( 'action' => $action, 'request' => serialize( $args ) ) ); - $request = wp_remote_post( $url, $args ); + $request = wp_remote_post( $url, $http_args ); if ( $ssl && is_wp_error( $request ) ) { - trigger_error( __( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server’s configuration. If you continue to have problems, please try the support forums.' ) . ' ' . '(WordPress could not establish a secure connection to WordPress.org. Please contact your server administrator.)', headers_sent() || WP_DEBUG ? E_USER_WARNING : E_USER_NOTICE ); - $request = wp_remote_post( $http_url, $args ); + if ( ! defined( 'DOING_AJAX' ) || ! DOING_AJAX ) { + trigger_error( __( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server’s configuration. If you continue to have problems, please try the support forums.' ) . ' ' . __( '(WordPress could not establish a secure connection to WordPress.org. Please contact your server administrator.)' ), headers_sent() || WP_DEBUG ? E_USER_WARNING : E_USER_NOTICE ); + } + $request = wp_remote_post( $http_url, $http_args ); } if ( is_wp_error($request) ) { - $res = new WP_Error('themes_api_failed', __( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server’s configuration. If you continue to have problems, please try the support forums.' ), $request->get_error_message() ); + $res = new WP_Error('themes_api_failed', __( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server’s configuration. If you continue to have problems, please try the support forums.' ), $request->get_error_message() ); } else { $res = maybe_unserialize( wp_remote_retrieve_body( $request ) ); if ( ! is_object( $res ) && ! is_array( $res ) ) - $res = new WP_Error('themes_api_failed', __( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server’s configuration. If you continue to have problems, please try the support forums.' ), wp_remote_retrieve_body( $request ) ); + $res = new WP_Error('themes_api_failed', __( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server’s configuration. If you continue to have problems, please try the support forums.' ), wp_remote_retrieve_body( $request ) ); } } @@ -385,8 +475,26 @@ function themes_api( $action, $args = null ) { function wp_prepare_themes_for_js( $themes = null ) { $current_theme = get_stylesheet(); + /** + * Filter theme data before it is prepared for JavaScript. + * + * Passing a non-empty array will result in wp_prepare_themes_for_js() returning + * early with that value instead. + * + * @since 4.2.0 + * + * @param array $prepared_themes An associative array of theme data. Default empty array. + * @param null|array $themes An array of WP_Theme objects to prepare, if any. + * @param string $current_theme The current theme slug. + */ + $prepared_themes = (array) apply_filters( 'pre_prepare_themes_for_js', array(), $themes, $current_theme ); + + if ( ! empty( $prepared_themes ) ) { + return $prepared_themes; + } + // Make sure the current theme is listed first. - $prepared_themes = array( $current_theme => array() ); + $prepared_themes[ $current_theme ] = array(); if ( null === $themes ) { $themes = wp_get_themes( array( 'allowed' => true ) ); @@ -404,14 +512,28 @@ function wp_prepare_themes_for_js( $themes = null ) { } WP_Theme::sort_by_name( $themes ); + + $parents = array(); + foreach ( $themes as $theme ) { + $slug = $theme->get_stylesheet(); + $encoded_slug = urlencode( $slug ); + $parent = false; if ( $theme->parent() ) { $parent = $theme->parent()->display( 'Name' ); + $parents[ $slug ] = $theme->parent()->get_stylesheet(); } - $slug = $theme->get_stylesheet(); - $encoded_slug = urlencode( $slug ); + $customize_action = null; + if ( current_user_can( 'edit_theme_options' ) && current_user_can( 'customize' ) ) { + $customize_action = esc_url( add_query_arg( + array( + 'return' => urlencode( esc_url_raw( wp_unslash( $_SERVER['REQUEST_URI'] ) ) ), + ), + wp_customize_url( $slug ) + ) ); + } $prepared_themes[ $slug ] = array( 'id' => $slug, @@ -428,19 +550,17 @@ function wp_prepare_themes_for_js( $themes = null ) { 'update' => get_theme_update_available( $theme ), 'actions' => array( 'activate' => current_user_can( 'switch_themes' ) ? wp_nonce_url( admin_url( 'themes.php?action=activate&stylesheet=' . $encoded_slug ), 'switch-theme_' . $slug ) : null, - 'customize'=> current_user_can( 'edit_theme_options' ) ? wp_customize_url( $slug ) : null, - 'preview' => add_query_arg( array( - 'preview' => 1, - 'template' => urlencode( $theme->get_template() ), - 'stylesheet' => urlencode( $slug ), - 'preview_iframe' => true, - 'TB_iframe' => true, - ), home_url( '/' ) ), + 'customize' => $customize_action, 'delete' => current_user_can( 'delete_themes' ) ? wp_nonce_url( admin_url( 'themes.php?action=delete&stylesheet=' . $encoded_slug ), 'delete-theme_' . $slug ) : null, ), ); } + // Remove 'delete' action if theme has an active child + if ( ! empty( $parents ) && array_key_exists( $current_theme, $parents ) ) { + unset( $prepared_themes[ $parents[ $current_theme ] ]['actions']['delete'] ); + } + /** * Filter the themes prepared for JavaScript, for themes.php. * @@ -451,5 +571,62 @@ function wp_prepare_themes_for_js( $themes = null ) { * @param array $prepared_themes Array of themes. */ $prepared_themes = apply_filters( 'wp_prepare_themes_for_js', $prepared_themes ); - return array_values( $prepared_themes ); -} \ No newline at end of file + $prepared_themes = array_values( $prepared_themes ); + return array_filter( $prepared_themes ); +} + +/** + * Print JS templates for the theme-browsing UI in the Customizer. + * + * @since 4.2.0 + */ +function customize_themes_print_templates() { + $preview_url = esc_url( add_query_arg( 'theme', '__THEME__' ) ); // Token because esc_url() strips curly braces. + $preview_url = str_replace( '__THEME__', '{{ data.id }}', $preview_url ); + ?> + +