2007-05-25 07:16:21 +00:00
<? php
2008-10-02 01:03:26 +00:00
/**
* WordPress Theme Administration API
*
* @package WordPress
* @subpackage Administration
*/
2007-05-25 07:16:21 +00:00
2009-03-05 19:15:56 +00:00
/**
* Remove a theme
*
* @since 2.8.0
*
2018-03-04 21:58:30 +00:00
* @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
2015-05-29 02:06:31 +00:00
*
2018-03-04 22:07:29 +00:00
* @param string $stylesheet Stylesheet of the theme to delete.
* @param string $redirect Redirect to page when complete.
* @return bool|null|WP_Error True on success, false if `$stylesheet` is empty, WP_Error on failure.
* Null if filesystem credentials are required to proceed.
2009-03-05 19:15:56 +00:00
*/
2017-11-30 23:11:00 +00:00
function delete_theme ( $stylesheet , $redirect = '' ) {
2009-03-05 19:15:56 +00:00
global $wp_filesystem ;
2017-11-30 23:11:00 +00:00
if ( empty ( $stylesheet ) ) {
2009-03-05 19:15:56 +00:00
return false ;
2017-11-30 23:11:00 +00:00
}
2009-03-05 19:15:56 +00:00
2016-07-27 17:11:56 +00:00
if ( empty ( $redirect ) ) {
2017-11-30 23:11:00 +00:00
$redirect = wp_nonce_url ( 'themes.php?action=delete&stylesheet=' . urlencode ( $stylesheet ), 'delete-theme_' . $stylesheet );
2016-07-27 17:11:56 +00:00
}
ob_start ();
$credentials = request_filesystem_credentials ( $redirect );
2017-11-30 23:11:00 +00:00
$data = ob_get_clean ();
2015-06-27 01:12:24 +00:00
2016-07-27 17:11:56 +00:00
if ( false === $credentials ) {
2017-11-30 23:11:00 +00:00
if ( ! empty ( $data ) ) {
include_once ( ABSPATH . 'wp-admin/admin-header.php' );
2009-03-05 19:15:56 +00:00
echo $data ;
2017-11-30 23:11:00 +00:00
include ( ABSPATH . 'wp-admin/admin-footer.php' );
2009-03-05 19:15:56 +00:00
exit ;
}
return ;
}
2016-07-27 17:11:56 +00:00
if ( ! WP_Filesystem ( $credentials ) ) {
ob_start ();
request_filesystem_credentials ( $redirect , '' , true ); // Failed to connect, Error and request again.
2015-06-27 01:12:24 +00:00
$data = ob_get_clean ();
2017-11-30 23:11:00 +00:00
if ( ! empty ( $data ) ) {
include_once ( ABSPATH . 'wp-admin/admin-header.php' );
2009-03-05 19:15:56 +00:00
echo $data ;
2017-11-30 23:11:00 +00:00
include ( ABSPATH . 'wp-admin/admin-footer.php' );
2009-03-05 19:15:56 +00:00
exit ;
}
return ;
}
2017-11-30 23:11:00 +00:00
if ( ! is_object ( $wp_filesystem ) ) {
return new WP_Error ( 'fs_unavailable' , __ ( 'Could not access filesystem.' ) );
}
2009-03-05 19:15:56 +00:00
2018-02-27 02:31:31 +00:00
if ( is_wp_error ( $wp_filesystem -> errors ) && $wp_filesystem -> errors -> has_errors () ) {
2017-11-30 23:11:00 +00:00
return new WP_Error ( 'fs_error' , __ ( 'Filesystem error.' ), $wp_filesystem -> errors );
}
2009-03-05 19:15:56 +00:00
2014-10-08 19:05:20 +00:00
// Get the base plugin folder.
2009-03-05 19:15:56 +00:00
$themes_dir = $wp_filesystem -> wp_themes_dir ();
2014-10-08 19:05:20 +00:00
if ( empty ( $themes_dir ) ) {
2016-07-17 13:29:29 +00:00
return new WP_Error ( 'fs_no_themes_dir' , __ ( 'Unable to locate WordPress theme directory.' ) );
2014-10-08 19:05:20 +00:00
}
2009-03-05 19:15:56 +00:00
$themes_dir = trailingslashit ( $themes_dir );
2017-11-30 23:11:00 +00:00
$theme_dir = trailingslashit ( $themes_dir . $stylesheet );
$deleted = $wp_filesystem -> delete ( $theme_dir , true );
2014-10-08 19:05:20 +00:00
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 ];
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' );
2019-01-21 20:41:50 +00:00
$json_translation_files = glob ( WP_LANG_DIR . '/themes/' . $stylesheet . '-' . $translation . '-*.json' );
if ( $json_translation_files ) {
array_map ( array ( $wp_filesystem , 'delete' ), $json_translation_files );
}
2014-10-08 19:05:20 +00:00
}
}
2009-03-05 19:15:56 +00:00
2016-04-14 03:49:26 +00:00
// Remove the theme from allowed themes on the network.
if ( is_multisite () ) {
WP_Theme :: network_disable_theme ( $stylesheet );
}
2014-10-08 19:05:20 +00:00
// Force refresh of theme update information.
delete_site_transient ( 'update_themes' );
2009-03-05 19:15:56 +00:00
return true ;
}
2008-10-02 01:03:26 +00:00
/**
2009-11-13 22:40:40 +00:00
* Get the Page Templates available in this theme
2008-10-02 01:03:26 +00:00
*
2010-12-01 19:24:38 +00:00
* @since 1.5.0
2016-10-26 08:07:30 +00:00
* @since 4.7.0 Added the `$post_type` parameter.
2008-10-02 01:03:26 +00:00
*
2016-10-26 08:07:30 +00:00
* @param WP_Post|null $post Optional. The post being edited, provided for context.
* @param string $post_type Optional. Post type to get the templates for. Default 'page'.
2011-04-13 11:50:27 +00:00
* @return array Key is the template name, value is the filename of the template
2008-10-02 01:03:26 +00:00
*/
2016-10-26 08:07:30 +00:00
function get_page_templates ( $post = null , $post_type = 'page' ) {
return array_flip ( wp_get_theme () -> get_page_templates ( $post , $post_type ) );
2007-05-25 07:16:21 +00:00
}
2009-10-19 21:39:04 +00:00
/**
* Tidies a filename for url display by the theme editor.
2010-01-15 22:11:12 +00:00
*
2009-10-19 21:39:04 +00:00
* @since 2.9.0
2010-05-03 13:27:15 +00:00
* @access private
2010-01-15 22:11:12 +00:00
*
2009-10-19 21:39:04 +00:00
* @param string $fullpath Full path to the theme file
* @param string $containingfolder Path of the theme parent folder
* @return string
*/
2017-11-30 23:11:00 +00:00
function _get_template_edit_filename ( $fullpath , $containingfolder ) {
return str_replace ( dirname ( dirname ( $containingfolder ) ), '' , $fullpath );
2009-10-19 21:39:04 +00:00
}
2010-05-03 13:29:15 +00:00
/**
* Check if there is an update for a theme available.
*
* Will display link, if there is an update available.
*
* @since 2.7.0
2013-11-20 02:57:10 +00:00
* @see get_theme_update_available()
2010-05-03 13:29:15 +00:00
*
2015-05-29 20:17:26 +00:00
* @param WP_Theme $theme Theme data object.
2010-05-03 13:29:15 +00:00
*/
function theme_update_available ( $theme ) {
2013-11-20 02:57:10 +00:00
echo get_theme_update_available ( $theme );
}
/**
2013-12-06 19:18:11 +00:00
* Retrieve the update link if there is a theme update available.
2013-11-20 02:57:10 +00:00
*
2013-12-06 19:18:11 +00:00
* Will return a link if there is an update available.
2013-11-20 02:57:10 +00:00
*
* @since 3.8.0
*
2015-05-29 15:43:29 +00:00
* @staticvar object $themes_update
*
2013-12-06 19:18:11 +00:00
* @param WP_Theme $theme WP_Theme object.
2014-12-01 01:00:22 +00:00
* @return false|string HTML for the update link, or false if invalid info was passed.
2013-11-20 02:57:10 +00:00
*/
function get_theme_update_available ( $theme ) {
2015-05-29 15:43:29 +00:00
static $themes_update = null ;
2010-05-03 13:29:15 +00:00
2017-11-30 23:11:00 +00:00
if ( ! current_user_can ( 'update_themes' ) ) {
2013-11-20 02:57:10 +00:00
return false ;
2017-11-30 23:11:00 +00:00
}
2010-05-03 13:29:15 +00:00
2017-11-30 23:11:00 +00:00
if ( ! isset ( $themes_update ) ) {
$themes_update = get_site_transient ( 'update_themes' );
}
2010-05-03 13:29:15 +00:00
2015-01-16 01:06:24 +00:00
if ( ! ( $theme instanceof WP_Theme ) ) {
2013-11-20 02:57:10 +00:00
return false ;
2015-01-16 01:06:24 +00:00
}
2012-02-28 21:24:44 +00:00
$stylesheet = $theme -> get_stylesheet ();
2010-05-03 13:29:15 +00:00
2013-11-20 02:57:10 +00:00
$html = '' ;
2017-11-30 23:11:00 +00:00
if ( isset ( $themes_update -> response [ $stylesheet ] ) ) {
$update = $themes_update -> response [ $stylesheet ];
$theme_name = $theme -> display ( 'Name' );
$details_url = add_query_arg (
array (
'TB_iframe' => 'true' ,
'width' => 1024 ,
'height' => 800 ,
2018-08-17 01:51:36 +00:00
),
$update [ 'url' ]
2017-11-30 23:11:00 +00:00
); //Theme browser inside WP? replace this, Also, theme preview JS will override this on the available list.
$update_url = wp_nonce_url ( admin_url ( 'update.php?action=upgrade-theme&theme=' . urlencode ( $stylesheet ) ), 'upgrade-theme_' . $stylesheet );
if ( ! is_multisite () ) {
if ( ! current_user_can ( 'update_themes' ) ) {
2016-07-17 21:03:31 +00:00
/* translators: 1: theme name, 2: theme details URL, 3: additional link attributes, 4: version number */
2017-11-30 23:11:00 +00:00
$html = sprintf (
'<p><strong>' . __ ( 'There is a new version of %1$s available. <a href="%2$s" %3$s>View version %4$s details</a>.' ) . '</strong></p>' ,
2016-03-04 11:12:26 +00:00
$theme_name ,
esc_url ( $details_url ),
2017-11-30 23:11:00 +00:00
sprintf (
'class="thickbox open-plugin-details-modal" aria-label="%s"' ,
2016-07-17 21:03:31 +00:00
/* translators: 1: theme name, 2: version number */
esc_attr ( sprintf ( __ ( 'View %1$s version %2$s details' ), $theme_name , $update [ 'new_version' ] ) )
),
2016-03-04 11:12:26 +00:00
$update [ 'new_version' ]
);
2015-01-08 07:05:25 +00:00
} elseif ( empty ( $update [ 'package' ] ) ) {
2016-07-17 21:03:31 +00:00
/* translators: 1: theme name, 2: theme details URL, 3: additional link attributes, 4: version number */
2017-11-30 23:11:00 +00:00
$html = sprintf (
'<p><strong>' . __ ( 'There is a new version of %1$s available. <a href="%2$s" %3$s>View version %4$s details</a>. <em>Automatic update is unavailable for this theme.</em>' ) . '</strong></p>' ,
2016-03-04 11:12:26 +00:00
$theme_name ,
esc_url ( $details_url ),
2017-11-30 23:11:00 +00:00
sprintf (
'class="thickbox open-plugin-details-modal" aria-label="%s"' ,
2016-07-17 21:03:31 +00:00
/* translators: 1: theme name, 2: version number */
esc_attr ( sprintf ( __ ( 'View %1$s version %2$s details' ), $theme_name , $update [ 'new_version' ] ) )
),
2016-03-04 11:12:26 +00:00
$update [ 'new_version' ]
);
2013-11-20 02:57:10 +00:00
} else {
2016-07-17 21:03:31 +00:00
/* translators: 1: theme name, 2: theme details URL, 3: additional link attributes, 4: version number, 5: update URL, 6: additional link attributes */
2017-11-30 23:11:00 +00:00
$html = sprintf (
'<p><strong>' . __ ( 'There is a new version of %1$s available. <a href="%2$s" %3$s>View version %4$s details</a> or <a href="%5$s" %6$s>update now</a>.' ) . '</strong></p>' ,
2016-03-04 11:12:26 +00:00
$theme_name ,
esc_url ( $details_url ),
2017-11-30 23:11:00 +00:00
sprintf (
'class="thickbox open-plugin-details-modal" aria-label="%s"' ,
2016-07-17 21:03:31 +00:00
/* translators: 1: theme name, 2: version number */
esc_attr ( sprintf ( __ ( 'View %1$s version %2$s details' ), $theme_name , $update [ 'new_version' ] ) )
),
2016-03-04 11:12:26 +00:00
$update [ 'new_version' ],
$update_url ,
2017-11-30 23:11:00 +00:00
sprintf (
'aria-label="%s" id="update-theme" data-slug="%s"' ,
2016-07-17 21:03:31 +00:00
/* translators: %s: theme name */
esc_attr ( sprintf ( __ ( 'Update %s now' ), $theme_name ) ),
$stylesheet
)
2016-03-04 11:12:26 +00:00
);
2013-11-20 02:57:10 +00:00
}
2010-11-30 03:03:40 +00:00
}
2010-05-03 13:29:15 +00:00
}
2013-11-20 02:57:10 +00:00
return $html ;
2010-05-03 13:29:15 +00:00
}
2010-09-24 15:28:28 +00:00
/**
2019-01-18 01:03:50 +00:00
* Retrieve list of WordPress theme features (aka theme tags).
2010-09-24 15:28:28 +00:00
*
* @since 3.1.0
*
2015-11-22 22:38:26 +00:00
* @param bool $api Optional. Whether try to fetch tags from the WordPress.org API. Defaults to true.
2011-12-14 17:36:38 +00:00
* @return array Array of features keyed by category with translations keyed by slug.
2010-09-24 15:28:28 +00:00
*/
2012-02-28 20:38:09 +00:00
function get_theme_feature_list ( $api = true ) {
2010-09-24 15:28:28 +00:00
// Hard-coded list is used if api not accessible.
$features = array (
2017-09-29 20:13:50 +00:00
__ ( 'Subject' ) => array (
'blog' => __ ( 'Blog' ),
'e-commerce' => __ ( 'E-Commerce' ),
'education' => __ ( 'Education' ),
'entertainment' => __ ( 'Entertainment' ),
'food-and-drink' => __ ( 'Food & Drink' ),
'holiday' => __ ( 'Holiday' ),
'news' => __ ( 'News' ),
'photography' => __ ( 'Photography' ),
'portfolio' => __ ( 'Portfolio' ),
2010-09-24 15:28:28 +00:00
),
__ ( 'Features' ) => array (
2013-12-05 03:49:10 +00:00
'accessibility-ready' => __ ( 'Accessibility Ready' ),
2011-06-22 19:45:21 +00:00
'custom-background' => __ ( 'Custom Background' ),
'custom-colors' => __ ( 'Custom Colors' ),
'custom-header' => __ ( 'Custom Header' ),
2016-07-04 09:35:27 +00:00
'custom-logo' => __ ( 'Custom Logo' ),
2011-06-22 19:45:21 +00:00
'editor-style' => __ ( 'Editor Style' ),
'featured-image-header' => __ ( 'Featured Image Header' ),
'featured-images' => __ ( 'Featured Images' ),
2016-04-21 21:11:29 +00:00
'footer-widgets' => __ ( 'Footer Widgets' ),
2011-06-22 19:45:21 +00:00
'full-width-template' => __ ( 'Full Width Template' ),
'post-formats' => __ ( 'Post Formats' ),
'sticky-post' => __ ( 'Sticky Post' ),
'theme-options' => __ ( 'Theme Options' ),
2010-09-24 15:28:28 +00:00
),
2017-11-30 23:11:00 +00:00
__ ( 'Layout' ) => array (
2017-09-29 20:13:50 +00:00
'grid-layout' => __ ( 'Grid Layout' ),
'one-column' => __ ( 'One Column' ),
'two-columns' => __ ( 'Two Columns' ),
'three-columns' => __ ( 'Three Columns' ),
'four-columns' => __ ( 'Four Columns' ),
'left-sidebar' => __ ( 'Left Sidebar' ),
'right-sidebar' => __ ( 'Right Sidebar' ),
2017-11-30 23:11:00 +00:00
),
2017-09-29 20:13:50 +00:00
2010-09-24 15:28:28 +00:00
);
2017-11-30 23:11:00 +00:00
if ( ! $api || ! current_user_can ( 'install_themes' ) ) {
2010-09-24 15:28:28 +00:00
return $features ;
2017-11-30 23:11:00 +00:00
}
2010-09-24 15:28:28 +00:00
2017-11-30 23:11:00 +00:00
if ( ! $feature_list = get_site_transient ( 'wporg_theme_feature_list' ) ) {
2014-05-05 08:26:24 +00:00
set_site_transient ( 'wporg_theme_feature_list' , array (), 3 * HOUR_IN_SECONDS );
2017-11-30 23:11:00 +00:00
}
2010-09-24 15:28:28 +00:00
2017-11-30 23:11:00 +00:00
if ( ! $feature_list ) {
2013-01-04 10:13:51 +00:00
$feature_list = themes_api ( 'feature_list' , array () );
2017-11-30 23:11:00 +00:00
if ( is_wp_error ( $feature_list ) ) {
2010-09-24 15:28:28 +00:00
return $features ;
2017-11-30 23:11:00 +00:00
}
2010-09-24 15:28:28 +00:00
}
2017-11-30 23:11:00 +00:00
if ( ! $feature_list ) {
2010-09-24 15:28:28 +00:00
return $features ;
2017-11-30 23:11:00 +00:00
}
2010-09-24 15:28:28 +00:00
2014-05-05 08:26:24 +00:00
set_site_transient ( 'wporg_theme_feature_list' , $feature_list , 3 * HOUR_IN_SECONDS );
2010-09-24 15:28:28 +00:00
2014-01-05 17:16:11 +00:00
$category_translations = array (
'Layout' => __ ( 'Layout' ),
'Features' => __ ( 'Features' ),
2016-07-04 10:01:28 +00:00
'Subject' => __ ( 'Subject' ),
2014-01-05 17:16:11 +00:00
);
2010-09-24 15:28:28 +00:00
// Loop over the wporg canonical list and apply translations
$wporg_features = array ();
foreach ( ( array ) $feature_list as $feature_category => $feature_items ) {
2017-11-30 23:11:00 +00:00
if ( isset ( $category_translations [ $feature_category ] ) ) {
$feature_category = $category_translations [ $feature_category ];
}
$wporg_features [ $feature_category ] = array ();
2010-09-24 15:28:28 +00:00
foreach ( $feature_items as $feature ) {
2017-11-30 23:11:00 +00:00
if ( isset ( $features [ $feature_category ][ $feature ] ) ) {
$wporg_features [ $feature_category ][ $feature ] = $features [ $feature_category ][ $feature ];
} else {
$wporg_features [ $feature_category ][ $feature ] = $feature ;
}
2010-09-24 15:28:28 +00:00
}
}
return $wporg_features ;
}
2010-10-05 13:24:41 +00:00
/**
2015-09-27 21:52:25 +00:00
* Retrieves theme installer pages from the WordPress.org Themes API.
2010-10-05 13:24:41 +00:00
*
* It is possible for a theme to override the Themes API result with three
2016-07-04 22:45:29 +00:00
* filters. Assume this is for themes, which can extend on the Theme Info to
2010-10-05 13:24:41 +00:00
* offer more choices. This is very powerful and must be used with care, when
2014-08-13 03:56:17 +00:00
* overriding the filters.
2010-10-05 13:24:41 +00:00
*
2015-09-27 21:52:25 +00:00
* 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.
2010-10-05 13:24:41 +00:00
*
2015-09-27 22:45:25 +00:00
* The second filter, {@see 'themes_api'}, allows a plugin to override the WordPress.org
2015-09-27 22:47:25 +00:00
* Theme API entirely. If `$action` is 'query_themes', 'theme_information', or 'feature_list',
2016-07-09 14:39:33 +00:00
* an object MUST be passed. If `$action` is 'hot_tags', an array should be passed.
2015-09-27 22:45:25 +00:00
*
* Finally, the third filter, {@see 'themes_api_result'}, makes it possible to filter the
* response object or array, depending on the `$action` type.
2015-09-27 21:52:25 +00:00
*
* Supported arguments per action:
*
2015-09-27 22:47:25 +00:00
* | Argument Name | 'query_themes' | 'theme_information' | 'hot_tags' | 'feature_list' |
2015-09-27 22:49:24 +00:00
* | -------------------| :------------: | :-----------------: | :--------: | :--------------: |
* | `$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 |
2010-10-05 13:24:41 +00:00
*
* @since 2.8.0
*
2015-09-27 21:52:25 +00:00
* @param string $action API action to perform: 'query_themes', 'theme_information',
* 'hot_tags' or 'feature_list'.
* @param array|object $args {
2016-09-19 16:46:30 +00:00
* Optional. Array or object of arguments to serialize for the Themes API.
2015-09-27 21:52:25 +00:00
*
2016-09-19 16:46:30 +00:00
* @type string $slug The theme slug. Default empty.
2015-09-27 21:52:25 +00:00
* @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`.
2010-10-05 13:24:41 +00:00
*/
2015-09-27 21:52:25 +00:00
function themes_api ( $action , $args = array () ) {
2018-02-01 05:19:30 +00:00
// include an unmodified $wp_version
include ( ABSPATH . WPINC . '/version.php' );
2010-10-05 13:24:41 +00:00
2014-12-16 22:39:22 +00:00
if ( is_array ( $args ) ) {
$args = ( object ) $args ;
}
2010-10-05 13:24:41 +00:00
2018-02-01 05:19:30 +00:00
if ( 'query_themes' == $action ) {
if ( ! isset ( $args -> per_page ) ) {
$args -> per_page = 24 ;
}
2014-12-16 22:39:22 +00:00
}
if ( ! isset ( $args -> locale ) ) {
2016-10-03 07:04:29 +00:00
$args -> locale = get_user_locale ();
2014-12-16 22:39:22 +00:00
}
2018-02-01 05:19:30 +00:00
if ( ! isset ( $args -> wp_version ) ) {
$args -> wp_version = substr ( $wp_version , 0 , 3 ); // X.y
}
2013-10-30 14:39:10 +00:00
/**
2016-05-22 18:01:30 +00:00
* Filters arguments used to query for installer pages from the WordPress.org Themes API.
2013-10-30 14:39:10 +00:00
*
* Important: An object MUST be returned to this filter.
2013-12-04 20:03:09 +00:00
*
2013-10-30 14:39:10 +00:00
* @since 2.8.0
2013-12-04 20:03:09 +00:00
*
2013-10-30 14:39:10 +00:00
* @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'.
2014-12-16 22:39:22 +00:00
*/
2013-10-30 14:39:10 +00:00
$args = apply_filters ( 'themes_api_args' , $args , $action );
2013-12-11 19:49:11 +00:00
2013-10-30 14:39:10 +00:00
/**
2016-05-22 18:01:30 +00:00
* Filters whether to override the WordPress.org Themes API.
2013-10-30 14:39:10 +00:00
*
2015-09-27 23:01:24 +00:00
* 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
2016-07-09 14:39:33 +00:00
* be passed. If `$action` is 'hot_tags', an array should be passed.
2013-12-04 20:03:09 +00:00
*
2013-10-30 14:39:10 +00:00
* @since 2.8.0
*
2015-09-27 23:01:24 +00:00
* @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.
2013-10-30 14:39:10 +00:00
*/
$res = apply_filters ( 'themes_api' , false , $action , $args );
2010-10-05 13:24:41 +00:00
if ( ! $res ) {
2018-02-01 05:19:30 +00:00
$url = 'http://api.wordpress.org/themes/info/1.2/' ;
$url = add_query_arg (
array (
'action' => $action ,
'request' => $args ,
),
$url
);
2017-09-27 08:00:49 +00:00
2018-02-01 05:19:30 +00:00
$http_url = $url ;
2017-11-30 23:11:00 +00:00
if ( $ssl = wp_http_supports ( array ( 'ssl' ) ) ) {
2013-09-09 07:54:11 +00:00
$url = set_url_scheme ( $url , 'https' );
2017-11-30 23:11:00 +00:00
}
2013-09-09 07:54:11 +00:00
2015-02-07 06:21:22 +00:00
$http_args = array (
2017-09-27 08:00:49 +00:00
'user-agent' => 'WordPress/' . $wp_version . '; ' . home_url ( '/' ),
2013-10-27 21:09:10 +00:00
);
2018-02-01 05:19:30 +00:00
$request = wp_remote_get ( $url , $http_args );
2013-10-27 21:09:10 +00:00
if ( $ssl && is_wp_error ( $request ) ) {
2016-08-23 14:33:30 +00:00
if ( ! wp_doing_ajax () ) {
2016-11-21 01:52:32 +00:00
trigger_error (
sprintf (
/* translators: %s: support forums URL */
__ ( '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 <a href="%s">support forums</a>.' ),
__ ( 'https://wordpress.org/support/' )
) . ' ' . __ ( '(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
);
2014-04-15 01:16:14 +00:00
}
2018-02-01 05:19:30 +00:00
$request = wp_remote_get ( $http_url , $http_args );
2013-10-27 21:09:10 +00:00
}
2013-09-09 07:54:11 +00:00
2017-11-30 23:11:00 +00:00
if ( is_wp_error ( $request ) ) {
$res = new WP_Error (
'themes_api_failed' ,
2016-11-21 01:52:32 +00:00
sprintf (
/* translators: %s: support forums URL */
__ ( '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 <a href="%s">support forums</a>.' ),
__ ( 'https://wordpress.org/support/' )
),
$request -> get_error_message ()
);
2010-10-05 13:24:41 +00:00
} else {
2018-02-01 05:19:30 +00:00
$res = json_decode ( wp_remote_retrieve_body ( $request ), true );
if ( is_array ( $res ) ) {
// Object casting is required in order to match the info/1.0 format.
$res = ( object ) $res ;
} elseif ( null === $res ) {
2017-11-30 23:11:00 +00:00
$res = new WP_Error (
'themes_api_failed' ,
2016-11-21 01:52:32 +00:00
sprintf (
/* translators: %s: support forums URL */
__ ( '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 <a href="%s">support forums</a>.' ),
__ ( 'https://wordpress.org/support/' )
),
wp_remote_retrieve_body ( $request )
);
}
2018-02-01 05:19:30 +00:00
if ( isset ( $res -> error ) ) {
$res = new WP_Error ( 'themes_api_failed' , $res -> error );
}
}
// Back-compat for info/1.2 API, upgrade the theme objects in query_themes to objects.
if ( 'query_themes' == $action ) {
foreach ( $res -> themes as $i => $theme ) {
$res -> themes [ $i ] = ( object ) $theme ;
}
}
// Back-compat for info/1.2 API, downgrade the feature_list result back to an array.
if ( 'feature_list' == $action ) {
$res = ( array ) $res ;
2010-10-05 13:24:41 +00:00
}
}
2012-01-08 03:48:05 +00:00
2013-10-30 14:39:10 +00:00
/**
2016-05-22 18:01:30 +00:00
* Filters the returned WordPress.org Themes API response.
2013-10-30 14:39:10 +00:00
*
* @since 2.8.0
*
2016-04-15 01:43:28 +00:00
* @param array|object|WP_Error $res WordPress.org Themes API response.
* @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 WordPress.org Themes API.
2013-10-30 14:39:10 +00:00
*/
return apply_filters ( 'themes_api_result' , $res , $action , $args );
2010-10-05 13:24:41 +00:00
}
2013-11-13 20:58:05 +00:00
/**
* Prepare themes for JavaScript.
*
* @since 3.8.0
*
2018-03-25 18:10:32 +00:00
* @param WP_Theme[] $themes Optional. Array of theme objects to prepare.
* Defaults to all allowed themes.
2013-11-13 20:58:05 +00:00
*
2013-11-15 16:42:10 +00:00
* @return array An associative array of theme data, sorted by name.
2013-11-13 20:58:05 +00:00
*/
function wp_prepare_themes_for_js ( $themes = null ) {
2013-12-02 18:46:11 +00:00
$current_theme = get_stylesheet ();
2015-03-31 20:04:25 +00:00
/**
2016-05-22 18:01:30 +00:00
* Filters theme data before it is prepared for JavaScript.
2015-03-31 20:04:25 +00:00
*
2018-04-29 21:47:22 +00:00
* Passing a non-empty array will result in wp_prepare_themes_for_js() returning
2015-03-31 20:04:25 +00:00
* early with that value instead.
*
* @since 4.2.0
*
2018-03-25 18:10:32 +00:00
* @param array $prepared_themes An associative array of theme data. Default empty array.
* @param WP_Theme[]|null $themes An array of theme objects to prepare, if any.
* @param string $current_theme The current theme slug.
2015-03-31 20:04:25 +00:00
*/
2015-04-21 14:23:27 +00:00
$prepared_themes = ( array ) apply_filters ( 'pre_prepare_themes_for_js' , array (), $themes , $current_theme );
2015-03-31 20:04:25 +00:00
if ( ! empty ( $prepared_themes ) ) {
return $prepared_themes ;
}
2013-12-06 16:11:10 +00:00
// Make sure the current theme is listed first.
2015-03-31 20:04:25 +00:00
$prepared_themes [ $current_theme ] = array ();
2013-12-06 16:11:10 +00:00
2013-11-13 20:58:05 +00:00
if ( null === $themes ) {
$themes = wp_get_themes ( array ( 'allowed' => true ) );
2013-12-02 18:46:11 +00:00
if ( ! isset ( $themes [ $current_theme ] ) ) {
$themes [ $current_theme ] = wp_get_theme ();
}
2013-11-13 20:58:05 +00:00
}
$updates = array ();
if ( current_user_can ( 'update_themes' ) ) {
2013-11-20 01:40:09 +00:00
$updates_transient = get_site_transient ( 'update_themes' );
if ( isset ( $updates_transient -> response ) ) {
$updates = $updates_transient -> response ;
}
2013-11-13 20:58:05 +00:00
}
2013-11-15 16:42:10 +00:00
WP_Theme :: sort_by_name ( $themes );
2014-12-20 22:47:22 +00:00
$parents = array ();
2013-11-29 08:38:09 +00:00
foreach ( $themes as $theme ) {
2017-11-30 23:11:00 +00:00
$slug = $theme -> get_stylesheet ();
2014-12-02 02:21:24 +00:00
$encoded_slug = urlencode ( $slug );
2013-11-13 20:58:05 +00:00
$parent = false ;
if ( $theme -> parent () ) {
2017-11-30 23:11:00 +00:00
$parent = $theme -> parent ();
2017-09-29 20:13:50 +00:00
$parents [ $slug ] = $parent -> get_stylesheet ();
2017-11-30 23:11:00 +00:00
$parent = $parent -> display ( 'Name' );
2013-11-13 20:58:05 +00:00
}
2015-11-01 06:40:28 +00:00
$customize_action = null ;
if ( current_user_can ( 'edit_theme_options' ) && current_user_can ( 'customize' ) ) {
2017-11-30 23:11:00 +00:00
$customize_action = esc_url (
add_query_arg (
array (
'return' => urlencode ( esc_url_raw ( remove_query_arg ( wp_removable_query_args (), wp_unslash ( $_SERVER [ 'REQUEST_URI' ] ) ) ) ),
),
wp_customize_url ( $slug )
)
);
2015-11-01 06:40:28 +00:00
}
2013-12-06 16:11:10 +00:00
$prepared_themes [ $slug ] = array (
2013-11-13 20:58:05 +00:00
'id' => $slug ,
'name' => $theme -> display ( 'Name' ),
'screenshot' => array ( $theme -> get_screenshot () ), // @todo multiple
'description' => $theme -> display ( 'Description' ),
2013-12-05 19:08:10 +00:00
'author' => $theme -> display ( 'Author' , false , true ),
'authorAndUri' => $theme -> display ( 'Author' ),
2013-11-22 02:34:10 +00:00
'version' => $theme -> display ( 'Version' ),
'tags' => $theme -> display ( 'Tags' ),
2013-11-13 20:58:05 +00:00
'parent' => $parent ,
'active' => $slug === $current_theme ,
'hasUpdate' => isset ( $updates [ $slug ] ),
2017-11-30 23:11:00 +00:00
'hasPackage' => isset ( $updates [ $slug ] ) && ! empty ( $updates [ $slug ][ 'package' ] ),
2013-11-20 02:57:10 +00:00
'update' => get_theme_update_available ( $theme ),
2013-11-13 20:58:05 +00:00
'actions' => array (
2017-11-30 23:11:00 +00:00
'activate' => current_user_can ( 'switch_themes' ) ? wp_nonce_url ( admin_url ( 'themes.php?action=activate&stylesheet=' . $encoded_slug ), 'switch-theme_' . $slug ) : null ,
2015-11-01 06:40:28 +00:00
'customize' => $customize_action ,
2017-11-30 23:11:00 +00:00
'delete' => current_user_can ( 'delete_themes' ) ? wp_nonce_url ( admin_url ( 'themes.php?action=delete&stylesheet=' . $encoded_slug ), 'delete-theme_' . $slug ) : null ,
2013-11-13 20:58:05 +00:00
),
);
}
2014-12-02 02:21:24 +00:00
// Remove 'delete' action if theme has an active child
2014-12-20 22:47:22 +00:00
if ( ! empty ( $parents ) && array_key_exists ( $current_theme , $parents ) ) {
2014-12-02 02:21:24 +00:00
unset ( $prepared_themes [ $parents [ $current_theme ] ][ 'actions' ][ 'delete' ] );
}
2013-12-04 19:21:10 +00:00
/**
2016-05-22 18:01:30 +00:00
* Filters the themes prepared for JavaScript, for themes.php.
2013-12-04 19:21:10 +00:00
*
* Could be useful for changing the order, which is by name by default.
*
* @since 3.8.0
*
* @param array $prepared_themes Array of themes.
*/
2013-12-06 16:11:10 +00:00
$prepared_themes = apply_filters ( 'wp_prepare_themes_for_js' , $prepared_themes );
2015-04-22 16:11:25 +00:00
$prepared_themes = array_values ( $prepared_themes );
return array_filter ( $prepared_themes );
2014-04-15 01:16:14 +00:00
}
2015-02-24 20:31:24 +00:00
/**
* Print JS templates for the theme-browsing UI in the Customizer.
*
* @since 4.2.0
*/
function customize_themes_print_templates () {
?>
<script type="text/html" id="tmpl-customize-themes-details-view">
<div class="theme-backdrop"></div>
2017-10-01 13:48:46 +00:00
<div class="theme-wrap wp-clearfix" role="document">
2015-02-24 20:31:24 +00:00
<div class="theme-header">
<button type="button" class="left dashicons dashicons-no"><span class="screen-reader-text"><?php _e( 'Show previous theme' ); ?></span></button>
<button type="button" class="right dashicons dashicons-no"><span class="screen-reader-text"><?php _e( 'Show next theme' ); ?></span></button>
<button type="button" class="close dashicons dashicons-no"><span class="screen-reader-text"><?php _e( 'Close details dialog' ); ?></span></button>
</div>
2016-01-30 13:46:27 +00:00
<div class="theme-about wp-clearfix">
2015-02-24 20:31:24 +00:00
<div class="theme-screenshots">
2017-09-29 20:13:50 +00:00
<# if ( data.screenshot && data.screenshot[0] ) { #>
2015-02-24 20:31:24 +00:00
<div class="screenshot"><img src="{{ data.screenshot[0] }}" alt="" /></div>
<# } else { #>
<div class="screenshot blank"></div>
<# } #>
</div>
<div class="theme-info">
<# if ( data.active ) { #>
<span class="current-label"><?php _e( 'Current Theme' ); ?></span>
<# } #>
2015-08-31 03:51:21 +00:00
<h2 class="theme-name">{{{ data.name }}}<span class="theme-version"><?php printf( __( 'Version: %s' ), '{{ data.version }}' ); ?></span></h2>
<h3 class="theme-author"><?php printf( __( 'By %s' ), '{{{ data.authorAndUri }}}' ); ?></h3>
2017-09-29 20:13:50 +00:00
<# if ( data.stars && 0 != data.num_ratings ) { #>
<div class="theme-rating">
{{{ data.stars }}}
<span class="num-ratings">
<?php
2017-10-24 22:47:46 +00:00
/* translators: %s: number of ratings */
2017-09-29 20:13:50 +00:00
echo sprintf( __( '(%s ratings)' ), '{{ data.num_ratings }}' );
?>
</span>
</div>
<# } #>
<# if ( data.hasUpdate ) { #>
<div class="notice notice-warning notice-alt notice-large" data-slug="{{ data.id }}">
<h3 class="notice-title"><?php _e( 'Update Available' ); ?></h3>
{{{ data.update }}}
</div>
<# } #>
2015-02-24 20:31:24 +00:00
<# if ( data.parent ) { #>
<p class="parent-theme"><?php printf( __( 'This is a child theme of %s.' ), '<strong>{{{ data.parent }}}</strong>' ); ?></p>
<# } #>
2016-11-04 17:18:26 +00:00
2017-09-29 20:13:50 +00:00
<p class="theme-description">{{{ data.description }}}</p>
2015-02-24 20:31:24 +00:00
<# if ( data.tags ) { #>
2017-09-29 20:13:50 +00:00
<p class="theme-tags"><span><?php _e( 'Tags:' ); ?></span> {{{ data.tags }}}</p>
2015-02-24 20:31:24 +00:00
<# } #>
</div>
</div>
2017-09-29 20:13:50 +00:00
<div class="theme-actions">
<# if ( data.active ) { #>
2018-02-13 22:15:32 +00:00
<button type="button" class="button button-primary customize-theme"><?php _e( 'Customize' ); ?></button>
2017-09-29 20:13:50 +00:00
<# } else if ( 'installed' === data.type ) { #>
<?php if ( current_user_can( 'delete_themes' ) ) { ?>
<# if ( data.actions && data.actions['delete'] ) { #>
<a href="{{{ data.actions['delete'] }}}" data-slug="{{ data.id }}" class="button button-secondary delete-theme"><?php _e( 'Delete' ); ?></a>
<# } #>
<?php } ?>
2018-02-13 22:15:32 +00:00
<button type="button" class="button button-primary preview-theme" data-slug="{{ data.id }}"><?php _e( 'Live Preview' ); ?></button>
2017-09-29 20:13:50 +00:00
<# } else { #>
<button type="button" class="button theme-install" data-slug="{{ data.id }}"><?php _e( 'Install' ); ?></button>
<button type="button" class="button button-primary theme-install preview" data-slug="{{ data.id }}"><?php _e( 'Install & Preview' ); ?></button>
<# } #>
</div>
2015-02-24 20:31:24 +00:00
</div>
</script>
<?php
}