mirror of
https://github.com/WordPress/WordPress.git
synced 2024-12-25 10:38:11 +01:00
282e7c36eb
Introduces a simple way to give a proper semantics of `button` to links that behave like UI controls when JavaScript is on and behave like actual links when JavaScript is off. First implementation on the Terms list table. Patch prepared during WordCamp US 2015 Contributor Day. Props mcapybara, garusky, takayukister. See #26504. Fixes #34867. Built from https://develop.svn.wordpress.org/trunk@35947 git-svn-id: http://core.svn.wordpress.org/trunk@35911 1a063a9b-81f0-0310-95a4-ce76da25c4cd
605 lines
17 KiB
PHP
605 lines
17 KiB
PHP
<?php
|
|
/**
|
|
* List Table API: WP_Terms_List_Table class
|
|
*
|
|
* @package WordPress
|
|
* @subpackage Administration
|
|
* @since 3.1.0
|
|
*/
|
|
|
|
/**
|
|
* Core class used to implement displaying terms in a list table.
|
|
*
|
|
* @since 3.1.0
|
|
* @access private
|
|
*
|
|
* @see WP_List_Table
|
|
*/
|
|
class WP_Terms_List_Table extends WP_List_Table {
|
|
|
|
public $callback_args;
|
|
|
|
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(
|
|
'plural' => 'tags',
|
|
'singular' => 'tag',
|
|
'screen' => isset( $args['screen'] ) ? $args['screen'] : null,
|
|
) );
|
|
|
|
$action = $this->screen->action;
|
|
$post_type = $this->screen->post_type;
|
|
$taxonomy = $this->screen->taxonomy;
|
|
|
|
if ( empty( $taxonomy ) )
|
|
$taxonomy = 'post_tag';
|
|
|
|
if ( ! taxonomy_exists( $taxonomy ) )
|
|
wp_die( __( 'Invalid taxonomy' ) );
|
|
|
|
$tax = get_taxonomy( $taxonomy );
|
|
|
|
// @todo Still needed? Maybe just the show_ui part.
|
|
if ( empty( $post_type ) || !in_array( $post_type, get_post_types( array( 'show_ui' => true ) ) ) )
|
|
$post_type = 'post';
|
|
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function ajax_user_can() {
|
|
return current_user_can( get_taxonomy( $this->screen->taxonomy )->cap->manage_terms );
|
|
}
|
|
|
|
/**
|
|
* @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 ) {
|
|
/**
|
|
* Filter the number of terms displayed per page for the Tags list table.
|
|
*
|
|
* @since 2.8.0
|
|
*
|
|
* @param int $tags_per_page Number of tags to be displayed. Default 20.
|
|
*/
|
|
$tags_per_page = apply_filters( 'edit_tags_per_page', $tags_per_page );
|
|
|
|
/**
|
|
* Filter the number of terms displayed per page for the Tags list table.
|
|
*
|
|
* @since 2.7.0
|
|
* @deprecated 2.8.0 Use edit_tags_per_page instead.
|
|
*
|
|
* @param int $tags_per_page Number of tags to be displayed. Default 20.
|
|
*/
|
|
$tags_per_page = apply_filters( 'tagsperpage', $tags_per_page );
|
|
} elseif ( 'category' === $this->screen->taxonomy ) {
|
|
/**
|
|
* Filter the number of terms displayed per page for the Categories list table.
|
|
*
|
|
* @since 2.8.0
|
|
*
|
|
* @param int $tags_per_page Number of categories to be displayed. Default 20.
|
|
*/
|
|
$tags_per_page = apply_filters( 'edit_categories_per_page', $tags_per_page );
|
|
}
|
|
|
|
$search = !empty( $_REQUEST['s'] ) ? trim( wp_unslash( $_REQUEST['s'] ) ) : '';
|
|
|
|
$args = array(
|
|
'search' => $search,
|
|
'page' => $this->get_pagenum(),
|
|
'number' => $tags_per_page,
|
|
);
|
|
|
|
if ( !empty( $_REQUEST['orderby'] ) )
|
|
$args['orderby'] = trim( wp_unslash( $_REQUEST['orderby'] ) );
|
|
|
|
if ( !empty( $_REQUEST['order'] ) )
|
|
$args['order'] = trim( wp_unslash( $_REQUEST['order'] ) );
|
|
|
|
$this->callback_args = $args;
|
|
|
|
$this->set_pagination_args( array(
|
|
'total_items' => wp_count_terms( $this->screen->taxonomy, compact( 'search' ) ),
|
|
'per_page' => $tags_per_page,
|
|
) );
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function has_items() {
|
|
// todo: populate $this->items in prepare_items()
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @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;
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @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();
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @return array
|
|
*/
|
|
public function get_columns() {
|
|
$columns = array(
|
|
'cb' => '<input type="checkbox" />',
|
|
'name' => _x( 'Name', 'term name' ),
|
|
'description' => __( 'Description' ),
|
|
'slug' => __( 'Slug' ),
|
|
);
|
|
|
|
if ( 'link_category' === $this->screen->taxonomy ) {
|
|
$columns['links'] = __( 'Links' );
|
|
} else {
|
|
$columns['posts'] = _x( 'Count', 'Number/count of items' );
|
|
}
|
|
|
|
return $columns;
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @return array
|
|
*/
|
|
protected function get_sortable_columns() {
|
|
return array(
|
|
'name' => 'name',
|
|
'description' => 'description',
|
|
'slug' => 'slug',
|
|
'posts' => 'count',
|
|
'links' => 'count'
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @access public
|
|
*/
|
|
public function display_rows_or_placeholder() {
|
|
$taxonomy = $this->screen->taxonomy;
|
|
|
|
$args = wp_parse_args( $this->callback_args, array(
|
|
'page' => 1,
|
|
'number' => 20,
|
|
'search' => '',
|
|
'hide_empty' => 0
|
|
) );
|
|
|
|
$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.
|
|
$count = 0;
|
|
|
|
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 ) || ! 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( $args['orderby'] ) ) {
|
|
if ( ! empty( $args['search'] ) ) {// Ignore children on searches.
|
|
$children = array();
|
|
} 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 {
|
|
foreach ( $terms as $term ) {
|
|
$this->single_row( $term );
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @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;
|
|
|
|
foreach ( $terms as $key => $term ) {
|
|
|
|
if ( $count >= $end )
|
|
break;
|
|
|
|
if ( $term->parent != $parent && empty( $_REQUEST['s'] ) )
|
|
continue;
|
|
|
|
// If the page starts in a subtree, print the parents.
|
|
if ( $count == $start && $term->parent > 0 && empty( $_REQUEST['s'] ) ) {
|
|
$my_parents = $parent_ids = array();
|
|
$p = $term->parent;
|
|
while ( $p ) {
|
|
$my_parent = get_term( $p, $taxonomy );
|
|
$my_parents[] = $my_parent;
|
|
$p = $my_parent->parent;
|
|
if ( in_array( $p, $parent_ids ) ) // Prevent parent loops.
|
|
break;
|
|
$parent_ids[] = $p;
|
|
}
|
|
unset( $parent_ids );
|
|
|
|
$num_parents = count( $my_parents );
|
|
while ( $my_parent = array_pop( $my_parents ) ) {
|
|
echo "\t";
|
|
$this->single_row( $my_parent, $level - $num_parents );
|
|
$num_parents--;
|
|
}
|
|
}
|
|
|
|
if ( $count >= $start ) {
|
|
echo "\t";
|
|
$this->single_row( $term, $level );
|
|
}
|
|
|
|
++$count;
|
|
|
|
unset( $terms[$key] );
|
|
|
|
if ( isset( $children[$term->term_id] ) && empty( $_REQUEST['s'] ) )
|
|
$this->_rows( $taxonomy, $terms, $children, $start, $per_page, $count, $term->term_id, $level + 1 );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @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 . '">';
|
|
$this->single_row_columns( $tag );
|
|
echo '</tr>';
|
|
}
|
|
|
|
/**
|
|
* @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 )
|
|
return '<label class="screen-reader-text" for="cb-select-' . $tag->term_id . '">' . sprintf( __( 'Select %s' ), $tag->name ) . '</label>'
|
|
. '<input type="checkbox" name="delete_tags[]" value="' . $tag->term_id . '" id="cb-select-' . $tag->term_id . '" />';
|
|
|
|
return ' ';
|
|
}
|
|
|
|
/**
|
|
* @param object $tag
|
|
* @return string
|
|
*/
|
|
public function column_name( $tag ) {
|
|
$taxonomy = $this->screen->taxonomy;
|
|
|
|
$pad = str_repeat( '— ', max( 0, $this->level ) );
|
|
|
|
/**
|
|
* Filter display of the term name in the terms list table.
|
|
*
|
|
* The default output may include padding due to the term's
|
|
* current level in the term hierarchy.
|
|
*
|
|
* @since 2.5.0
|
|
*
|
|
* @see WP_Terms_List_Table::column_name()
|
|
*
|
|
* @param string $pad_tag_name The term name, padded if not top-level.
|
|
* @param object $tag Term object.
|
|
*/
|
|
$name = apply_filters( 'term_name', $pad . ' ' . $tag->name, $tag );
|
|
|
|
$qe_data = get_term( $tag->term_id, $taxonomy, OBJECT, 'edit' );
|
|
|
|
$uri = ( defined( 'DOING_AJAX' ) && DOING_AJAX ) ? wp_get_referer() : $_SERVER['REQUEST_URI'];
|
|
|
|
$edit_link = add_query_arg(
|
|
'wp_http_referer',
|
|
urlencode( wp_unslash( $uri ) ),
|
|
get_edit_term_link( $tag->term_id, $taxonomy, $this->screen->post_type )
|
|
);
|
|
|
|
$out = '<strong><a class="row-title" href="' . esc_url( $edit_link ) . '" title="' . esc_attr( sprintf( __( 'Edit “%s”' ), $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, $qe_data ) . '</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 );
|
|
|
|
$uri = ( defined( 'DOING_AJAX' ) && DOING_AJAX ) ? wp_get_referer() : $_SERVER['REQUEST_URI'];
|
|
|
|
$edit_link = add_query_arg(
|
|
'wp_http_referer',
|
|
urlencode( wp_unslash( $uri ) ),
|
|
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="' . esc_url( $edit_link ) . '">' . __( 'Edit' ) . '</a>';
|
|
$actions['inline hide-if-no-js'] = '<a href="#" class="editinline aria-button-if-js">' . __( 'Quick Edit' ) . '</a>';
|
|
}
|
|
if ( current_user_can( $tax->cap->delete_terms ) && $tag->term_id != $default_term )
|
|
$actions['delete'] = "<a class='delete-tag aria-button-if-js' href='" . wp_nonce_url( "edit-tags.php?action=delete&taxonomy=$taxonomy&tag_ID=$tag->term_id", 'delete-tag_' . $tag->term_id ) . "'>" . __( 'Delete' ) . "</a>";
|
|
if ( $tax->public )
|
|
$actions['view'] = '<a href="' . get_term_link( $tag ) . '">' . __( 'View' ) . '</a>';
|
|
|
|
/**
|
|
* Filter the action links displayed for each term in the Tags list table.
|
|
*
|
|
* @since 2.8.0
|
|
* @deprecated 3.0.0 Use {$taxonomy}_row_actions instead.
|
|
*
|
|
* @param array $actions An array of action links to be displayed. Default
|
|
* 'Edit', 'Quick Edit', 'Delete', and 'View'.
|
|
* @param object $tag Term object.
|
|
*/
|
|
$actions = apply_filters( 'tag_row_actions', $actions, $tag );
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @since 3.0.0
|
|
*
|
|
* @param array $actions An array of action links to be displayed. Default
|
|
* 'Edit', 'Quick Edit', 'Delete', and 'View'.
|
|
* @param object $tag Term object.
|
|
*/
|
|
$actions = apply_filters( "{$taxonomy}_row_actions", $actions, $tag );
|
|
|
|
return $this->row_actions( $actions );
|
|
}
|
|
|
|
/**
|
|
* @param object $tag
|
|
* @return string
|
|
*/
|
|
public function column_description( $tag ) {
|
|
return $tag->description;
|
|
}
|
|
|
|
/**
|
|
* @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, $tag );
|
|
}
|
|
|
|
/**
|
|
* @param object $tag
|
|
* @return string
|
|
*/
|
|
public function column_posts( $tag ) {
|
|
$count = number_format_i18n( $tag->count );
|
|
|
|
$tax = get_taxonomy( $this->screen->taxonomy );
|
|
|
|
$ptype_object = get_post_type_object( $this->screen->post_type );
|
|
if ( ! $ptype_object->show_ui )
|
|
return $count;
|
|
|
|
if ( $tax->query_var ) {
|
|
$args = array( $tax->query_var => $tag->slug );
|
|
} else {
|
|
$args = array( 'taxonomy' => $tax->name, 'term' => $tag->slug );
|
|
}
|
|
|
|
if ( 'post' != $this->screen->post_type )
|
|
$args['post_type'] = $this->screen->post_type;
|
|
|
|
if ( 'attachment' === $this->screen->post_type )
|
|
return "<a href='" . esc_url ( add_query_arg( $args, 'upload.php' ) ) . "'>$count</a>";
|
|
|
|
return "<a href='" . esc_url ( add_query_arg( $args, 'edit.php' ) ) . "'>$count</a>";
|
|
}
|
|
|
|
/**
|
|
* @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;
|
|
}
|
|
|
|
/**
|
|
* @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`,
|
|
* refers to the slug of the current taxonomy.
|
|
*
|
|
* @since 2.8.0
|
|
*
|
|
* @param string $string Blank string.
|
|
* @param string $column_name Name of the column.
|
|
* @param int $term_id Term ID.
|
|
*/
|
|
return apply_filters( "manage_{$this->screen->taxonomy}_custom_column", '', $column_name, $tag->term_id );
|
|
}
|
|
|
|
/**
|
|
* Outputs the hidden row displayed when inline editing
|
|
*
|
|
* @since 3.1.0
|
|
*/
|
|
public function inline_edit() {
|
|
$tax = get_taxonomy( $this->screen->taxonomy );
|
|
|
|
if ( ! current_user_can( $tax->cap->edit_terms ) )
|
|
return;
|
|
?>
|
|
|
|
<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>
|
|
<legend class="inline-edit-legend"><?php _e( 'Quick Edit' ); ?></legend>
|
|
<div class="inline-edit-col">
|
|
<label>
|
|
<span class="title"><?php _ex( 'Name', 'term name' ); ?></span>
|
|
<span class="input-text-wrap"><input type="text" name="name" class="ptitle" value="" /></span>
|
|
</label>
|
|
<?php if ( !global_terms_enabled() ) { ?>
|
|
<label>
|
|
<span class="title"><?php _e( 'Slug' ); ?></span>
|
|
<span class="input-text-wrap"><input type="text" name="slug" class="ptitle" value="" /></span>
|
|
</label>
|
|
<?php } ?>
|
|
</div></fieldset>
|
|
<?php
|
|
|
|
$core_columns = array( 'cb' => true, 'description' => true, 'name' => true, 'slug' => true, 'posts' => true );
|
|
|
|
list( $columns ) = $this->get_column_info();
|
|
|
|
foreach ( $columns as $column_name => $column_display_name ) {
|
|
if ( isset( $core_columns[$column_name] ) )
|
|
continue;
|
|
|
|
/** This action is documented in wp-admin/includes/class-wp-posts-list-table.php */
|
|
do_action( 'quick_edit_custom_box', $column_name, 'edit-tags', $this->screen->taxonomy );
|
|
}
|
|
|
|
?>
|
|
|
|
<p class="inline-edit-save submit">
|
|
<button type="button" class="cancel button-secondary alignleft"><?php _e( 'Cancel' ); ?></button>
|
|
<button type="button" class="save button-primary alignright"><?php echo $tax->labels->update_item; ?></button>
|
|
<span class="spinner"></span>
|
|
<span class="error" style="display:none;"></span>
|
|
<?php wp_nonce_field( 'taxinlineeditnonce', '_inline_edit', false ); ?>
|
|
<input type="hidden" name="taxonomy" value="<?php echo esc_attr( $this->screen->taxonomy ); ?>" />
|
|
<input type="hidden" name="post_type" value="<?php echo esc_attr( $this->screen->post_type ); ?>" />
|
|
<br class="clear" />
|
|
</p>
|
|
</td></tr>
|
|
</tbody></table></form>
|
|
<?php
|
|
}
|
|
}
|