WordPress 4.5
[autoinstalls/wordpress.git] / wp-admin / includes / class-wp-links-list-table.php
index e1c5f18b1b20821c6ed6935bdbc3209e6502f1b1..e4560e480f65873d5e3aacb0aed0a24705301574 100644 (file)
@@ -1,26 +1,55 @@
 <?php
 /**
- * Links Manager List Table class.
+ * List Table API: WP_Links_List_Table class
  *
  * @package WordPress
- * @subpackage List_Table
+ * @subpackage Administration
+ * @since 3.1.0
+ */
+
+/**
+ * Core class used to implement displaying links in a list table.
+ *
  * @since 3.1.0
  * @access private
+ *
+ * @see WP_List_Tsble
  */
 class WP_Links_List_Table extends WP_List_Table {
 
-       function __construct( $args = array() ) {
+       /**
+        * 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() ) {
                parent::__construct( array(
                        'plural' => 'bookmarks',
                        'screen' => isset( $args['screen'] ) ? $args['screen'] : null,
                ) );
        }
 
-       function ajax_user_can() {
+       /**
+        *
+        * @return bool
+        */
+       public function ajax_user_can() {
                return current_user_can( 'manage_links' );
        }
 
-       function prepare_items() {
+       /**
+        *
+        * @global int    $cat_id
+        * @global string $s
+        * @global string $orderby
+        * @global string $order
+        */
+       public function prepare_items() {
                global $cat_id, $s, $orderby, $order;
 
                wp_reset_vars( array( 'action', 'cat_id', 'link_id', 'orderby', 'order', 's' ) );
@@ -39,18 +68,30 @@ class WP_Links_List_Table extends WP_List_Table {
                $this->items = get_bookmarks( $args );
        }
 
-       function no_items() {
+       /**
+        * @access public
+        */
+       public function no_items() {
                _e( 'No links found.' );
        }
 
-       function get_bulk_actions() {
+       /**
+        *
+        * @return array
+        */
+       protected function get_bulk_actions() {
                $actions = array();
                $actions['delete'] = __( 'Delete' );
 
                return $actions;
        }
 
-       function extra_tablenav( $which ) {
+       /**
+        *
+        * @global int $cat_id
+        * @param string $which
+        */
+       protected function extra_tablenav( $which ) {
                global $cat_id;
 
                if ( 'top' != $which )
@@ -62,20 +103,26 @@ class WP_Links_List_Table extends WP_List_Table {
                                'selected' => $cat_id,
                                'name' => 'cat_id',
                                'taxonomy' => 'link_category',
-                               'show_option_all' => __( 'View all categories' ),
+                               'show_option_all' => get_taxonomy( 'link_category' )->labels->all_items,
                                'hide_empty' => true,
                                'hierarchical' => 1,
                                'show_count' => 0,
                                'orderby' => 'name',
                        );
+
+                       echo '<label class="screen-reader-text" for="cat_id">' . __( 'Filter by category' ) . '</label>';
                        wp_dropdown_categories( $dropdown_options );
-                       submit_button( __( 'Filter' ), 'button', false, false, array( 'id' => 'post-query-submit' ) );
+                       submit_button( __( 'Filter' ), 'button', 'filter_action', false, array( 'id' => 'post-query-submit' ) );
 ?>
                </div>
 <?php
        }
 
-       function get_columns() {
+       /**
+        *
+        * @return array
+        */
+       public function get_columns() {
                return array(
                        'cb'         => '<input type="checkbox" />',
                        'name'       => _x( 'Name', 'link name' ),
@@ -87,7 +134,11 @@ class WP_Links_List_Table extends WP_List_Table {
                );
        }
 
-       function get_sortable_columns() {
+       /**
+        *
+        * @return array
+        */
+       protected function get_sortable_columns() {
                return array(
                        'name'    => 'name',
                        'url'     => 'url',
@@ -96,94 +147,187 @@ class WP_Links_List_Table extends WP_List_Table {
                );
        }
 
-       function display_rows() {
+       /**
+        * Get 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';
+       }
+
+       /**
+        * Handles the checkbox column output.
+        *
+        * @since 4.3.0
+        * @access public
+        *
+        * @param object $link The current link object.
+        */
+       public function column_cb( $link ) {
+               ?>
+               <label class="screen-reader-text" for="cb-select-<?php echo $link->link_id; ?>"><?php echo sprintf( __( 'Select %s' ), $link->link_name ); ?></label>
+               <input type="checkbox" name="linkcheck[]" id="cb-select-<?php echo $link->link_id; ?>" value="<?php echo esc_attr( $link->link_id ); ?>" />
+               <?php
+       }
+
+       /**
+        * Handles the link name column output.
+        *
+        * @since 4.3.0
+        * @access public
+        *
+        * @param object $link The current link object.
+        */
+       public function column_name( $link ) {
+               $edit_link = get_edit_bookmark_link( $link );
+               printf( '<strong><a class="row-title" href="%s" aria-label="%s">%s</a></strong>',
+                       $edit_link,
+                       /* translators: %s: link name */
+                       esc_attr( sprintf( __( 'Edit &#8220;%s&#8221;' ), $link->link_name ) ),
+                       $link->link_name
+               );
+       }
+
+       /**
+        * Handles the link URL column output.
+        *
+        * @since 4.3.0
+        * @access public
+        *
+        * @param object $link The current link object.
+        */
+       public function column_url( $link ) {
+               $short_url = url_shorten( $link->link_url );
+               echo "<a href='$link->link_url'>$short_url</a>";
+       }
+
+       /**
+        * Handles the link categories column output.
+        *
+        * @since 4.3.0
+        * @access public
+        *
+        * @global $cat_id
+        *
+        * @param object $link The current link object.
+        */
+       public function column_categories( $link ) {
                global $cat_id;
 
-               $alt = 0;
+               $cat_names = array();
+               foreach ( $link->link_category as $category ) {
+                       $cat = get_term( $category, 'link_category', OBJECT, 'display' );
+                       if ( is_wp_error( $cat ) ) {
+                               echo $cat->get_error_message();
+                       }
+                       $cat_name = $cat->name;
+                       if ( $cat_id != $category ) {
+                               $cat_name = "<a href='link-manager.php?cat_id=$category'>$cat_name</a>";
+                       }
+                       $cat_names[] = $cat_name;
+               }
+               echo implode( ', ', $cat_names );
+       }
 
-               foreach ( $this->items as $link ) {
-                       $link = sanitize_bookmark( $link );
-                       $link->link_name = esc_attr( $link->link_name );
-                       $link->link_category = wp_get_link_cats( $link->link_id );
+       /**
+        * Handles the link relation column output.
+        *
+        * @since 4.3.0
+        * @access public
+        *
+        * @param object $link The current link object.
+        */
+       public function column_rel( $link ) {
+               echo empty( $link->link_rel ) ? '<br />' : $link->link_rel;
+       }
 
-                       $short_url = url_shorten( $link->link_url );
+       /**
+        * Handles the link visibility column output.
+        *
+        * @since 4.3.0
+        * @access public
+        *
+        * @param object $link The current link object.
+        */
+       public function column_visible( $link ) {
+               if ( 'Y' === $link->link_visible ) {
+                       _e( 'Yes' );
+               } else {
+                       _e( 'No' );
+               }
+       }
 
-                       $visible = ( $link->link_visible == 'Y' ) ? __( 'Yes' ) : __( 'No' );
-                       $rating  = $link->link_rating;
-                       $style = ( $alt++ % 2 ) ? '' : ' class="alternate"';
+       /**
+        * Handles the link rating column output.
+        *
+        * @since 4.3.0
+        * @access public
+        *
+        * @param object $link The current link object.
+        */
+       public function column_rating( $link ) {
+               echo $link->link_rating;
+       }
 
-                       $edit_link = get_edit_bookmark_link( $link );
-?>
-               <tr id="link-<?php echo $link->link_id; ?>" valign="middle" <?php echo $style; ?>>
-<?php
+       /**
+        * Handles the default column output.
+        *
+        * @since 4.3.0
+        * @access public
+        *
+        * @param object $link        Link object.
+        * @param string $column_name Current column name.
+        */
+       public function column_default( $link, $column_name ) {
+               /**
+                * Fires for each registered custom link column.
+                *
+                * @since 2.1.0
+                *
+                * @param string $column_name Name of the custom column.
+                * @param int    $link_id     Link ID.
+                */
+               do_action( 'manage_link_custom_column', $column_name, $link->link_id );
+       }
 
-                       list( $columns, $hidden ) = $this->get_column_info();
-
-                       foreach ( $columns as $column_name => $column_display_name ) {
-                               $class = "class='column-$column_name'";
-
-                               $style = '';
-                               if ( in_array( $column_name, $hidden ) )
-                                       $style = ' style="display:none;"';
-
-                               $attributes = $class . $style;
-
-                               switch ( $column_name ) {
-                                       case 'cb': ?>
-                                               <th scope="row" class="check-column">
-                                                       <label class="screen-reader-text" for="cb-select-<?php echo $link->link_id; ?>"><?php echo sprintf( __( 'Select %s' ), $link->link_name ); ?></label>
-                                                       <input type="checkbox" name="linkcheck[]" id="cb-select-<?php echo $link->link_id; ?>" value="<?php echo esc_attr( $link->link_id ); ?>" />
-                                               </th>
-                                               <?php
-                                               break;
-
-                                       case 'name':
-                                               echo "<td $attributes><strong><a class='row-title' href='$edit_link' title='" . esc_attr( sprintf( __( 'Edit &#8220;%s&#8221;' ), $link->link_name ) ) . "'>$link->link_name</a></strong><br />";
-
-                                               $actions = array();
-                                               $actions['edit'] = '<a href="' . $edit_link . '">' . __( 'Edit' ) . '</a>';
-                                               $actions['delete'] = "<a class='submitdelete' href='" . wp_nonce_url( "link.php?action=delete&amp;link_id=$link->link_id", 'delete-bookmark_' . $link->link_id ) . "' onclick=\"if ( confirm( '" . esc_js( sprintf( __( "You are about to delete this link '%s'\n  'Cancel' to stop, 'OK' to delete." ), $link->link_name ) ) . "' ) ) { return true;}return false;\">" . __( 'Delete' ) . "</a>";
-                                               echo $this->row_actions( $actions );
-
-                                               echo '</td>';
-                                               break;
-                                       case 'url':
-                                               echo "<td $attributes><a href='$link->link_url' title='". esc_attr( sprintf( __( 'Visit %s' ), $link->link_name ) )."'>$short_url</a></td>";
-                                               break;
-                                       case 'categories':
-                                               ?><td <?php echo $attributes ?>><?php
-                                               $cat_names = array();
-                                               foreach ( $link->link_category as $category ) {
-                                                       $cat = get_term( $category, 'link_category', OBJECT, 'display' );
-                                                       if ( is_wp_error( $cat ) )
-                                                               echo $cat->get_error_message();
-                                                       $cat_name = $cat->name;
-                                                       if ( $cat_id != $category )
-                                                               $cat_name = "<a href='link-manager.php?cat_id=$category'>$cat_name</a>";
-                                                       $cat_names[] = $cat_name;
-                                               }
-                                               echo implode( ', ', $cat_names );
-                                               ?></td><?php
-                                               break;
-                                       case 'rel':
-                                               ?><td <?php echo $attributes ?>><?php echo empty( $link->link_rel ) ? '<br />' : $link->link_rel; ?></td><?php
-                                               break;
-                                       case 'visible':
-                                               ?><td <?php echo $attributes ?>><?php echo $visible; ?></td><?php
-                                               break;
-                                       case 'rating':
-                                               ?><td <?php echo $attributes ?>><?php echo $rating; ?></td><?php
-                                               break;
-                                       default:
-                                               ?>
-                                               <td <?php echo $attributes ?>><?php do_action( 'manage_link_custom_column', $column_name, $link->link_id ); ?></td>
-                                               <?php
-                                               break;
-                               }
-                       }
+       public function display_rows() {
+               foreach ( $this->items as $link ) {
+                       $link = sanitize_bookmark( $link );
+                       $link->link_name = esc_attr( $link->link_name );
+                       $link->link_category = wp_get_link_cats( $link->link_id );
 ?>
+               <tr id="link-<?php echo $link->link_id; ?>">
+                       <?php $this->single_row_columns( $link ) ?>
                </tr>
 <?php
                }
        }
+
+       /**
+        * Generates and displays row action links.
+        *
+        * @since 4.3.0
+        * @access protected
+        *
+        * @param object $link        Link being acted upon.
+        * @param string $column_name Current column name.
+        * @param string $primary     Primary column name.
+        * @return string Row action output for links.
+        */
+       protected function handle_row_actions( $link, $column_name, $primary ) {
+               if ( $primary !== $column_name ) {
+                       return '';
+               }
+
+               $edit_link = get_edit_bookmark_link( $link );
+
+               $actions = array();
+               $actions['edit'] = '<a href="' . $edit_link . '">' . __('Edit') . '</a>';
+               $actions['delete'] = "<a class='submitdelete' href='" . wp_nonce_url("link.php?action=delete&amp;link_id=$link->link_id", 'delete-bookmark_' . $link->link_id) . "' onclick=\"if ( confirm( '" . esc_js(sprintf(__("You are about to delete this link '%s'\n  'Cancel' to stop, 'OK' to delete."), $link->link_name)) . "' ) ) { return true;}return false;\">" . __('Delete') . "</a>";
+               return $this->row_actions( $actions );
+       }
 }