wp-admin/includes/class-wp-ms-themes-list-table.php

   1 <?php
   2 /**
   3  * List Table API: WP_MS_Themes_List_Table class
   4  *
   5  * @package WordPress
   6  * @subpackage Administration
   7  * @since 3.1.0
   8  */
   9
  10 /**
  11  * Core class used to implement displaying themes in a list table for the network admin.
  12  *
  13  * @since 3.1.0
  14  * @access private
  15  *
  16  * @see WP_List_Table
  17  */
  18 class WP_MS_Themes_List_Table extends WP_List_Table {
  19
  20         public $site_id;
  21         public $is_site_themes;
  22
  23         private $has_items;
  24
  25         /**
  26          * Constructor.
  27          *
  28          * @since 3.1.0
  29          * @access public
  30          *
  31          * @see WP_List_Table::__construct() for more information on default arguments.
  32          *
  33          * @global string $status
  34          * @global int    $page
  35          *
  36          * @param array $args An associative array of arguments.
  37          */
  38         public function __construct( $args = array() ) {
  39                 global $status, $page;
  40
  41                 parent::__construct( array(
  42                         'plural' => 'themes',
  43                         'screen' => isset( $args['screen'] ) ? $args['screen'] : null,
  44                 ) );
  45
  46                 $status = isset( $_REQUEST['theme_status'] ) ? $_REQUEST['theme_status'] : 'all';
  47                 if ( !in_array( $status, array( 'all', 'enabled', 'disabled', 'upgrade', 'search', 'broken' ) ) )
  48                         $status = 'all';
  49
  50                 $page = $this->get_pagenum();
  51
  52                 $this->is_site_themes = ( 'site-themes-network' === $this->screen->id ) ? true : false;
  53
  54                 if ( $this->is_site_themes )
  55                         $this->site_id = isset( $_REQUEST['id'] ) ? intval( $_REQUEST['id'] ) : 0;
  56         }
  57
  58         /**
  59          *
  60          * @return array
  61          */
  62         protected function get_table_classes() {
  63                 // todo: remove and add CSS for .themes
  64                 return array( 'widefat', 'plugins' );
  65         }
  66
  67         /**
  68          *
  69          * @return bool
  70          */
  71         public function ajax_user_can() {
  72                 if ( $this->is_site_themes )
  73                         return current_user_can( 'manage_sites' );
  74                 else
  75                         return current_user_can( 'manage_network_themes' );
  76         }
  77
  78         /**
  79          *
  80          * @global string $status
  81          * @global array $totals
  82          * @global int $page
  83          * @global string $orderby
  84          * @global string $order
  85          * @global string $s
  86          */
  87         public function prepare_items() {
  88                 global $status, $totals, $page, $orderby, $order, $s;
  89
  90                 wp_reset_vars( array( 'orderby', 'order', 's' ) );
  91
  92                 $themes = array(
  93                         /**
  94                          * Filter the full array of WP_Theme objects to list in the Multisite
  95                          * themes list table.
  96                          *
  97                          * @since 3.1.0
  98                          *
  99                          * @param array $all An array of WP_Theme objects to display in the list table.
 100                          */
 101                         'all' => apply_filters( 'all_themes', wp_get_themes() ),
 102                         'search' => array(),
 103                         'enabled' => array(),
 104                         'disabled' => array(),
 105                         'upgrade' => array(),
 106                         'broken' => $this->is_site_themes ? array() : wp_get_themes( array( 'errors' => true ) ),
 107                 );
 108
 109                 if ( $this->is_site_themes ) {
 110                         $themes_per_page = $this->get_items_per_page( 'site_themes_network_per_page' );
 111                         $allowed_where = 'site';
 112                 } else {
 113                         $themes_per_page = $this->get_items_per_page( 'themes_network_per_page' );
 114                         $allowed_where = 'network';
 115                 }
 116
 117                 $maybe_update = current_user_can( 'update_themes' ) && ! $this->is_site_themes && $current = get_site_transient( 'update_themes' );
 118
 119                 foreach ( (array) $themes['all'] as $key => $theme ) {
 120                         if ( $this->is_site_themes && $theme->is_allowed( 'network' ) ) {
 121                                 unset( $themes['all'][ $key ] );
 122                                 continue;
 123                         }
 124
 125                         if ( $maybe_update && isset( $current->response[ $key ] ) ) {
 126                                 $themes['all'][ $key ]->update = true;
 127                                 $themes['upgrade'][ $key ] = $themes['all'][ $key ];
 128                         }
 129
 130                         $filter = $theme->is_allowed( $allowed_where, $this->site_id ) ? 'enabled' : 'disabled';
 131                         $themes[ $filter ][ $key ] = $themes['all'][ $key ];
 132                 }
 133
 134                 if ( $s ) {
 135                         $status = 'search';
 136                         $themes['search'] = array_filter( array_merge( $themes['all'], $themes['broken'] ), array( $this, '_search_callback' ) );
 137                 }
 138
 139                 $totals = array();
 140                 foreach ( $themes as $type => $list )
 141                         $totals[ $type ] = count( $list );
 142
 143                 if ( empty( $themes[ $status ] ) && !in_array( $status, array( 'all', 'search' ) ) )
 144                         $status = 'all';
 145
 146                 $this->items = $themes[ $status ];
 147                 WP_Theme::sort_by_name( $this->items );
 148
 149                 $this->has_items = ! empty( $themes['all'] );
 150                 $total_this_page = $totals[ $status ];
 151
 152                 if ( $orderby ) {
 153                         $orderby = ucfirst( $orderby );
 154                         $order = strtoupper( $order );
 155
 156                         if ( $orderby === 'Name' ) {
 157                                 if ( 'ASC' === $order ) {
 158                                         $this->items = array_reverse( $this->items );
 159                                 }
 160                         } else {
 161                                 uasort( $this->items, array( $this, '_order_callback' ) );
 162                         }
 163                 }
 164
 165                 $start = ( $page - 1 ) * $themes_per_page;
 166
 167                 if ( $total_this_page > $themes_per_page )
 168                         $this->items = array_slice( $this->items, $start, $themes_per_page, true );
 169
 170                 $this->set_pagination_args( array(
 171                         'total_items' => $total_this_page,
 172                         'per_page' => $themes_per_page,
 173                 ) );
 174         }
 175
 176         /**
 177          * @staticvar string $term
 178          * @param WP_Theme $theme
 179          * @return bool
 180          */
 181         public function _search_callback( $theme ) {
 182                 static $term = null;
 183                 if ( is_null( $term ) )
 184                         $term = wp_unslash( $_REQUEST['s'] );
 185
 186                 foreach ( array( 'Name', 'Description', 'Author', 'Author', 'AuthorURI' ) as $field ) {
 187                         // Don't mark up; Do translate.
 188                         if ( false !== stripos( $theme->display( $field, false, true ), $term ) )
 189                                 return true;
 190                 }
 191
 192                 if ( false !== stripos( $theme->get_stylesheet(), $term ) )
 193                         return true;
 194
 195                 if ( false !== stripos( $theme->get_template(), $term ) )
 196                         return true;
 197
 198                 return false;
 199         }
 200
 201         // Not used by any core columns.
 202         /**
 203          * @global string $orderby
 204          * @global string $order
 205          * @param array $theme_a
 206          * @param array $theme_b
 207          * @return int
 208          */
 209         public function _order_callback( $theme_a, $theme_b ) {
 210                 global $orderby, $order;
 211
 212                 $a = $theme_a[ $orderby ];
 213                 $b = $theme_b[ $orderby ];
 214
 215                 if ( $a == $b )
 216                         return 0;
 217
 218                 if ( 'DESC' === $order )
 219                         return ( $a < $b ) ? 1 : -1;
 220                 else
 221                         return ( $a < $b ) ? -1 : 1;
 222         }
 223
 224         /**
 225          * @access public
 226          */
 227         public function no_items() {
 228                 if ( $this->has_items ) {
 229                         _e( 'No themes found.' );
 230                 } else {
 231                         _e( 'You do not appear to have any themes available at this time.' );
 232                 }
 233         }
 234
 235         /**
 236          *
 237          * @return array
 238          */
 239         public function get_columns() {
 240                 return array(
 241                         'cb'          => '<input type="checkbox" />',
 242                         'name'        => __( 'Theme' ),
 243                         'description' => __( 'Description' ),
 244                 );
 245         }
 246
 247         /**
 248          *
 249          * @return array
 250          */
 251         protected function get_sortable_columns() {
 252                 return array(
 253                         'name'         => 'name',
 254                 );
 255         }
 256
 257         /**
 258          * Gets the name of the primary column.
 259          *
 260          * @since 4.3.0
 261          * @access protected
 262          *
 263          * @return string Unalterable name of the primary column name, in this case, 'name'.
 264          */
 265         protected function get_primary_column_name() {
 266                 return 'name';
 267         }
 268
 269         /**
 270          *
 271          * @global array $totals
 272          * @global string $status
 273          * @return array
 274          */
 275         protected function get_views() {
 276                 global $totals, $status;
 277
 278                 $status_links = array();
 279                 foreach ( $totals as $type => $count ) {
 280                         if ( !$count )
 281                                 continue;
 282
 283                         switch ( $type ) {
 284                                 case 'all':
 285                                         $text = _nx( 'All <span class="count">(%s)</span>', 'All <span class="count">(%s)</span>', $count, 'themes' );
 286                                         break;
 287                                 case 'enabled':
 288                                         $text = _n( 'Enabled <span class="count">(%s)</span>', 'Enabled <span class="count">(%s)</span>', $count );
 289                                         break;
 290                                 case 'disabled':
 291                                         $text = _n( 'Disabled <span class="count">(%s)</span>', 'Disabled <span class="count">(%s)</span>', $count );
 292                                         break;
 293                                 case 'upgrade':
 294                                         $text = _n( 'Update Available <span class="count">(%s)</span>', 'Update Available <span class="count">(%s)</span>', $count );
 295                                         break;
 296                                 case 'broken' :
 297                                         $text = _n( 'Broken <span class="count">(%s)</span>', 'Broken <span class="count">(%s)</span>', $count );
 298                                         break;
 299                         }
 300
 301                         if ( $this->is_site_themes )
 302                                 $url = 'site-themes.php?id=' . $this->site_id;
 303                         else
 304                                 $url = 'themes.php';
 305
 306                         if ( 'search' != $type ) {
 307                                 $status_links[$type] = sprintf( "<a href='%s' %s>%s</a>",
 308                                         esc_url( add_query_arg('theme_status', $type, $url) ),
 309                                         ( $type === $status ) ? ' class="current"' : '',
 310                                         sprintf( $text, number_format_i18n( $count ) )
 311                                 );
 312                         }
 313                 }
 314
 315                 return $status_links;
 316         }
 317
 318         /**
 319          * @global string $status
 320          *
 321          * @return array
 322          */
 323         protected function get_bulk_actions() {
 324                 global $status;
 325
 326                 $actions = array();
 327                 if ( 'enabled' != $status )
 328                         $actions['enable-selected'] = $this->is_site_themes ? __( 'Enable' ) : __( 'Network Enable' );
 329                 if ( 'disabled' != $status )
 330                         $actions['disable-selected'] = $this->is_site_themes ? __( 'Disable' ) : __( 'Network Disable' );
 331                 if ( ! $this->is_site_themes ) {
 332                         if ( current_user_can( 'update_themes' ) )
 333                                 $actions['update-selected'] = __( 'Update' );
 334                         if ( current_user_can( 'delete_themes' ) )
 335                                 $actions['delete-selected'] = __( 'Delete' );
 336                 }
 337                 return $actions;
 338         }
 339
 340         /**
 341          * @access public
 342          */
 343         public function display_rows() {
 344                 foreach ( $this->items as $theme )
 345                         $this->single_row( $theme );
 346         }
 347
 348         /**
 349          * Handles the checkbox column output.
 350          *
 351          * @since 4.3.0
 352          * @access public
 353          *
 354          * @param WP_Theme $theme The current WP_Theme object.
 355          */
 356         public function column_cb( $theme ) {
 357                 $checkbox_id = 'checkbox_' . md5( $theme->get('Name') );
 358                 ?>
 359                 <input type="checkbox" name="checked[]" value="<?php echo esc_attr( $theme->get_stylesheet() ) ?>" id="<?php echo $checkbox_id ?>" />
 360                 <label class="screen-reader-text" for="<?php echo $checkbox_id ?>" ><?php _e( 'Select' ) ?>  <?php echo $theme->display( 'Name' ) ?></label>
 361                 <?php
 362         }
 363
 364         /**
 365          * Handles the name column output.
 366          *
 367          * @since 4.3.0
 368          * @access public
 369          *
 370          * @global string $status
 371          * @global int    $page
 372          * @global string $s
 373          *
 374          * @param WP_Theme $theme The current WP_Theme object.
 375          */
 376         public function column_name( $theme ) {
 377                 global $status, $page, $s;
 378
 379                 $context = $status;
 380
 381                 if ( $this->is_site_themes ) {
 382                         $url = "site-themes.php?id={$this->site_id}&amp;";
 383                         $allowed = $theme->is_allowed( 'site', $this->site_id );
 384                 } else {
 385                         $url = 'themes.php?';
 386                         $allowed = $theme->is_allowed( 'network' );
 387                 }
 388
 389                 // Pre-order.
 390                 $actions = array(
 391                         'enable' => '',
 392                         'disable' => '',
 393                         'edit' => '',
 394                         'delete' => ''
 395                 );
 396
 397                 $stylesheet = $theme->get_stylesheet();
 398                 $theme_key = urlencode( $stylesheet );
 399
 400                 if ( ! $allowed ) {
 401                         if ( ! $theme->errors() ) {
 402                                 $actions['enable'] = '<a href="' . esc_url( wp_nonce_url($url . 'action=enable&amp;theme=' . $theme_key . '&amp;paged=' . $page . '&amp;s=' . $s, 'enable-theme_' . $stylesheet ) ) . '" title="' . esc_attr__('Enable this theme') . '" class="edit">' . ( $this->is_site_themes ? __( 'Enable' ) : __( 'Network Enable' ) ) . '</a>';
 403                         }
 404                 } else {
 405                         $actions['disable'] = '<a href="' . esc_url( wp_nonce_url($url . 'action=disable&amp;theme=' . $theme_key . '&amp;paged=' . $page . '&amp;s=' . $s, 'disable-theme_' . $stylesheet ) ) . '" title="' . esc_attr__('Disable this theme') . '">' . ( $this->is_site_themes ? __( 'Disable' ) : __( 'Network Disable' ) ) . '</a>';
 406                 }
 407
 408                 if ( current_user_can('edit_themes') ) {
 409                         $actions['edit'] = '<a href="' . esc_url('theme-editor.php?theme=' . $theme_key ) . '" title="' . esc_attr__('Open this theme in the Theme Editor') . '" class="edit">' . __('Edit') . '</a>';
 410                 }
 411
 412                 if ( ! $allowed && current_user_can( 'delete_themes' ) && ! $this->is_site_themes && $stylesheet != get_option( 'stylesheet' ) && $stylesheet != get_option( 'template' ) ) {
 413                         $actions['delete'] = '<a href="' . esc_url( wp_nonce_url( 'themes.php?action=delete-selected&amp;checked[]=' . $theme_key . '&amp;theme_status=' . $context . '&amp;paged=' . $page . '&amp;s=' . $s, 'bulk-themes' ) ) . '" title="' . esc_attr__( 'Delete this theme' ) . '" class="delete">' . __( 'Delete' ) . '</a>';
 414                 }
 415                 /**
 416                  * Filter the action links displayed for each theme in the Multisite
 417                  * themes list table.
 418                  *
 419                  * The action links displayed are determined by the theme's status, and
 420                  * which Multisite themes list table is being displayed - the Network
 421                  * themes list table (themes.php), which displays all installed themes,
 422                  * or the Site themes list table (site-themes.php), which displays the
 423                  * non-network enabled themes when editing a site in the Network admin.
 424                  *
 425                  * The default action links for the Network themes list table include
 426                  * 'Network Enable', 'Network Disable', 'Edit', and 'Delete'.
 427                  *
 428                  * The default action links for the Site themes list table include
 429                  * 'Enable', 'Disable', and 'Edit'.
 430                  *
 431                  * @since 2.8.0
 432                  *
 433                  * @param array    $actions An array of action links.
 434                  * @param WP_Theme $theme   The current WP_Theme object.
 435                  * @param string   $context Status of the theme.
 436                  */
 437                 $actions = apply_filters( 'theme_action_links', array_filter( $actions ), $theme, $context );
 438
 439                 /**
 440                  * Filter the action links of a specific theme in the Multisite themes
 441                  * list table.
 442                  *
 443                  * The dynamic portion of the hook name, `$stylesheet`, refers to the
 444                  * directory name of the theme, which in most cases is synonymous
 445                  * with the template name.
 446                  *
 447                  * @since 3.1.0
 448                  *
 449                  * @param array    $actions An array of action links.
 450                  * @param WP_Theme $theme   The current WP_Theme object.
 451                  * @param string   $context Status of the theme.
 452                  */
 453                 $actions = apply_filters( "theme_action_links_$stylesheet", $actions, $theme, $context );
 454
 455                 echo $this->row_actions( $actions, true );
 456         }
 457
 458         /**
 459          * Handles the description column output.
 460          *
 461          * @since 4.3.0
 462          * @access public
 463          *
 464          * @global string $status
 465          * @global array  $totals
 466          *
 467          * @param WP_Theme $theme The current WP_Theme object.
 468          */
 469         public function column_description( $theme ) {
 470                 global $status, $totals;
 471                 if ( $theme->errors() ) {
 472                         $pre = $status === 'broken' ? __( 'Broken Theme:' ) . ' ' : '';
 473                         echo '<p><strong class="error-message">' . $pre . $theme->errors()->get_error_message() . '</strong></p>';
 474                 }
 475
 476                 if ( $this->is_site_themes ) {
 477                         $allowed = $theme->is_allowed( 'site', $this->site_id );
 478                 } else {
 479                         $allowed = $theme->is_allowed( 'network' );
 480                 }
 481
 482                 $class = ! $allowed ? 'inactive' : 'active';
 483                 if ( ! empty( $totals['upgrade'] ) && ! empty( $theme->update ) )
 484                         $class .= ' update';
 485
 486                 echo "<div class='theme-description'><p>" . $theme->display( 'Description' ) . "</p></div>
 487                         <div class='$class second theme-version-author-uri'>";
 488
 489                 $stylesheet = $theme->get_stylesheet();
 490                 $theme_meta = array();
 491
 492                 if ( $theme->get('Version') ) {
 493                         $theme_meta[] = sprintf( __( 'Version %s' ), $theme->display('Version') );
 494                 }
 495                 $theme_meta[] = sprintf( __( 'By %s' ), $theme->display('Author') );
 496
 497                 if ( $theme->get('ThemeURI') ) {
 498                         $theme_meta[] = '<a href="' . $theme->display('ThemeURI') . '" title="' . esc_attr__( 'Visit theme homepage' ) . '">' . __( 'Visit Theme Site' ) . '</a>';
 499                 }
 500                 /**
 501                  * Filter the array of row meta for each theme in the Multisite themes
 502                  * list table.
 503                  *
 504                  * @since 3.1.0
 505                  *
 506                  * @param array    $theme_meta An array of the theme's metadata,
 507                  *                             including the version, author, and
 508                  *                             theme URI.
 509                  * @param string   $stylesheet Directory name of the theme.
 510                  * @param WP_Theme $theme      WP_Theme object.
 511                  * @param string   $status     Status of the theme.
 512                  */
 513                 $theme_meta = apply_filters( 'theme_row_meta', $theme_meta, $stylesheet, $theme, $status );
 514                 echo implode( ' | ', $theme_meta );
 515
 516                 echo '</div>';
 517         }
 518
 519         /**
 520          * Handles default column output.
 521          *
 522          * @since 4.3.0
 523          * @access public
 524          *
 525          * @param WP_Theme $theme       The current WP_Theme object.
 526          * @param string   $column_name The current column name.
 527          */
 528         public function column_default( $theme, $column_name ) {
 529                 $stylesheet = $theme->get_stylesheet();
 530
 531                 /**
 532                  * Fires inside each custom column of the Multisite themes list table.
 533                  *
 534                  * @since 3.1.0
 535                  *
 536                  * @param string   $column_name Name of the column.
 537                  * @param string   $stylesheet  Directory name of the theme.
 538                  * @param WP_Theme $theme       Current WP_Theme object.
 539                  */
 540                 do_action( 'manage_themes_custom_column', $column_name, $stylesheet, $theme );
 541         }
 542
 543         /**
 544          * Handles the output for a single table row.
 545          *
 546          * @since 4.3.0
 547          * @access public
 548          *
 549          * @param WP_Theme $item The current WP_Theme object.
 550          */
 551         public function single_row_columns( $item ) {
 552                 list( $columns, $hidden, $sortable, $primary ) = $this->get_column_info();
 553
 554                 foreach ( $columns as $column_name => $column_display_name ) {
 555                         $extra_classes = '';
 556                         if ( in_array( $column_name, $hidden ) ) {
 557                                 $extra_classes .= ' hidden';
 558                         }
 559
 560                         switch ( $column_name ) {
 561                                 case 'cb':
 562                                         echo '<th scope="row" class="check-column">';
 563
 564                                         $this->column_cb( $item );
 565
 566                                         echo '</th>';
 567                                         break;
 568
 569                                 case 'name':
 570                                         echo "<td class='theme-title column-primary{$extra_classes}'><strong>" . $item->display('Name') . "</strong>";
 571
 572                                         $this->column_name( $item );
 573
 574                                         echo "</td>";
 575                                         break;
 576
 577                                 case 'description':
 578                                         echo "<td class='column-description desc{$extra_classes}'>";
 579
 580                                         $this->column_description( $item );
 581
 582                                         echo '</td>';
 583                                         break;
 584
 585                                 default:
 586                                         echo "<td class='$column_name column-$column_name{$extra_classes}'>";
 587
 588                                         $this->column_default( $item, $column_name );
 589
 590                                         echo "</td>";
 591                                         break;
 592                         }
 593                 }
 594         }
 595
 596         /**
 597          * @global string $status
 598          * @global array  $totals
 599          *
 600          * @param WP_Theme $theme
 601          */
 602         public function single_row( $theme ) {
 603                 global $status, $totals;
 604
 605                 if ( $this->is_site_themes ) {
 606                         $allowed = $theme->is_allowed( 'site', $this->site_id );
 607                 } else {
 608                         $allowed = $theme->is_allowed( 'network' );
 609                 }
 610
 611                 $stylesheet = $theme->get_stylesheet();
 612
 613                 $class = ! $allowed ? 'inactive' : 'active';
 614
 615                 $id = sanitize_html_class( $theme->get_stylesheet() );
 616
 617                 if ( ! empty( $totals['upgrade'] ) && ! empty( $theme->update ) ) {
 618                         $class .= ' update';
 619                 }
 620
 621                 echo "<tr id='$id' class='$class'>";
 622
 623                 $this->single_row_columns( $theme );
 624
 625                 echo "</tr>";
 626
 627                 if ( $this->is_site_themes )
 628                         remove_action( "after_theme_row_$stylesheet", 'wp_theme_update_row' );
 629
 630                 /**
 631                  * Fires after each row in the Multisite themes list table.
 632                  *
 633                  * @since 3.1.0
 634                  *
 635                  * @param string   $stylesheet Directory name of the theme.
 636                  * @param WP_Theme $theme      Current WP_Theme object.
 637                  * @param string   $status     Status of the theme.
 638                  */
 639                 do_action( 'after_theme_row', $stylesheet, $theme, $status );
 640
 641                 /**
 642                  * Fires after each specific row in the Multisite themes list table.
 643                  *
 644                  * The dynamic portion of the hook name, `$stylesheet`, refers to the
 645                  * directory name of the theme, most often synonymous with the template
 646                  * name of the theme.
 647                  *
 648                  * @since 3.5.0
 649                  *
 650                  * @param string   $stylesheet Directory name of the theme.
 651                  * @param WP_Theme $theme      Current WP_Theme object.
 652                  * @param string   $status     Status of the theme.
 653                  */
 654                 do_action( "after_theme_row_$stylesheet", $stylesheet, $theme, $status );
 655         }
 656 }