]> scripts.mit.edu Git - autoinstalls/wordpress.git/blobdiff - wp-admin/includes/class-wp-terms-list-table.php
WordPress 4.3.1
[autoinstalls/wordpress.git] / wp-admin / includes / class-wp-terms-list-table.php
index bf31468a6b37643b5c59ceee4c9a63bc7203c95b..a4c81afbe71f4e45ad0219ffd5dfcafc73e1059a 100644 (file)
@@ -9,9 +9,26 @@
  */
 class WP_Terms_List_Table extends WP_List_Table {
 
-       var $callback_args;
+       public $callback_args;
 
-       function __construct( $args = array() ) {
+       private $level;
+
+       /**
+        * Constructor.
+        *
+        * @since 3.1.0
+        * @access public
+        *
+        * @see WP_List_Table::__construct() for more information on default arguments.
+        *
+        * @global string $post_type
+        * @global string $taxonomy
+        * @global string $action
+        * @global object $tax
+        *
+        * @param array $args An associative array of arguments.
+        */
+       public function __construct( $args = array() ) {
                global $post_type, $taxonomy, $action, $tax;
 
                parent::__construct( array(
@@ -38,11 +55,18 @@ class WP_Terms_List_Table extends WP_List_Table {
 
        }
 
-       function ajax_user_can() {
+       /**
+        *
+        * @return bool
+        */
+       public function ajax_user_can() {
                return current_user_can( get_taxonomy( $this->screen->taxonomy )->cap->manage_terms );
        }
 
-       function prepare_items() {
+       /**
+        * @access public
+        */
+       public function prepare_items() {
                $tags_per_page = $this->get_items_per_page( 'edit_' . $this->screen->taxonomy . '_per_page' );
 
                if ( 'post_tag' == $this->screen->taxonomy ) {
@@ -97,26 +121,49 @@ class WP_Terms_List_Table extends WP_List_Table {
                ) );
        }
 
-       function has_items() {
+       /**
+        *
+        * @return bool
+        */
+       public function has_items() {
                // todo: populate $this->items in prepare_items()
                return true;
        }
 
-       function get_bulk_actions() {
+       /**
+        * @access public
+        */
+       public function no_items() {
+               echo get_taxonomy( $this->screen->taxonomy )->labels->not_found;
+       }
+
+       /**
+        *
+        * @return array
+        */
+       protected function get_bulk_actions() {
                $actions = array();
                $actions['delete'] = __( 'Delete' );
 
                return $actions;
        }
 
-       function current_action() {
+       /**
+        *
+        * @return string
+        */
+       public function current_action() {
                if ( isset( $_REQUEST['action'] ) && isset( $_REQUEST['delete_tags'] ) && ( 'delete' == $_REQUEST['action'] || 'delete' == $_REQUEST['action2'] ) )
                        return 'bulk-delete';
 
                return parent::current_action();
        }
 
-       function get_columns() {
+       /**
+        *
+        * @return array
+        */
+       public function get_columns() {
                $columns = array(
                        'cb'          => '<input type="checkbox" />',
                        'name'        => _x( 'Name', 'term name' ),
@@ -127,14 +174,17 @@ class WP_Terms_List_Table extends WP_List_Table {
                if ( 'link_category' == $this->screen->taxonomy ) {
                        $columns['links'] = __( 'Links' );
                } else {
-                       $post_type_object = get_post_type_object( $this->screen->post_type );
-                       $columns['posts'] = $post_type_object ? $post_type_object->labels->name : __( 'Posts' );
+                       $columns['posts'] = _x( 'Count', 'Number/count of items' );
                }
 
                return $columns;
        }
 
-       function get_sortable_columns() {
+       /**
+        *
+        * @return array
+        */
+       protected function get_sortable_columns() {
                return array(
                        'name'        => 'name',
                        'description' => 'description',
@@ -144,7 +194,10 @@ class WP_Terms_List_Table extends WP_List_Table {
                );
        }
 
-       function display_rows_or_placeholder() {
+       /**
+        * @access public
+        */
+       public function display_rows_or_placeholder() {
                $taxonomy = $this->screen->taxonomy;
 
                $args = wp_parse_args( $this->callback_args, array(
@@ -154,46 +207,55 @@ class WP_Terms_List_Table extends WP_List_Table {
                        'hide_empty' => 0
                ) );
 
-               extract( $args, EXTR_SKIP );
+               $page = $args['page'];
+
+               // Set variable because $args['number'] can be subsequently overridden.
+               $number = $args['number'];
 
                $args['offset'] = $offset = ( $page - 1 ) * $number;
 
-               // convert it to table rows
+               // Convert it to table rows.
                $count = 0;
 
-               $terms = array();
-
-               if ( is_taxonomy_hierarchical( $taxonomy ) && !isset( $orderby ) ) {
+               if ( is_taxonomy_hierarchical( $taxonomy ) && ! isset( $args['orderby'] ) ) {
                        // We'll need the full set of terms then.
                        $args['number'] = $args['offset'] = 0;
                }
                $terms = get_terms( $taxonomy, $args );
 
-               if ( empty( $terms ) ) {
-                       list( $columns, $hidden ) = $this->get_column_info();
+               if ( empty( $terms ) || ! is_array( $terms ) ) {
                        echo '<tr class="no-items"><td class="colspanchange" colspan="' . $this->get_column_count() . '">';
                        $this->no_items();
                        echo '</td></tr>';
                        return;
                }
 
-               if ( is_taxonomy_hierarchical( $taxonomy ) && !isset( $orderby ) ) {
-                       if ( !empty( $search ) ) // Ignore children on searches.
+               if ( is_taxonomy_hierarchical( $taxonomy ) && ! isset( $args['orderby'] ) ) {
+                       if ( ! empty( $args['search'] ) ) {// Ignore children on searches.
                                $children = array();
-                       else
+                       } else {
                                $children = _get_term_hierarchy( $taxonomy );
-
+                       }
                        // Some funky recursion to get the job done( Paging & parents mainly ) is contained within, Skip it for non-hierarchical taxonomies for performance sake
                        $this->_rows( $taxonomy, $terms, $children, $offset, $number, $count );
                } else {
-                       $terms = get_terms( $taxonomy, $args );
-                       foreach ( $terms as $term )
+                       foreach ( $terms as $term ) {
                                $this->single_row( $term );
-                       $count = $number; // Only displaying a single page.
+                       }
                }
        }
 
-       function _rows( $taxonomy, $terms, &$children, $start, $per_page, &$count, $parent = 0, $level = 0 ) {
+       /**
+        * @param string $taxonomy
+        * @param array $terms
+        * @param array $children
+        * @param int   $start
+        * @param int   $per_page
+        * @param int   $count
+        * @param int   $parent
+        * @param int   $level
+        */
+       private function _rows( $taxonomy, $terms, &$children, $start, $per_page, &$count, $parent = 0, $level = 0 ) {
 
                $end = $start + $per_page;
 
@@ -241,18 +303,27 @@ class WP_Terms_List_Table extends WP_List_Table {
                }
        }
 
-       function single_row( $tag, $level = 0 ) {
-               static $row_class = '';
-               $row_class = ( $row_class == '' ? ' class="alternate"' : '' );
+       /**
+        * @global string $taxonomy
+        * @param object $tag
+        * @param int $level
+        */
+       public function single_row( $tag, $level = 0 ) {
+               global $taxonomy;
+               $tag = sanitize_term( $tag, $taxonomy );
 
                $this->level = $level;
 
-               echo '<tr id="tag-' . $tag->term_id . '"' . $row_class . '>';
+               echo '<tr id="tag-' . $tag->term_id . '">';
                $this->single_row_columns( $tag );
                echo '</tr>';
        }
 
-       function column_cb( $tag ) {
+       /**
+        * @param object $tag
+        * @return string
+        */
+       public function column_cb( $tag ) {
                $default_term = get_option( 'default_' . $this->screen->taxonomy );
 
                if ( current_user_can( get_taxonomy( $this->screen->taxonomy )->cap->delete_terms ) && $tag->term_id != $default_term )
@@ -262,11 +333,12 @@ class WP_Terms_List_Table extends WP_List_Table {
                return '&nbsp;';
        }
 
-       function column_name( $tag ) {
+       /**
+        * @param object $tag
+        * @return string
+        */
+       public function column_name( $tag ) {
                $taxonomy = $this->screen->taxonomy;
-               $tax = get_taxonomy( $taxonomy );
-
-               $default_term = get_option( 'default_' . $taxonomy );
 
                $pad = str_repeat( '&#8212; ', max( 0, $this->level ) );
 
@@ -290,6 +362,50 @@ class WP_Terms_List_Table extends WP_List_Table {
 
                $out = '<strong><a class="row-title" href="' . $edit_link . '" title="' . esc_attr( sprintf( __( 'Edit &#8220;%s&#8221;' ), $name ) ) . '">' . $name . '</a></strong><br />';
 
+               $out .= '<div class="hidden" id="inline_' . $qe_data->term_id . '">';
+               $out .= '<div class="name">' . $qe_data->name . '</div>';
+
+               /** This filter is documented in wp-admin/edit-tag-form.php */
+               $out .= '<div class="slug">' . apply_filters( 'editable_slug', $qe_data->slug ) . '</div>';
+               $out .= '<div class="parent">' . $qe_data->parent . '</div></div>';
+
+               return $out;
+       }
+
+       /**
+        * Gets the name of the default primary column.
+        *
+        * @since 4.3.0
+        * @access protected
+        *
+        * @return string Name of the default primary column, in this case, 'name'.
+        */
+       protected function get_default_primary_column_name() {
+               return 'name';
+       }
+
+       /**
+        * Generates and displays row action links.
+        *
+        * @since 4.3.0
+        * @access protected
+        *
+        * @param object $tag         Tag being acted upon.
+        * @param string $column_name Current column name.
+        * @param string $primary     Primary column name.
+        * @return string Row actions output for terms.
+        */
+       protected function handle_row_actions( $tag, $column_name, $primary ) {
+               if ( $primary !== $column_name ) {
+                       return '';
+               }
+
+               $taxonomy = $this->screen->taxonomy;
+               $tax = get_taxonomy( $taxonomy );
+               $default_term = get_option( 'default_' . $taxonomy );
+
+               $edit_link = esc_url( get_edit_term_link( $tag->term_id, $taxonomy, $this->screen->post_type ) );
+
                $actions = array();
                if ( current_user_can( $tax->cap->edit_terms ) ) {
                        $actions['edit'] = '<a href="' . $edit_link . '">' . __( 'Edit' ) . '</a>';
@@ -315,7 +431,7 @@ class WP_Terms_List_Table extends WP_List_Table {
                /**
                 * Filter the action links displayed for each term in the terms list table.
                 *
-                * The dynamic portion of the hook name, $taxonomy, refers to the taxonomy slug.
+                * The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
                 *
                 * @since 3.0.0
                 *
@@ -325,27 +441,31 @@ class WP_Terms_List_Table extends WP_List_Table {
                 */
                $actions = apply_filters( "{$taxonomy}_row_actions", $actions, $tag );
 
-               $out .= $this->row_actions( $actions );
-               $out .= '<div class="hidden" id="inline_' . $qe_data->term_id . '">';
-               $out .= '<div class="name">' . $qe_data->name . '</div>';
-
-               /** This filter is documented in wp-admin/edit-tag-form.php */
-               $out .= '<div class="slug">' . apply_filters( 'editable_slug', $qe_data->slug ) . '</div>';
-               $out .= '<div class="parent">' . $qe_data->parent . '</div></div>';
-
-               return $out;
+               return $this->row_actions( $actions );
        }
 
-       function column_description( $tag ) {
+       /**
+        * @param object $tag
+        * @return string
+        */
+       public function column_description( $tag ) {
                return $tag->description;
        }
 
-       function column_slug( $tag ) {
+       /**
+        * @param object $tag
+        * @return string
+        */
+       public function column_slug( $tag ) {
                /** This filter is documented in wp-admin/edit-tag-form.php */
                return apply_filters( 'editable_slug', $tag->slug );
        }
 
-       function column_posts( $tag ) {
+       /**
+        * @param object $tag
+        * @return string
+        */
+       public function column_posts( $tag ) {
                $count = number_format_i18n( $tag->count );
 
                $tax = get_taxonomy( $this->screen->taxonomy );
@@ -369,18 +489,27 @@ class WP_Terms_List_Table extends WP_List_Table {
                return "<a href='" . esc_url ( add_query_arg( $args, 'edit.php' ) ) . "'>$count</a>";
        }
 
-       function column_links( $tag ) {
+       /**
+        * @param object $tag
+        * @return string
+        */
+       public function column_links( $tag ) {
                $count = number_format_i18n( $tag->count );
                if ( $count )
                        $count = "<a href='link-manager.php?cat_id=$tag->term_id'>$count</a>";
                return $count;
        }
 
-       function column_default( $tag, $column_name ) {
+       /**
+        * @param object $tag
+        * @param string $column_name
+        * @return string
+        */
+       public function column_default( $tag, $column_name ) {
                /**
                 * Filter the displayed columns in the terms list table.
                 *
-                * The dynamic portion of the hook name, $this->screen->taxonomy,
+                * The dynamic portion of the hook name, `$this->screen->taxonomy`,
                 * refers to the slug of the current taxonomy.
                 *
                 * @since 2.8.0
@@ -397,14 +526,14 @@ class WP_Terms_List_Table extends WP_List_Table {
         *
         * @since 3.1.0
         */
-       function inline_edit() {
+       public function inline_edit() {
                $tax = get_taxonomy( $this->screen->taxonomy );
 
                if ( ! current_user_can( $tax->cap->edit_terms ) )
                        return;
 ?>
 
-       <form method="get" action=""><table style="display: none"><tbody id="inlineedit">
+       <form method="get"><table style="display: none"><tbody id="inlineedit">
                <tr id="inline-edit" class="inline-edit-row" style="display: none"><td colspan="<?php echo $this->get_column_count(); ?>" class="colspanchange">
 
                        <fieldset><div class="inline-edit-col">
@@ -438,8 +567,8 @@ class WP_Terms_List_Table extends WP_List_Table {
        ?>
 
                <p class="inline-edit-save submit">
-                       <a accesskey="c" href="#inline-edit" class="cancel button-secondary alignleft"><?php _e( 'Cancel' ); ?></a>
-                       <a accesskey="s" href="#inline-edit" class="save button-primary alignright"><?php echo $tax->labels->update_item; ?></a>
+                       <a href="#inline-edit" class="cancel button-secondary alignleft"><?php _e( 'Cancel' ); ?></a>
+                       <a href="#inline-edit" class="save button-primary alignright"><?php echo $tax->labels->update_item; ?></a>
                        <span class="spinner"></span>
                        <span class="error" style="display:none;"></span>
                        <?php wp_nonce_field( 'taxinlineeditnonce', '_inline_edit', false ); ?>