Wordpress 4.6
[autoinstalls/wordpress.git] / wp-admin / includes / class-wp-theme-install-list-table.php
index e991c4ec46b64ae684a060376705606b93963a8a..492497ed35afa28aa4a43a0be0317ba68044e08c 100644 (file)
@@ -1,21 +1,41 @@
 <?php
 /**
- * Theme Installer List Table class.
+ * List Table API: WP_Theme_Install_List_Table class
  *
  * @package WordPress
- * @subpackage List_Table
+ * @subpackage Administration
+ * @since 3.1.0
+ */
+
+/**
+ * Core class used to implement displaying themes to install in a list table.
+ *
  * @since 3.1.0
  * @access private
+ *
+ * @see WP_Themes_List_Table
  */
 class WP_Theme_Install_List_Table extends WP_Themes_List_Table {
 
-       var $features = array();
+       public $features = array();
 
-       function ajax_user_can() {
+       /**
+        *
+        * @return bool
+        */
+       public function ajax_user_can() {
                return current_user_can( 'install_themes' );
        }
 
-       function prepare_items() {
+       /**
+        *
+        * @global array  $tabs
+        * @global string $tab
+        * @global int    $paged
+        * @global string $type
+        * @global array  $theme_field_defaults
+        */
+       public function prepare_items() {
                include( ABSPATH . 'wp-admin/includes/theme-install.php' );
 
                global $tabs, $tab, $paged, $type, $theme_field_defaults;
@@ -38,28 +58,21 @@ class WP_Theme_Install_List_Table extends WP_Themes_List_Table {
                // These are the tabs which are shown on the page,
                $tabs = array();
                $tabs['dashboard'] = __( 'Search' );
-               if ( 'search' == $tab )
+               if ( 'search' === $tab )
                        $tabs['search'] = __( 'Search Results' );
                $tabs['upload'] = __( 'Upload' );
-               $tabs['featured'] = _x( 'Featured','Theme Installer' );
-               //$tabs['popular']  = _x( 'Popular','Theme Installer' );
-               $tabs['new']      = _x( 'Newest','Theme Installer' );
-               $tabs['updated']  = _x( 'Recently Updated','Theme Installer' );
+               $tabs['featured'] = _x( 'Featured', 'themes' );
+               //$tabs['popular']  = _x( 'Popular', 'themes' );
+               $tabs['new']      = _x( 'Latest', 'themes' );
+               $tabs['updated']  = _x( 'Recently Updated', 'themes' );
 
                $nonmenu_tabs = array( 'theme-information' ); // Valid actions to perform which do not have a Menu item.
 
-               /**
-                * Filter the tabs shown on the Install Themes screen.
-                *
-                * @since 2.8.0
-                *
-                * @param array $tabs The tabs shown on the Install Themes screen. Defaults are
-                *                    'dashboard', 'search', 'upload', 'featured', 'new', and 'updated'.
-                */
+               /** This filter is documented in wp-admin/theme-install.php */
                $tabs = apply_filters( 'install_themes_tabs', $tabs );
 
                /**
-                * Filter tabs not associated with a menu item on the Install Themes screen.
+                * Filters tabs not associated with a menu item on the Install Themes screen.
                 *
                 * @since 2.8.0
                 *
@@ -99,7 +112,7 @@ class WP_Theme_Install_List_Table extends WP_Themes_List_Table {
                                break;
 
                        case 'featured':
-                       //case 'popular':
+                       // case 'popular':
                        case 'new':
                        case 'updated':
                                $args['browse'] = $tab;
@@ -111,9 +124,9 @@ class WP_Theme_Install_List_Table extends WP_Themes_List_Table {
                }
 
                /**
-                * Filter API request arguments for each Install Themes screen tab.
+                * Filters API request arguments for each Install Themes screen tab.
                 *
-                * The dynamic portion of the hook name, $tab, refers to the theme install
+                * The dynamic portion of the hook name, `$tab`, refers to the theme install
                 * tabs. Default tabs are 'dashboard', 'search', 'upload', 'featured',
                 * 'new', and 'updated'.
                 *
@@ -140,16 +153,25 @@ class WP_Theme_Install_List_Table extends WP_Themes_List_Table {
                ) );
        }
 
-       function no_items() {
+       /**
+        * @access public
+        */
+       public function no_items() {
                _e( 'No themes match your request.' );
        }
 
-       function get_views() {
+       /**
+        *
+        * @global array $tabs
+        * @global string $tab
+        * @return array
+        */
+       protected function get_views() {
                global $tabs, $tab;
 
                $display_tabs = array();
                foreach ( (array) $tabs as $action => $text ) {
-                       $class = ( $action == $tab ) ? ' class="current"' : '';
+                       $class = ( $action === $tab ) ? ' class="current"' : '';
                        $href = self_admin_url('theme-install.php?tab=' . $action);
                        $display_tabs['theme-install-'.$action] = "<a href='$href'$class>$text</a>";
                }
@@ -157,7 +179,10 @@ class WP_Theme_Install_List_Table extends WP_Themes_List_Table {
                return $display_tabs;
        }
 
-       function display() {
+       /**
+        * @access public
+        */
+       public function display() {
                wp_nonce_field( "fetch-list-" . get_class( $this ), '_ajax_fetch_list_nonce' );
 ?>
                <div class="tablenav top themes">
@@ -180,10 +205,13 @@ class WP_Theme_Install_List_Table extends WP_Themes_List_Table {
                </div>
 
                <?php
-               parent::tablenav( 'bottom' );
+               $this->tablenav( 'bottom' );
        }
 
-       function display_rows() {
+       /**
+        * @access public
+        */
+       public function display_rows() {
                $themes = $this->items;
                foreach ( $themes as $theme ) {
                                ?>
@@ -198,6 +226,8 @@ class WP_Theme_Install_List_Table extends WP_Themes_List_Table {
        /**
         * Prints a theme from the WordPress.org API.
         *
+        * @global array $themes_allowedtags
+        *
         * @param object $theme An object that contains theme data returned by the WordPress.org API.
         *
         * Example theme data:
@@ -211,10 +241,10 @@ class WP_Theme_Install_List_Table extends WP_Themes_List_Table {
         *     public 'rating' => float 80
         *     public 'num_ratings' => int 1
         *     public 'homepage' => string 'http://wordpress.org/themes/magazine-basic'
-        *     public 'description' => string 'A basic magazine style layout with a fully customizable layout through a backend interface. Designed by <a href="http://bavotasan.com">c.bavota</a> of <a href="http://tinkerpriestmedia.com">Tinker Priest Media</a>.'
+        *     public 'description' => string 'A basic magazine style layout with a fully customizable layout through a back-end interface. Designed by <a href="http://bavotasan.com">c.bavota</a> of <a href="http://tinkerpriestmedia.com">Tinker Priest Media</a>.'
         *     public 'download_link' => string 'http://wordpress.org/themes/download/magazine-basic.1.1.zip'
         */
-       function single_row( $theme ) {
+       public function single_row( $theme ) {
                global $themes_allowedtags;
 
                if ( empty( $theme ) )
@@ -244,10 +274,6 @@ class WP_Theme_Install_List_Table extends WP_Themes_List_Table {
                $status = $this->_get_theme_status( $theme );
 
                switch ( $status ) {
-                       default:
-                       case 'install':
-                               $actions[] = '<a class="install-now" href="' . esc_url( wp_nonce_url( $install_url, 'install-theme_' . $theme->slug ) ) . '" title="' . esc_attr( sprintf( __( 'Install %s' ), $name ) ) . '">' . __( 'Install Now' ) . '</a>';
-                               break;
                        case 'update_available':
                                $actions[] = '<a class="install-now" href="' . esc_url( wp_nonce_url( $update_url, 'upgrade-theme_' . $theme->slug ) ) . '" title="' . esc_attr( sprintf( __( 'Update to version %s' ), $theme->version ) ) . '">' . __( 'Update' ) . '</a>';
                                break;
@@ -255,12 +281,16 @@ class WP_Theme_Install_List_Table extends WP_Themes_List_Table {
                        case 'latest_installed':
                                $actions[] = '<span class="install-now" title="' . esc_attr__( 'This theme is already installed and is up to date' ) . '">' . _x( 'Installed', 'theme' ) . '</span>';
                                break;
+                       case 'install':
+                       default:
+                               $actions[] = '<a class="install-now" href="' . esc_url( wp_nonce_url( $install_url, 'install-theme_' . $theme->slug ) ) . '" title="' . esc_attr( sprintf( __( 'Install %s' ), $name ) ) . '">' . __( 'Install Now' ) . '</a>';
+                               break;
                }
 
                $actions[] = '<a class="install-theme-preview" href="' . esc_url( $preview_url ) . '" title="' . esc_attr( sprintf( __( 'Preview %s' ), $name ) ) . '">' . __( 'Preview' ) . '</a>';
 
                /**
-                * Filter the install action links for a theme in the Install Themes list table.
+                * Filters the install action links for a theme in the Install Themes list table.
                 *
                 * @since 3.4.0
                 *
@@ -272,7 +302,7 @@ class WP_Theme_Install_List_Table extends WP_Themes_List_Table {
 
                ?>
                <a class="screenshot install-theme-preview" href="<?php echo esc_url( $preview_url ); ?>" title="<?php echo esc_attr( $preview_title ); ?>">
-                       <img src='<?php echo esc_url( $theme->screenshot_url ); ?>' width='150' />
+                       <img src="<?php echo esc_url( $theme->screenshot_url ); ?>" width="150" alt="" />
                </a>
 
                <h3><?php echo $name; ?></h3>
@@ -294,7 +324,7 @@ class WP_Theme_Install_List_Table extends WP_Themes_List_Table {
        /**
         * Prints the wrapper for the theme installer.
         */
-       function theme_installer() {
+       public function theme_installer() {
                ?>
                <div id="theme-installer" class="wp-full-overlay expanded">
                        <div class="wp-full-overlay-sidebar">
@@ -306,10 +336,10 @@ class WP_Theme_Install_List_Table extends WP_Themes_List_Table {
                                        <div class="install-theme-info"></div>
                                </div>
                                <div class="wp-full-overlay-footer">
-                                       <a href="#" class="collapse-sidebar" title="<?php esc_attr_e('Collapse Sidebar'); ?>">
-                                               <span class="collapse-sidebar-label"><?php _e('Collapse'); ?></span>
+                                       <button type="button" class="collapse-sidebar button-secondary" aria-expanded="true" aria-label="<?php esc_attr_e( 'Collapse Sidebar' ); ?>">
                                                <span class="collapse-sidebar-arrow"></span>
-                                       </a>
+                                               <span class="collapse-sidebar-label"><?php _e( 'Collapse' ); ?></span>
+                                       </button>
                                </div>
                        </div>
                        <div class="wp-full-overlay-main"></div>
@@ -323,7 +353,7 @@ class WP_Theme_Install_List_Table extends WP_Themes_List_Table {
         *
         * @param object $theme - A WordPress.org Theme API object.
         */
-       function theme_installer_single( $theme ) {
+       public function theme_installer_single( $theme ) {
                ?>
                <div id="theme-installer" class="wp-full-overlay single-theme">
                        <div class="wp-full-overlay-sidebar">
@@ -339,9 +369,11 @@ class WP_Theme_Install_List_Table extends WP_Themes_List_Table {
        /**
         * Prints the info for a theme (to be used in the theme installer modal).
         *
+        * @global array $themes_allowedtags
+        *
         * @param object $theme - A WordPress.org Theme API object.
         */
-       function install_theme_info( $theme ) {
+       public function install_theme_info( $theme ) {
                global $themes_allowedtags;
 
                if ( empty( $theme ) )
@@ -350,8 +382,6 @@ class WP_Theme_Install_List_Table extends WP_Themes_List_Table {
                $name   = wp_kses( $theme->name,   $themes_allowedtags );
                $author = wp_kses( $theme->author, $themes_allowedtags );
 
-               $num_ratings = sprintf( _n( '(based on %s rating)', '(based on %s ratings)', $theme->num_ratings ), number_format_i18n( $theme->num_ratings ) );
-
                $install_url = add_query_arg( array(
                        'action' => 'install-theme',
                        'theme'  => $theme->slug,
@@ -367,10 +397,6 @@ class WP_Theme_Install_List_Table extends WP_Themes_List_Table {
                ?>
                <div class="install-theme-info"><?php
                        switch ( $status ) {
-                               default:
-                               case 'install':
-                                       echo '<a class="theme-install button-primary" href="' . esc_url( wp_nonce_url( $install_url, 'install-theme_' . $theme->slug ) ) . '">' . __( 'Install' ) . '</a>';
-                                       break;
                                case 'update_available':
                                        echo '<a class="theme-install button-primary" href="' . esc_url( wp_nonce_url( $update_url, 'upgrade-theme_' . $theme->slug ) ) . '" title="' . esc_attr( sprintf( __( 'Update to version %s' ), $theme->version ) ) . '">' . __( 'Update' ) . '</a>';
                                        break;
@@ -378,11 +404,15 @@ class WP_Theme_Install_List_Table extends WP_Themes_List_Table {
                                case 'latest_installed':
                                        echo '<span class="theme-install" title="' . esc_attr__( 'This theme is already installed and is up to date' ) . '">' . _x( 'Installed', 'theme' ) . '</span>';
                                        break;
+                               case 'install':
+                               default:
+                                       echo '<a class="theme-install button-primary" href="' . esc_url( wp_nonce_url( $install_url, 'install-theme_' . $theme->slug ) ) . '">' . __( 'Install' ) . '</a>';
+                                       break;
                        } ?>
                        <h3 class="theme-name"><?php echo $name; ?></h3>
                        <span class="theme-by"><?php printf( __( 'By %s' ), $author ); ?></span>
                        <?php if ( isset( $theme->screenshot_url ) ): ?>
-                               <img class="theme-screenshot" src="<?php echo esc_url( $theme->screenshot_url ); ?>" />
+                               <img class="theme-screenshot" src="<?php echo esc_url( $theme->screenshot_url ); ?>" alt="" />
                        <?php endif; ?>
                        <div class="theme-details">
                                <?php wp_star_rating( array( 'rating' => $theme->rating, 'type' => 'percent', 'number' => $theme->num_ratings ) ); ?>
@@ -403,12 +433,14 @@ class WP_Theme_Install_List_Table extends WP_Themes_List_Table {
         * Send required variables to JavaScript land
         *
         * @since 3.4.0
-        * @access private
+        * @access public
+        *
+        * @global string $tab  Current tab within Themes->Install screen
+        * @global string $type Type of search.
         *
-        * @uses $tab Global; current tab within Themes->Install screen
-        * @uses $type Global; type of search.
+        * @param array $extra_args Unused.
         */
-       function _js_vars( $extra_args = array() ) {
+       public function _js_vars( $extra_args = array() ) {
                global $tab, $type;
                parent::_js_vars( compact( 'tab', 'type' ) );
        }