[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

/wp-admin/includes/ -> theme.php (source)

   1  <?php
   2  /**
   3   * WordPress Theme Administration API
   4   *
   5   * @package WordPress
   6   * @subpackage Administration
   7   */
   8  
   9  /**
  10   * Remove a theme
  11   *
  12   * @since 2.8.0
  13   *
  14   * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
  15   *
  16   * @param string $stylesheet Stylesheet of the theme to delete.
  17   * @param string $redirect   Redirect to page when complete.
  18   * @return bool|null|WP_Error True on success, false if `$stylesheet` is empty, WP_Error on failure.
  19   *                            Null if filesystem credentials are required to proceed.
  20   */
  21  function delete_theme( $stylesheet, $redirect = '' ) {
  22      global $wp_filesystem;
  23  
  24      if ( empty( $stylesheet ) ) {
  25          return false;
  26      }
  27  
  28      if ( empty( $redirect ) ) {
  29          $redirect = wp_nonce_url( 'themes.php?action=delete&stylesheet=' . urlencode( $stylesheet ), 'delete-theme_' . $stylesheet );
  30      }
  31  
  32      ob_start();
  33      $credentials = request_filesystem_credentials( $redirect );
  34      $data        = ob_get_clean();
  35  
  36      if ( false === $credentials ) {
  37          if ( ! empty( $data ) ) {
  38              require_once ABSPATH . 'wp-admin/admin-header.php';
  39              echo $data;
  40              require_once ABSPATH . 'wp-admin/admin-footer.php';
  41              exit;
  42          }
  43          return;
  44      }
  45  
  46      if ( ! WP_Filesystem( $credentials ) ) {
  47          ob_start();
  48          // Failed to connect. Error and request again.
  49          request_filesystem_credentials( $redirect, '', true );
  50          $data = ob_get_clean();
  51  
  52          if ( ! empty( $data ) ) {
  53              require_once ABSPATH . 'wp-admin/admin-header.php';
  54              echo $data;
  55              require_once ABSPATH . 'wp-admin/admin-footer.php';
  56              exit;
  57          }
  58          return;
  59      }
  60  
  61      if ( ! is_object( $wp_filesystem ) ) {
  62          return new WP_Error( 'fs_unavailable', __( 'Could not access filesystem.' ) );
  63      }
  64  
  65      if ( is_wp_error( $wp_filesystem->errors ) && $wp_filesystem->errors->has_errors() ) {
  66          return new WP_Error( 'fs_error', __( 'Filesystem error.' ), $wp_filesystem->errors );
  67      }
  68  
  69      // Get the base plugin folder.
  70      $themes_dir = $wp_filesystem->wp_themes_dir();
  71      if ( empty( $themes_dir ) ) {
  72          return new WP_Error( 'fs_no_themes_dir', __( 'Unable to locate WordPress theme directory.' ) );
  73      }
  74  
  75      $themes_dir = trailingslashit( $themes_dir );
  76      $theme_dir  = trailingslashit( $themes_dir . $stylesheet );
  77      $deleted    = $wp_filesystem->delete( $theme_dir, true );
  78  
  79      if ( ! $deleted ) {
  80          return new WP_Error(
  81              'could_not_remove_theme',
  82              /* translators: %s: Theme name. */
  83              sprintf( __( 'Could not fully remove the theme %s.' ), $stylesheet )
  84          );
  85      }
  86  
  87      $theme_translations = wp_get_installed_translations( 'themes' );
  88  
  89      // Remove language files, silently.
  90      if ( ! empty( $theme_translations[ $stylesheet ] ) ) {
  91          $translations = $theme_translations[ $stylesheet ];
  92  
  93          foreach ( $translations as $translation => $data ) {
  94              $wp_filesystem->delete( WP_LANG_DIR . '/themes/' . $stylesheet . '-' . $translation . '.po' );
  95              $wp_filesystem->delete( WP_LANG_DIR . '/themes/' . $stylesheet . '-' . $translation . '.mo' );
  96  
  97              $json_translation_files = glob( WP_LANG_DIR . '/themes/' . $stylesheet . '-' . $translation . '-*.json' );
  98              if ( $json_translation_files ) {
  99                  array_map( array( $wp_filesystem, 'delete' ), $json_translation_files );
 100              }
 101          }
 102      }
 103  
 104      // Remove the theme from allowed themes on the network.
 105      if ( is_multisite() ) {
 106          WP_Theme::network_disable_theme( $stylesheet );
 107      }
 108  
 109      // Force refresh of theme update information.
 110      delete_site_transient( 'update_themes' );
 111  
 112      return true;
 113  }
 114  
 115  /**
 116   * Gets the page templates available in this theme.
 117   *
 118   * @since 1.5.0
 119   * @since 4.7.0 Added the `$post_type` parameter.
 120   *
 121   * @param WP_Post|null $post      Optional. The post being edited, provided for context.
 122   * @param string       $post_type Optional. Post type to get the templates for. Default 'page'.
 123   * @return string[] Array of template file names keyed by the template header name.
 124   */
 125  function get_page_templates( $post = null, $post_type = 'page' ) {
 126      return array_flip( wp_get_theme()->get_page_templates( $post, $post_type ) );
 127  }
 128  
 129  /**
 130   * Tidies a filename for url display by the theme editor.
 131   *
 132   * @since 2.9.0
 133   * @access private
 134   *
 135   * @param string $fullpath Full path to the theme file
 136   * @param string $containingfolder Path of the theme parent folder
 137   * @return string
 138   */
 139  function _get_template_edit_filename( $fullpath, $containingfolder ) {
 140      return str_replace( dirname( dirname( $containingfolder ) ), '', $fullpath );
 141  }
 142  
 143  /**
 144   * Check if there is an update for a theme available.
 145   *
 146   * Will display link, if there is an update available.
 147   *
 148   * @since 2.7.0
 149   *
 150   * @see get_theme_update_available()
 151   *
 152   * @param WP_Theme $theme Theme data object.
 153   */
 154  function theme_update_available( $theme ) {
 155      echo get_theme_update_available( $theme );
 156  }
 157  
 158  /**
 159   * Retrieve the update link if there is a theme update available.
 160   *
 161   * Will return a link if there is an update available.
 162   *
 163   * @since 3.8.0
 164   *
 165   * @param WP_Theme $theme WP_Theme object.
 166   * @return string|false HTML for the update link, or false if invalid info was passed.
 167   */
 168  function get_theme_update_available( $theme ) {
 169      static $themes_update = null;
 170  
 171      if ( ! current_user_can( 'update_themes' ) ) {
 172          return false;
 173      }
 174  
 175      if ( ! isset( $themes_update ) ) {
 176          $themes_update = get_site_transient( 'update_themes' );
 177      }
 178  
 179      if ( ! ( $theme instanceof WP_Theme ) ) {
 180          return false;
 181      }
 182  
 183      $stylesheet = $theme->get_stylesheet();
 184  
 185      $html = '';
 186  
 187      if ( isset( $themes_update->response[ $stylesheet ] ) ) {
 188          $update      = $themes_update->response[ $stylesheet ];
 189          $theme_name  = $theme->display( 'Name' );
 190          $details_url = add_query_arg(
 191              array(
 192                  'TB_iframe' => 'true',
 193                  'width'     => 1024,
 194                  'height'    => 800,
 195              ),
 196              $update['url']
 197          ); // Theme browser inside WP? Replace this. Also, theme preview JS will override this on the available list.
 198          $update_url  = wp_nonce_url( admin_url( 'update.php?action=upgrade-theme&amp;theme=' . urlencode( $stylesheet ) ), 'upgrade-theme_' . $stylesheet );
 199  
 200          if ( ! is_multisite() ) {
 201              if ( ! current_user_can( 'update_themes' ) ) {
 202                  $html = sprintf(
 203                      /* translators: 1: Theme name, 2: Theme details URL, 3: Additional link attributes, 4: Version number. */
 204                      '<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>',
 205                      $theme_name,
 206                      esc_url( $details_url ),
 207                      sprintf(
 208                          'class="thickbox open-plugin-details-modal" aria-label="%s"',
 209                          /* translators: 1: Theme name, 2: Version number. */
 210                          esc_attr( sprintf( __( 'View %1$s version %2$s details' ), $theme_name, $update['new_version'] ) )
 211                      ),
 212                      $update['new_version']
 213                  );
 214              } elseif ( empty( $update['package'] ) ) {
 215                  $html = sprintf(
 216                      /* translators: 1: Theme name, 2: Theme details URL, 3: Additional link attributes, 4: Version number. */
 217                      '<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>',
 218                      $theme_name,
 219                      esc_url( $details_url ),
 220                      sprintf(
 221                          'class="thickbox open-plugin-details-modal" aria-label="%s"',
 222                          /* translators: 1: Theme name, 2: Version number. */
 223                          esc_attr( sprintf( __( 'View %1$s version %2$s details' ), $theme_name, $update['new_version'] ) )
 224                      ),
 225                      $update['new_version']
 226                  );
 227              } else {
 228                  $html = sprintf(
 229                      /* translators: 1: Theme name, 2: Theme details URL, 3: Additional link attributes, 4: Version number, 5: Update URL, 6: Additional link attributes. */
 230                      '<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>',
 231                      $theme_name,
 232                      esc_url( $details_url ),
 233                      sprintf(
 234                          'class="thickbox open-plugin-details-modal" aria-label="%s"',
 235                          /* translators: 1: Theme name, 2: Version number. */
 236                          esc_attr( sprintf( __( 'View %1$s version %2$s details' ), $theme_name, $update['new_version'] ) )
 237                      ),
 238                      $update['new_version'],
 239                      $update_url,
 240                      sprintf(
 241                          'aria-label="%s" id="update-theme" data-slug="%s"',
 242                          /* translators: %s: Theme name. */
 243                          esc_attr( sprintf( __( 'Update %s now' ), $theme_name ) ),
 244                          $stylesheet
 245                      )
 246                  );
 247              }
 248          }
 249      }
 250  
 251      return $html;
 252  }
 253  
 254  /**
 255   * Retrieve list of WordPress theme features (aka theme tags).
 256   *
 257   * @since 3.1.0
 258   * @since 3.2.0 Added 'Gray' color and 'Featured Image Header', 'Featured Images',
 259   *              'Full Width Template', and 'Post Formats' features.
 260   * @since 3.5.0 Added 'Flexible Header' feature.
 261   * @since 3.8.0 Renamed 'Width' filter to 'Layout'.
 262   * @since 3.8.0 Renamed 'Fixed Width' and 'Flexible Width' options
 263   *              to 'Fixed Layout' and 'Fluid Layout'.
 264   * @since 3.8.0 Added 'Accessibility Ready' feature and 'Responsive Layout' option.
 265   * @since 3.9.0 Combined 'Layout' and 'Columns' filters.
 266   * @since 4.6.0 Removed 'Colors' filter.
 267   * @since 4.6.0 Added 'Grid Layout' option.
 268   *              Removed 'Fixed Layout', 'Fluid Layout', and 'Responsive Layout' options.
 269   * @since 4.6.0 Added 'Custom Logo' and 'Footer Widgets' features.
 270   *              Removed 'Blavatar' feature.
 271   * @since 4.6.0 Added 'Blog', 'E-Commerce', 'Education', 'Entertainment', 'Food & Drink',
 272   *              'Holiday', 'News', 'Photography', and 'Portfolio' subjects.
 273   *              Removed 'Photoblogging' and 'Seasonal' subjects.
 274   * @since 4.9.0 Reordered the filters from 'Layout', 'Features', 'Subject'
 275   *              to 'Subject', 'Features', 'Layout'.
 276   * @since 4.9.0 Removed 'BuddyPress', 'Custom Menu', 'Flexible Header',
 277   *              'Front Page Posting', 'Microformats', 'RTL Language Support',
 278   *              'Threaded Comments', and 'Translation Ready' features.
 279   * @since 5.5.0 Added 'Block Editor Patterns', 'Block Editor Styles',
 280   *              and 'Full Site Editing' features.
 281   * @since 5.5.0 Added 'Wide Blocks' layout option.
 282   *
 283   * @param bool $api Optional. Whether try to fetch tags from the WordPress.org API. Defaults to true.
 284   * @return array Array of features keyed by category with translations keyed by slug.
 285   */
 286  function get_theme_feature_list( $api = true ) {
 287      // Hard-coded list is used if API is not accessible.
 288      $features = array(
 289  
 290          __( 'Subject' )  => array(
 291              'blog'           => __( 'Blog' ),
 292              'e-commerce'     => __( 'E-Commerce' ),
 293              'education'      => __( 'Education' ),
 294              'entertainment'  => __( 'Entertainment' ),
 295              'food-and-drink' => __( 'Food & Drink' ),
 296              'holiday'        => __( 'Holiday' ),
 297              'news'           => __( 'News' ),
 298              'photography'    => __( 'Photography' ),
 299              'portfolio'      => __( 'Portfolio' ),
 300          ),
 301  
 302          __( 'Features' ) => array(
 303              'accessibility-ready'   => __( 'Accessibility Ready' ),
 304              'block-patterns'        => __( 'Block Editor Patterns' ),
 305              'block-styles'          => __( 'Block Editor Styles' ),
 306              'custom-background'     => __( 'Custom Background' ),
 307              'custom-colors'         => __( 'Custom Colors' ),
 308              'custom-header'         => __( 'Custom Header' ),
 309              'custom-logo'           => __( 'Custom Logo' ),
 310              'editor-style'          => __( 'Editor Style' ),
 311              'featured-image-header' => __( 'Featured Image Header' ),
 312              'featured-images'       => __( 'Featured Images' ),
 313              'footer-widgets'        => __( 'Footer Widgets' ),
 314              'full-site-editing'     => __( 'Full Site Editing' ),
 315              'full-width-template'   => __( 'Full Width Template' ),
 316              'post-formats'          => __( 'Post Formats' ),
 317              'sticky-post'           => __( 'Sticky Post' ),
 318              'theme-options'         => __( 'Theme Options' ),
 319          ),
 320  
 321          __( 'Layout' )   => array(
 322              'grid-layout'   => __( 'Grid Layout' ),
 323              'one-column'    => __( 'One Column' ),
 324              'two-columns'   => __( 'Two Columns' ),
 325              'three-columns' => __( 'Three Columns' ),
 326              'four-columns'  => __( 'Four Columns' ),
 327              'left-sidebar'  => __( 'Left Sidebar' ),
 328              'right-sidebar' => __( 'Right Sidebar' ),
 329              'wide-blocks'   => __( 'Wide Blocks' ),
 330          ),
 331  
 332      );
 333  
 334      if ( ! $api || ! current_user_can( 'install_themes' ) ) {
 335          return $features;
 336      }
 337  
 338      $feature_list = get_site_transient( 'wporg_theme_feature_list' );
 339      if ( ! $feature_list ) {
 340          set_site_transient( 'wporg_theme_feature_list', array(), 3 * HOUR_IN_SECONDS );
 341      }
 342  
 343      if ( ! $feature_list ) {
 344          $feature_list = themes_api( 'feature_list', array() );
 345          if ( is_wp_error( $feature_list ) ) {
 346              return $features;
 347          }
 348      }
 349  
 350      if ( ! $feature_list ) {
 351          return $features;
 352      }
 353  
 354      set_site_transient( 'wporg_theme_feature_list', $feature_list, 3 * HOUR_IN_SECONDS );
 355  
 356      $category_translations = array(
 357          'Layout'   => __( 'Layout' ),
 358          'Features' => __( 'Features' ),
 359          'Subject'  => __( 'Subject' ),
 360      );
 361  
 362      $wporg_features = array();
 363  
 364      // Loop over the wp.org canonical list and apply translations.
 365      foreach ( (array) $feature_list as $feature_category => $feature_items ) {
 366          if ( isset( $category_translations[ $feature_category ] ) ) {
 367              $feature_category = $category_translations[ $feature_category ];
 368          }
 369  
 370          $wporg_features[ $feature_category ] = array();
 371  
 372          foreach ( $feature_items as $feature ) {
 373              if ( isset( $features[ $feature_category ][ $feature ] ) ) {
 374                  $wporg_features[ $feature_category ][ $feature ] = $features[ $feature_category ][ $feature ];
 375              } else {
 376                  $wporg_features[ $feature_category ][ $feature ] = $feature;
 377              }
 378          }
 379      }
 380  
 381      return $wporg_features;
 382  }
 383  
 384  /**
 385   * Retrieves theme installer pages from the WordPress.org Themes API.
 386   *
 387   * It is possible for a theme to override the Themes API result with three
 388   * filters. Assume this is for themes, which can extend on the Theme Info to
 389   * offer more choices. This is very powerful and must be used with care, when
 390   * overriding the filters.
 391   *
 392   * The first filter, {@see 'themes_api_args'}, is for the args and gives the action
 393   * as the second parameter. The hook for {@see 'themes_api_args'} must ensure that
 394   * an object is returned.
 395   *
 396   * The second filter, {@see 'themes_api'}, allows a plugin to override the WordPress.org
 397   * Theme API entirely. If `$action` is 'query_themes', 'theme_information', or 'feature_list',
 398   * an object MUST be passed. If `$action` is 'hot_tags', an array should be passed.
 399   *
 400   * Finally, the third filter, {@see 'themes_api_result'}, makes it possible to filter the
 401   * response object or array, depending on the `$action` type.
 402   *
 403   * Supported arguments per action:
 404   *
 405   * | Argument Name      | 'query_themes' | 'theme_information' | 'hot_tags' | 'feature_list'   |
 406   * | -------------------| :------------: | :-----------------: | :--------: | :--------------: |
 407   * | `$slug`            | No             |  Yes                | No         | No               |
 408   * | `$per_page`        | Yes            |  No                 | No         | No               |
 409   * | `$page`            | Yes            |  No                 | No         | No               |
 410   * | `$number`          | No             |  No                 | Yes        | No               |
 411   * | `$search`          | Yes            |  No                 | No         | No               |
 412   * | `$tag`             | Yes            |  No                 | No         | No               |
 413   * | `$author`          | Yes            |  No                 | No         | No               |
 414   * | `$user`            | Yes            |  No                 | No         | No               |
 415   * | `$browse`          | Yes            |  No                 | No         | No               |
 416   * | `$locale`          | Yes            |  Yes                | No         | No               |
 417   * | `$fields`          | Yes            |  Yes                | No         | No               |
 418   *
 419   * @since 2.8.0
 420   *
 421   * @param string       $action API action to perform: 'query_themes', 'theme_information',
 422   *                             'hot_tags' or 'feature_list'.
 423   * @param array|object $args   {
 424   *     Optional. Array or object of arguments to serialize for the Themes API.
 425   *
 426   *     @type string  $slug     The theme slug. Default empty.
 427   *     @type int     $per_page Number of themes per page. Default 24.
 428   *     @type int     $page     Number of current page. Default 1.
 429   *     @type int     $number   Number of tags to be queried.
 430   *     @type string  $search   A search term. Default empty.
 431   *     @type string  $tag      Tag to filter themes. Default empty.
 432   *     @type string  $author   Username of an author to filter themes. Default empty.
 433   *     @type string  $user     Username to query for their favorites. Default empty.
 434   *     @type string  $browse   Browse view: 'featured', 'popular', 'updated', 'favorites'.
 435   *     @type string  $locale   Locale to provide context-sensitive results. Default is the value of get_locale().
 436   *     @type array   $fields   {
 437   *         Array of fields which should or should not be returned.
 438   *
 439   *         @type bool $description        Whether to return the theme full description. Default false.
 440   *         @type bool $sections           Whether to return the theme readme sections: description, installation,
 441   *                                        FAQ, screenshots, other notes, and changelog. Default false.
 442   *         @type bool $rating             Whether to return the rating in percent and total number of ratings.
 443   *                                        Default false.
 444   *         @type bool $ratings            Whether to return the number of rating for each star (1-5). Default false.
 445   *         @type bool $downloaded         Whether to return the download count. Default false.
 446   *         @type bool $downloadlink       Whether to return the download link for the package. Default false.
 447   *         @type bool $last_updated       Whether to return the date of the last update. Default false.
 448   *         @type bool $tags               Whether to return the assigned tags. Default false.
 449   *         @type bool $homepage           Whether to return the theme homepage link. Default false.
 450   *         @type bool $screenshots        Whether to return the screenshots. Default false.
 451   *         @type int  $screenshot_count   Number of screenshots to return. Default 1.
 452   *         @type bool $screenshot_url     Whether to return the URL of the first screenshot. Default false.
 453   *         @type bool $photon_screenshots Whether to return the screenshots via Photon. Default false.
 454   *         @type bool $template           Whether to return the slug of the parent theme. Default false.
 455   *         @type bool $parent             Whether to return the slug, name and homepage of the parent theme. Default false.
 456   *         @type bool $versions           Whether to return the list of all available versions. Default false.
 457   *         @type bool $theme_url          Whether to return theme's URL. Default false.
 458   *         @type bool $extended_author    Whether to return nicename or nicename and display name. Default false.
 459   *     }
 460   * }
 461   * @return object|array|WP_Error Response object or array on success, WP_Error on failure. See the
 462   *         {@link https://developer.wordpress.org/reference/functions/themes_api/ function reference article}
 463   *         for more information on the make-up of possible return objects depending on the value of `$action`.
 464   */
 465  function themes_api( $action, $args = array() ) {
 466      // Include an unmodified $wp_version.
 467      require  ABSPATH . WPINC . '/version.php';
 468  
 469      if ( is_array( $args ) ) {
 470          $args = (object) $args;
 471      }
 472  
 473      if ( 'query_themes' === $action ) {
 474          if ( ! isset( $args->per_page ) ) {
 475              $args->per_page = 24;
 476          }
 477      }
 478  
 479      if ( ! isset( $args->locale ) ) {
 480          $args->locale = get_user_locale();
 481      }
 482  
 483      if ( ! isset( $args->wp_version ) ) {
 484          $args->wp_version = substr( $wp_version, 0, 3 ); // x.y
 485      }
 486  
 487      /**
 488       * Filters arguments used to query for installer pages from the WordPress.org Themes API.
 489       *
 490       * Important: An object MUST be returned to this filter.
 491       *
 492       * @since 2.8.0
 493       *
 494       * @param object $args   Arguments used to query for installer pages from the WordPress.org Themes API.
 495       * @param string $action Requested action. Likely values are 'theme_information',
 496       *                       'feature_list', or 'query_themes'.
 497       */
 498      $args = apply_filters( 'themes_api_args', $args, $action );
 499  
 500      /**
 501       * Filters whether to override the WordPress.org Themes API.
 502       *
 503       * Passing a non-false value will effectively short-circuit the WordPress.org API request.
 504       *
 505       * If `$action` is 'query_themes', 'theme_information', or 'feature_list', an object MUST
 506       * be passed. If `$action` is 'hot_tags', an array should be passed.
 507       *
 508       * @since 2.8.0
 509       *
 510       * @param false|object|array $override Whether to override the WordPress.org Themes API. Default false.
 511       * @param string             $action   Requested action. Likely values are 'theme_information',
 512       *                                    'feature_list', or 'query_themes'.
 513       * @param object             $args     Arguments used to query for installer pages from the Themes API.
 514       */
 515      $res = apply_filters( 'themes_api', false, $action, $args );
 516  
 517      if ( ! $res ) {
 518          $url = 'http://api.wordpress.org/themes/info/1.2/';
 519          $url = add_query_arg(
 520              array(
 521                  'action'  => $action,
 522                  'request' => $args,
 523              ),
 524              $url
 525          );
 526  
 527          $http_url = $url;
 528          $ssl      = wp_http_supports( array( 'ssl' ) );
 529          if ( $ssl ) {
 530              $url = set_url_scheme( $url, 'https' );
 531          }
 532  
 533          $http_args = array(
 534              'user-agent' => 'WordPress/' . $wp_version . '; ' . home_url( '/' ),
 535          );
 536          $request   = wp_remote_get( $url, $http_args );
 537  
 538          if ( $ssl && is_wp_error( $request ) ) {
 539              if ( ! wp_doing_ajax() ) {
 540                  trigger_error(
 541                      sprintf(
 542                          /* translators: %s: Support forums URL. */
 543                          __( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server&#8217;s configuration. If you continue to have problems, please try the <a href="%s">support forums</a>.' ),
 544                          __( 'https://wordpress.org/support/forums/' )
 545                      ) . ' ' . __( '(WordPress could not establish a secure connection to WordPress.org. Please contact your server administrator.)' ),
 546                      headers_sent() || WP_DEBUG ? E_USER_WARNING : E_USER_NOTICE
 547                  );
 548              }
 549              $request = wp_remote_get( $http_url, $http_args );
 550          }
 551  
 552          if ( is_wp_error( $request ) ) {
 553              $res = new WP_Error(
 554                  'themes_api_failed',
 555                  sprintf(
 556                      /* translators: %s: Support forums URL. */
 557                      __( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server&#8217;s configuration. If you continue to have problems, please try the <a href="%s">support forums</a>.' ),
 558                      __( 'https://wordpress.org/support/forums/' )
 559                  ),
 560                  $request->get_error_message()
 561              );
 562          } else {
 563              $res = json_decode( wp_remote_retrieve_body( $request ), true );
 564              if ( is_array( $res ) ) {
 565                  // Object casting is required in order to match the info/1.0 format.
 566                  $res = (object) $res;
 567              } elseif ( null === $res ) {
 568                  $res = new WP_Error(
 569                      'themes_api_failed',
 570                      sprintf(
 571                          /* translators: %s: Support forums URL. */
 572                          __( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server&#8217;s configuration. If you continue to have problems, please try the <a href="%s">support forums</a>.' ),
 573                          __( 'https://wordpress.org/support/forums/' )
 574                      ),
 575                      wp_remote_retrieve_body( $request )
 576                  );
 577              }
 578  
 579              if ( isset( $res->error ) ) {
 580                  $res = new WP_Error( 'themes_api_failed', $res->error );
 581              }
 582          }
 583  
 584          // Back-compat for info/1.2 API, upgrade the theme objects in query_themes to objects.
 585          if ( 'query_themes' === $action ) {
 586              foreach ( $res->themes as $i => $theme ) {
 587                  $res->themes[ $i ] = (object) $theme;
 588              }
 589          }
 590          // Back-compat for info/1.2 API, downgrade the feature_list result back to an array.
 591          if ( 'feature_list' === $action ) {
 592              $res = (array) $res;
 593          }
 594      }
 595  
 596      /**
 597       * Filters the returned WordPress.org Themes API response.
 598       *
 599       * @since 2.8.0
 600       *
 601       * @param array|object|WP_Error $res    WordPress.org Themes API response.
 602       * @param string                $action Requested action. Likely values are 'theme_information',
 603       *                                      'feature_list', or 'query_themes'.
 604       * @param object                $args   Arguments used to query for installer pages from the WordPress.org Themes API.
 605       */
 606      return apply_filters( 'themes_api_result', $res, $action, $args );
 607  }
 608  
 609  /**
 610   * Prepare themes for JavaScript.
 611   *
 612   * @since 3.8.0
 613   *
 614   * @param WP_Theme[] $themes Optional. Array of theme objects to prepare.
 615   *                           Defaults to all allowed themes.
 616   *
 617   * @return array An associative array of theme data, sorted by name.
 618   */
 619  function wp_prepare_themes_for_js( $themes = null ) {
 620      $current_theme = get_stylesheet();
 621  
 622      /**
 623       * Filters theme data before it is prepared for JavaScript.
 624       *
 625       * Passing a non-empty array will result in wp_prepare_themes_for_js() returning
 626       * early with that value instead.
 627       *
 628       * @since 4.2.0
 629       *
 630       * @param array           $prepared_themes An associative array of theme data. Default empty array.
 631       * @param WP_Theme[]|null $themes          An array of theme objects to prepare, if any.
 632       * @param string          $current_theme   The current theme slug.
 633       */
 634      $prepared_themes = (array) apply_filters( 'pre_prepare_themes_for_js', array(), $themes, $current_theme );
 635  
 636      if ( ! empty( $prepared_themes ) ) {
 637          return $prepared_themes;
 638      }
 639  
 640      // Make sure the current theme is listed first.
 641      $prepared_themes[ $current_theme ] = array();
 642  
 643      if ( null === $themes ) {
 644          $themes = wp_get_themes( array( 'allowed' => true ) );
 645          if ( ! isset( $themes[ $current_theme ] ) ) {
 646              $themes[ $current_theme ] = wp_get_theme();
 647          }
 648      }
 649  
 650      $updates = array();
 651      if ( current_user_can( 'update_themes' ) ) {
 652          $updates_transient = get_site_transient( 'update_themes' );
 653          if ( isset( $updates_transient->response ) ) {
 654              $updates = $updates_transient->response;
 655          }
 656      }
 657  
 658      WP_Theme::sort_by_name( $themes );
 659  
 660      $parents = array();
 661  
 662      $auto_updates = (array) get_site_option( 'auto_update_themes', array() );
 663  
 664      foreach ( $themes as $theme ) {
 665          $slug         = $theme->get_stylesheet();
 666          $encoded_slug = urlencode( $slug );
 667  
 668          $parent = false;
 669          if ( $theme->parent() ) {
 670              $parent           = $theme->parent();
 671              $parents[ $slug ] = $parent->get_stylesheet();
 672              $parent           = $parent->display( 'Name' );
 673          }
 674  
 675          $customize_action = null;
 676          if ( current_user_can( 'edit_theme_options' ) && current_user_can( 'customize' ) ) {
 677              $customize_action = esc_url(
 678                  add_query_arg(
 679                      array(
 680                          'return' => urlencode( esc_url_raw( remove_query_arg( wp_removable_query_args(), wp_unslash( $_SERVER['REQUEST_URI'] ) ) ) ),
 681                      ),
 682                      wp_customize_url( $slug )
 683                  )
 684              );
 685          }
 686  
 687          $auto_update        = in_array( $slug, $auto_updates, true );
 688          $auto_update_action = $auto_update ? 'disable-auto-update' : 'enable-auto-update';
 689  
 690          $prepared_themes[ $slug ] = array(
 691              'id'            => $slug,
 692              'name'          => $theme->display( 'Name' ),
 693              'screenshot'    => array( $theme->get_screenshot() ), // @todo Multiple screenshots.
 694              'description'   => $theme->display( 'Description' ),
 695              'author'        => $theme->display( 'Author', false, true ),
 696              'authorAndUri'  => $theme->display( 'Author' ),
 697              'tags'          => $theme->display( 'Tags' ),
 698              'version'       => $theme->get( 'Version' ),
 699              'compatibleWP'  => is_wp_version_compatible( $theme->get( 'RequiresWP' ) ),
 700              'compatiblePHP' => is_php_version_compatible( $theme->get( 'RequiresPHP' ) ),
 701              'parent'        => $parent,
 702              'active'        => $slug === $current_theme,
 703              'hasUpdate'     => isset( $updates[ $slug ] ),
 704              'hasPackage'    => isset( $updates[ $slug ] ) && ! empty( $updates[ $slug ]['package'] ),
 705              'update'        => get_theme_update_available( $theme ),
 706              'autoupdate'    => $auto_update,
 707              'actions'       => array(
 708                  'activate'   => current_user_can( 'switch_themes' ) ? wp_nonce_url( admin_url( 'themes.php?action=activate&amp;stylesheet=' . $encoded_slug ), 'switch-theme_' . $slug ) : null,
 709                  'customize'  => $customize_action,
 710                  'delete'     => current_user_can( 'delete_themes' ) ? wp_nonce_url( admin_url( 'themes.php?action=delete&amp;stylesheet=' . $encoded_slug ), 'delete-theme_' . $slug ) : null,
 711                  'autoupdate' => wp_is_auto_update_enabled_for_type( 'theme' ) && ! is_multisite() && current_user_can( 'update_themes' )
 712                      ? wp_nonce_url( admin_url( 'themes.php?action=' . $auto_update_action . '&amp;stylesheet=' . $encoded_slug ), 'updates' )
 713                      : null,
 714              ),
 715          );
 716      }
 717  
 718      // Remove 'delete' action if theme has an active child.
 719      if ( ! empty( $parents ) && array_key_exists( $current_theme, $parents ) ) {
 720          unset( $prepared_themes[ $parents[ $current_theme ] ]['actions']['delete'] );
 721      }
 722  
 723      /**
 724       * Filters the themes prepared for JavaScript, for themes.php.
 725       *
 726       * Could be useful for changing the order, which is by name by default.
 727       *
 728       * @since 3.8.0
 729       *
 730       * @param array $prepared_themes Array of theme data.
 731       */
 732      $prepared_themes = apply_filters( 'wp_prepare_themes_for_js', $prepared_themes );
 733      $prepared_themes = array_values( $prepared_themes );
 734      return array_filter( $prepared_themes );
 735  }
 736  
 737  /**
 738   * Print JS templates for the theme-browsing UI in the Customizer.
 739   *
 740   * @since 4.2.0
 741   */
 742  function customize_themes_print_templates() {
 743      ?>
 744      <script type="text/html" id="tmpl-customize-themes-details-view">
 745          <div class="theme-backdrop"></div>
 746          <div class="theme-wrap wp-clearfix" role="document">
 747              <div class="theme-header">
 748                  <button type="button" class="left dashicons dashicons-no"><span class="screen-reader-text"><?php _e( 'Show previous theme' ); ?></span></button>
 749                  <button type="button" class="right dashicons dashicons-no"><span class="screen-reader-text"><?php _e( 'Show next theme' ); ?></span></button>
 750                  <button type="button" class="close dashicons dashicons-no"><span class="screen-reader-text"><?php _e( 'Close details dialog' ); ?></span></button>
 751              </div>
 752              <div class="theme-about wp-clearfix">
 753                  <div class="theme-screenshots">
 754                  <# if ( data.screenshot && data.screenshot[0] ) { #>
 755                      <div class="screenshot"><img src="{{ data.screenshot[0] }}" alt="" /></div>
 756                  <# } else { #>
 757                      <div class="screenshot blank"></div>
 758                  <# } #>
 759                  </div>
 760  
 761                  <div class="theme-info">
 762                      <# if ( data.active ) { #>
 763                          <span class="current-label"><?php _e( 'Current Theme' ); ?></span>
 764                      <# } #>
 765                      <h2 class="theme-name">{{{ data.name }}}<span class="theme-version">
 766                          <?php
 767                          /* translators: %s: Theme version. */
 768                          printf( __( 'Version: %s' ), '{{ data.version }}' );
 769                          ?>
 770                      </span></h2>
 771                      <h3 class="theme-author">
 772                          <?php
 773                          /* translators: %s: Theme author link. */
 774                          printf( __( 'By %s' ), '{{{ data.authorAndUri }}}' );
 775                          ?>
 776                      </h3>
 777  
 778                      <# if ( data.stars && 0 != data.num_ratings ) { #>
 779                          <div class="theme-rating">
 780                              {{{ data.stars }}}
 781                              <a class="num-ratings" target="_blank" href="{{ data.reviews_url }}">
 782                                  <?php
 783                                  printf(
 784                                      '%1$s <span class="screen-reader-text">%2$s</span>',
 785                                      /* translators: %s: Number of ratings. */
 786                                      sprintf( __( '(%s ratings)' ), '{{ data.num_ratings }}' ),
 787                                      /* translators: Accessibility text. */
 788                                      __( '(opens in a new tab)' )
 789                                  );
 790                                  ?>
 791                              </a>
 792                          </div>
 793                      <# } #>
 794  
 795                      <# if ( data.hasUpdate ) { #>
 796                          <div class="notice notice-warning notice-alt notice-large" data-slug="{{ data.id }}">
 797                              <h3 class="notice-title"><?php _e( 'Update Available' ); ?></h3>
 798                              {{{ data.update }}}
 799                          </div>
 800                      <# } #>
 801  
 802                      <# if ( data.parent ) { #>
 803                          <p class="parent-theme">
 804                              <?php
 805                              printf(
 806                                  /* translators: %s: Theme name. */
 807                                  __( 'This is a child theme of %s.' ),
 808                                  '<strong>{{{ data.parent }}}</strong>'
 809                              );
 810                              ?>
 811                          </p>
 812                      <# } #>
 813  
 814                      <p class="theme-description">{{{ data.description }}}</p>
 815  
 816                      <# if ( data.tags ) { #>
 817                          <p class="theme-tags"><span><?php _e( 'Tags:' ); ?></span> {{{ data.tags }}}</p>
 818                      <# } #>
 819                  </div>
 820              </div>
 821  
 822              <div class="theme-actions">
 823                  <# if ( data.active ) { #>
 824                      <button type="button" class="button button-primary customize-theme"><?php _e( 'Customize' ); ?></button>
 825                  <# } else if ( 'installed' === data.type ) { #>
 826                      <?php if ( current_user_can( 'delete_themes' ) ) { ?>
 827                          <# if ( data.actions && data.actions['delete'] ) { #>
 828                              <a href="{{{ data.actions['delete'] }}}" data-slug="{{ data.id }}" class="button button-secondary delete-theme"><?php _e( 'Delete' ); ?></a>
 829                          <# } #>
 830                      <?php } ?>
 831  
 832                      <# if ( data.compatibleWP && data.compatiblePHP ) { #>
 833                          <button type="button" class="button button-primary preview-theme" data-slug="{{ data.id }}"><?php _e( 'Live Preview' ); ?></button>
 834                      <# } else { #>
 835                          <button class="button button-primary disabled"><?php _e( 'Live Preview' ); ?></button>
 836                      <# } #>
 837                  <# } else { #>
 838                      <# if ( data.compatibleWP && data.compatiblePHP ) { #>
 839                          <button type="button" class="button theme-install" data-slug="{{ data.id }}"><?php _e( 'Install' ); ?></button>
 840                          <button type="button" class="button button-primary theme-install preview" data-slug="{{ data.id }}"><?php _e( 'Install &amp; Preview' ); ?></button>
 841                      <# } else { #>
 842                          <button type="button" class="button disabled"><?php _ex( 'Cannot Install', 'theme' ); ?></button>
 843                          <button type="button" class="button button-primary disabled"><?php _e( 'Install &amp; Preview' ); ?></button>
 844                      <# } #>
 845                  <# } #>
 846              </div>
 847          </div>
 848      </script>
 849      <?php
 850  }
 851  
 852  /**
 853   * Determines whether a theme is technically active but was paused while
 854   * loading.
 855   *
 856   * For more information on this and similar theme functions, check out
 857   * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
 858   * Conditional Tags} article in the Theme Developer Handbook.
 859   *
 860   * @since 5.2.0
 861   *
 862   * @param string $theme Path to the theme directory relative to the themes directory.
 863   * @return bool True, if in the list of paused themes. False, not in the list.
 864   */
 865  function is_theme_paused( $theme ) {
 866      if ( ! isset( $GLOBALS['_paused_themes'] ) ) {
 867          return false;
 868      }
 869  
 870      if ( get_stylesheet() !== $theme && get_template() !== $theme ) {
 871          return false;
 872      }
 873  
 874      return array_key_exists( $theme, $GLOBALS['_paused_themes'] );
 875  }
 876  
 877  /**
 878   * Gets the error that was recorded for a paused theme.
 879   *
 880   * @since 5.2.0
 881   *
 882   * @param string $theme Path to the theme directory relative to the themes
 883   *                      directory.
 884   * @return array|false Array of error information as it was returned by
 885   *                     `error_get_last()`, or false if none was recorded.
 886   */
 887  function wp_get_theme_error( $theme ) {
 888      if ( ! isset( $GLOBALS['_paused_themes'] ) ) {
 889          return false;
 890      }
 891  
 892      if ( ! array_key_exists( $theme, $GLOBALS['_paused_themes'] ) ) {
 893          return false;
 894      }
 895  
 896      return $GLOBALS['_paused_themes'][ $theme ];
 897  }
 898  
 899  /**
 900   * Tries to resume a single theme.
 901   *
 902   * If a redirect was provided and a functions.php file was found, we first ensure that
 903   * functions.php file does not throw fatal errors anymore.
 904   *
 905   * The way it works is by setting the redirection to the error before trying to
 906   * include the file. If the theme fails, then the redirection will not be overwritten
 907   * with the success message and the theme will not be resumed.
 908   *
 909   * @since 5.2.0
 910   *
 911   * @param string $theme    Single theme to resume.
 912   * @param string $redirect Optional. URL to redirect to. Default empty string.
 913   * @return bool|WP_Error True on success, false if `$theme` was not paused,
 914   *                       `WP_Error` on failure.
 915   */
 916  function resume_theme( $theme, $redirect = '' ) {
 917      list( $extension ) = explode( '/', $theme );
 918  
 919      /*
 920       * We'll override this later if the theme could be resumed without
 921       * creating a fatal error.
 922       */
 923      if ( ! empty( $redirect ) ) {
 924          $functions_path = '';
 925          if ( strpos( STYLESHEETPATH, $extension ) ) {
 926              $functions_path = STYLESHEETPATH . '/functions.php';
 927          } elseif ( strpos( TEMPLATEPATH, $extension ) ) {
 928              $functions_path = TEMPLATEPATH . '/functions.php';
 929          }
 930  
 931          if ( ! empty( $functions_path ) ) {
 932              wp_redirect(
 933                  add_query_arg(
 934                      '_error_nonce',
 935                      wp_create_nonce( 'theme-resume-error_' . $theme ),
 936                      $redirect
 937                  )
 938              );
 939  
 940              // Load the theme's functions.php to test whether it throws a fatal error.
 941              ob_start();
 942              if ( ! defined( 'WP_SANDBOX_SCRAPING' ) ) {
 943                  define( 'WP_SANDBOX_SCRAPING', true );
 944              }
 945              include $functions_path;
 946              ob_clean();
 947          }
 948      }
 949  
 950      $result = wp_paused_themes()->delete( $extension );
 951  
 952      if ( ! $result ) {
 953          return new WP_Error(
 954              'could_not_resume_theme',
 955              __( 'Could not resume the theme.' )
 956          );
 957      }
 958  
 959      return true;
 960  }
 961  
 962  /**
 963   * Renders an admin notice in case some themes have been paused due to errors.
 964   *
 965   * @since 5.2.0
 966   */
 967  function paused_themes_notice() {
 968      if ( 'themes.php' === $GLOBALS['pagenow'] ) {
 969          return;
 970      }
 971  
 972      if ( ! current_user_can( 'resume_themes' ) ) {
 973          return;
 974      }
 975  
 976      if ( ! isset( $GLOBALS['_paused_themes'] ) || empty( $GLOBALS['_paused_themes'] ) ) {
 977          return;
 978      }
 979  
 980      printf(
 981          '<div class="notice notice-error"><p><strong>%s</strong><br>%s</p><p><a href="%s">%s</a></p></div>',
 982          __( 'One or more themes failed to load properly.' ),
 983          __( 'You can find more details and make changes on the Themes screen.' ),
 984          esc_url( admin_url( 'themes.php' ) ),
 985          __( 'Go to the Themes screen' )
 986      );
 987  }


Generated: Thu Jul 16 01:00:03 2020 Cross-referenced by PHPXref 0.7.1