]> scripts.mit.edu Git - autoinstalls/wordpress.git/blobdiff - wp-admin/includes/class-wp-ms-themes-list-table.php
WordPress 4.1.3
[autoinstalls/wordpress.git] / wp-admin / includes / class-wp-ms-themes-list-table.php
index 73045dbfc58de41ea8eabe7500c2f3cbfaf24f93..985d9bc54a62812886804cbce4a6d2492638ae0a 100644 (file)
@@ -9,10 +9,20 @@
  */
 class WP_MS_Themes_List_Table extends WP_List_Table {
 
-       var $site_id;
-       var $is_site_themes;
-
-       function __construct( $args = array() ) {
+       public $site_id;
+       public $is_site_themes;
+
+       /**
+        * Constructor.
+        *
+        * @since 3.1.0
+        * @access public
+        *
+        * @see WP_List_Table::__construct() for more information on default arguments.
+        *
+        * @param array $args An associative array of arguments.
+        */
+       public function __construct( $args = array() ) {
                global $status, $page;
 
                parent::__construct( array(
@@ -32,23 +42,32 @@ class WP_MS_Themes_List_Table extends WP_List_Table {
                        $this->site_id = isset( $_REQUEST['id'] ) ? intval( $_REQUEST['id'] ) : 0;
        }
 
-       function get_table_classes() {
-               return array( 'widefat', 'plugins' );   // todo: remove and add CSS for .themes
+       protected function get_table_classes() {
+               // todo: remove and add CSS for .themes
+               return array( 'widefat', 'plugins' );
        }
 
-       function ajax_user_can() {
+       public function ajax_user_can() {
                if ( $this->is_site_themes )
                        return current_user_can( 'manage_sites' );
                else
                        return current_user_can( 'manage_network_themes' );
        }
 
-       function prepare_items() {
+       public function prepare_items() {
                global $status, $totals, $page, $orderby, $order, $s;
 
                wp_reset_vars( array( 'orderby', 'order', 's' ) );
 
                $themes = array(
+                       /**
+                        * Filter the full array of WP_Theme objects to list in the Multisite
+                        * themes list table.
+                        *
+                        * @since 3.1.0
+                        *
+                        * @param array $all An array of WP_Theme objects to display in the list table.
+                        */
                        'all' => apply_filters( 'all_themes', wp_get_themes() ),
                        'search' => array(),
                        'enabled' => array(),
@@ -123,7 +142,12 @@ class WP_MS_Themes_List_Table extends WP_List_Table {
                ) );
        }
 
-       function _search_callback( $theme ) {
+       /**
+        * @staticvar string $term
+        * @param WP_Theme $theme
+        * @return bool
+        */
+       public function _search_callback( $theme ) {
                static $term;
                if ( is_null( $term ) )
                        $term = wp_unslash( $_REQUEST['s'] );
@@ -144,7 +168,14 @@ class WP_MS_Themes_List_Table extends WP_List_Table {
        }
 
        // Not used by any core columns.
-       function _order_callback( $theme_a, $theme_b ) {
+       /**
+        * @global string $orderby
+        * @global string $order
+        * @param array $theme_a
+        * @param array $theme_b
+        * @return int
+        */
+       public function _order_callback( $theme_a, $theme_b ) {
                global $orderby, $order;
 
                $a = $theme_a[ $orderby ];
@@ -159,14 +190,14 @@ class WP_MS_Themes_List_Table extends WP_List_Table {
                        return ( $a < $b ) ? -1 : 1;
        }
 
-       function no_items() {
+       public function no_items() {
                if ( ! $this->has_items )
                        _e( 'No themes found.' );
                else
                        _e( 'You do not appear to have any themes available at this time.' );
        }
 
-       function get_columns() {
+       public function get_columns() {
                global $status;
 
                return array(
@@ -176,13 +207,13 @@ class WP_MS_Themes_List_Table extends WP_List_Table {
                );
        }
 
-       function get_sortable_columns() {
+       protected function get_sortable_columns() {
                return array(
                        'name'         => 'name',
                );
        }
 
-       function get_views() {
+       protected function get_views() {
                global $totals, $status;
 
                $status_links = array();
@@ -225,7 +256,7 @@ class WP_MS_Themes_List_Table extends WP_List_Table {
                return $status_links;
        }
 
-       function get_bulk_actions() {
+       protected function get_bulk_actions() {
                global $status;
 
                $actions = array();
@@ -242,12 +273,19 @@ class WP_MS_Themes_List_Table extends WP_List_Table {
                return $actions;
        }
 
-       function display_rows() {
+       public function display_rows() {
                foreach ( $this->items as $theme )
                        $this->single_row( $theme );
        }
 
-       function single_row( $theme ) {
+       /**
+        * @global string $status
+        * @global int $page
+        * @global string $s
+        * @global array $totals
+        * @param WP_Theme $theme
+        */
+       public function single_row( $theme ) {
                global $status, $page, $s, $totals;
 
                $context = $status;
@@ -260,7 +298,7 @@ class WP_MS_Themes_List_Table extends WP_List_Table {
                        $allowed = $theme->is_allowed( 'network' );
                }
 
-               // preorder
+               // Pre-order.
                $actions = array(
                        'enable' => '',
                        'disable' => '',
@@ -284,7 +322,44 @@ class WP_MS_Themes_List_Table extends WP_List_Table {
                if ( ! $allowed && current_user_can( 'delete_themes' ) && ! $this->is_site_themes && $stylesheet != get_option( 'stylesheet' ) && $stylesheet != get_option( 'template' ) )
                        $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>';
 
+               /**
+                * Filter the action links displayed for each theme in the Multisite
+                * themes list table.
+                *
+                * The action links displayed are determined by the theme's status, and
+                * which Multisite themes list table is being displayed - the Network
+                * themes list table (themes.php), which displays all installed themes,
+                * or the Site themes list table (site-themes.php), which displays the
+                * non-network enabled themes when editing a site in the Network admin.
+                *
+                * The default action links for the Network themes list table include
+                * 'Network Enable', 'Network Disable', 'Edit', and 'Delete'.
+                *
+                * The default action links for the Site themes list table include
+                * 'Enable', 'Disable', and 'Edit'.
+                *
+                * @since 2.8.0
+                *
+                * @param array    $actions An array of action links.
+                * @param WP_Theme $theme   The current WP_Theme object.
+                * @param string   $context Status of the theme.
+                */
                $actions = apply_filters( 'theme_action_links', array_filter( $actions ), $theme, $context );
+
+               /**
+                * Filter the action links of a specific theme in the Multisite themes
+                * list table.
+                *
+                * The dynamic portion of the hook name, `$stylesheet`, refers to the
+                * directory name of the theme, which in most cases is synonymous
+                * with the template name.
+                *
+                * @since 3.1.0
+                *
+                * @param array    $actions An array of action links.
+                * @param WP_Theme $theme   The current WP_Theme object.
+                * @param string   $context Status of the theme.
+                */
                $actions = apply_filters( "theme_action_links_$stylesheet", $actions, $theme, $context );
 
                $class = ! $allowed ? 'inactive' : 'active';
@@ -317,7 +392,7 @@ class WP_MS_Themes_List_Table extends WP_List_Table {
                                case 'description':
                                        echo "<td class='column-description desc'$style>";
                                        if ( $theme->errors() ) {
-                                               $pre = $status == 'broken' ? '' : __( 'Broken Theme:' ) . ' ';
+                                               $pre = $status == 'broken' ? __( 'Broken Theme:' ) . ' ' : '';
                                                echo '<p><strong class="attention">' . $pre . $theme->errors()->get_error_message() . '</strong></p>';
                                        }
                                        echo "<div class='theme-description'><p>" . $theme->display( 'Description' ) . "</p></div>
@@ -333,6 +408,19 @@ class WP_MS_Themes_List_Table extends WP_List_Table {
                                        if ( $theme->get('ThemeURI') )
                                                $theme_meta[] = '<a href="' . $theme->display('ThemeURI') . '" title="' . esc_attr__( 'Visit theme homepage' ) . '">' . __( 'Visit Theme Site' ) . '</a>';
 
+                                       /**
+                                        * Filter the array of row meta for each theme in the Multisite themes
+                                        * list table.
+                                        *
+                                        * @since 3.1.0
+                                        *
+                                        * @param array    $theme_meta An array of the theme's metadata,
+                                        *                             including the version, author, and
+                                        *                             theme URI.
+                                        * @param string   $stylesheet Directory name of the theme.
+                                        * @param WP_Theme $theme      WP_Theme object.
+                                        * @param string   $status     Status of the theme.
+                                        */
                                        $theme_meta = apply_filters( 'theme_row_meta', $theme_meta, $stylesheet, $theme, $status );
                                        echo implode( ' | ', $theme_meta );
 
@@ -341,6 +429,16 @@ class WP_MS_Themes_List_Table extends WP_List_Table {
 
                                default:
                                        echo "<td class='$column_name column-$column_name'$style>";
+
+                                       /**
+                                        * Fires inside each custom column of the Multisite themes list table.
+                                        *
+                                        * @since 3.1.0
+                                        *
+                                        * @param string   $column_name Name of the column.
+                                        * @param string   $stylesheet  Directory name of the theme.
+                                        * @param WP_Theme $theme       Current WP_Theme object.
+                                        */
                                        do_action( 'manage_themes_custom_column', $column_name, $stylesheet, $theme );
                                        echo "</td>";
                        }
@@ -350,7 +448,31 @@ class WP_MS_Themes_List_Table extends WP_List_Table {
 
                if ( $this->is_site_themes )
                        remove_action( "after_theme_row_$stylesheet", 'wp_theme_update_row' );
+
+               /**
+                * Fires after each row in the Multisite themes list table.
+                *
+                * @since 3.1.0
+                *
+                * @param string   $stylesheet Directory name of the theme.
+                * @param WP_Theme $theme      Current WP_Theme object.
+                * @param string   $status     Status of the theme.
+                */
                do_action( 'after_theme_row', $stylesheet, $theme, $status );
+
+               /**
+                * Fires after each specific row in the Multisite themes list table.
+                *
+                * The dynamic portion of the hook name, `$stylesheet`, refers to the
+                * directory name of the theme, most often synonymous with the template
+                * name of the theme.
+                *
+                * @since 3.5.0
+                *
+                * @param string   $stylesheet Directory name of the theme.
+                * @param WP_Theme $theme      Current WP_Theme object.
+                * @param string   $status     Status of the theme.
+                */
                do_action( "after_theme_row_$stylesheet", $stylesheet, $theme, $status );
        }
 }