'wpcode-snippet',
'plural' => 'wpcode-snippets',
'ajax' => false,
)
);
// Default number of snippets to show per page.
$this->per_page = (int) apply_filters( 'wpcode_code_snippets_per_page', 20 );
$this->view = $this->get_current_view();
}
/**
* Load the current view from the get param.
*
* @return string
*/
private function get_current_view() {
return isset( $_GET['view'] ) ? sanitize_text_field( wp_unslash( $_GET['view'] ) ) : 'all'; // phpcs:ignore WordPress.Security.NonceVerification.Recommended
}
/**
* Render the checkbox column.
*
* @param WP_Post $item Snippet.
*
* @return string
*/
public function column_cb( $item ) {
return '';
}
/**
* Render the columns.
*
* @param WP_Post $item CPT object as a snippet representation.
* @param string $column_name Column Name.
*
* @return string
*/
public function column_default( $item, $column_name ) {
$snippet = new WPCode_Snippet( $item );
switch ( $column_name ) {
case 'id':
$value = $snippet->get_id();
break;
case 'location':
$location = $snippet->get_location();
$value = '';
if ( ! empty( $location ) ) {
$label = wpcode()->auto_insert->get_location_label( $location );
if ( 'trash' === $this->view ) {
$value = $label;
} else {
$url = add_query_arg( 'location', $snippet->get_location_term()->term_id );
$value = sprintf( '%2$s', esc_url( $url ), esc_html( $label ) );
}
}
break;
case 'created':
$value = sprintf(
// Translators: This is the format for displaying the date in the admin list, [date] at [time].
__( '%1$s at %2$s', 'insert-headers-and-footers' ),
get_the_time( get_option( 'date_format' ), $snippet->get_post_data() ),
get_the_time( get_option( 'time_format' ), $snippet->get_post_data() )
);
break;
case 'author':
$value = '';
$author = get_userdata( $snippet->get_snippet_author() );
if ( ! $author ) {
break;
}
$value = $author->display_name;
$user_edit_url = get_edit_user_link( $author->ID );
if ( ! empty( $user_edit_url ) ) {
$value = '' . esc_html( $value ) . '';
}
break;
case 'tags':
$tags = $snippet->get_tags();
$tags_links = array();
if ( 'trash' !== $this->view ) {
foreach ( $tags as $tag ) {
$tags_links[] = sprintf(
'%3$s',
add_query_arg( 'tag', $tag ),
// Translators: The tag by which to filter the list of snippets in the admin.
sprintf( __( 'Filter snippets by tag: %s', 'insert-headers-and-footers' ), $tag ),
$tag
);
}
} else {
$tags_links = $tags;
}
$value = implode( ', ', $tags_links );
break;
case 'status':
$value = $this->get_status_toggle( $snippet->is_active(), $snippet->get_id() );
break;
default:
$value = '';
}
return apply_filters( 'wpcode_code_snippets_table_column_value', $value, $snippet, $column_name );
}
/**
* Get the markup for the status toggle.
*
* @param bool $active If the snippet is active or not.
* @param int $snippet_id The id of the snippet.
*
* @return string
*/
public function get_status_toggle( $active, $snippet_id ) {
$markup = '';
return $markup;
}
/**
* Render the snippet name column with action links.
*
* @param WP_Post $snippet Snippet.
*
* @return string
*/
public function column_name( $snippet ) {
// Build the row action links and return the value.
return $this->get_column_name_title( $snippet ) . $this->get_column_name_row_actions( $snippet );
}
/**
* Get the snippet name HTML for the snippet name column.
*
* @param WP_Post $snippet Snippet post object.
*
* @return string
*/
protected function get_column_name_title( $snippet ) {
$title = ! empty( $snippet->post_title ) ? $snippet->post_title : $snippet->post_name;
$name = sprintf(
'%s',
esc_html( $title )
);
if ( 'trash' === $this->view ) {
return $name;
}
if ( current_user_can( 'edit_post', $snippet->ID ) ) {
$name = sprintf(
'%s',
esc_url(
add_query_arg(
'snippet_id',
$snippet->ID,
admin_url( 'admin.php?page=wpcode-snippet-manager' )
)
),
esc_attr__( 'Edit This Snippet', 'insert-headers-and-footers' ),
esc_html( $title )
);
}
return $name;
}
/**
* Get the row actions HTML for the snippet name column.
*
* @param WP_Post $snippet Snippet object.
*
* @return string
*/
protected function get_column_name_row_actions( $snippet ) {
/**
* Filters row action links on the 'Code Snippets' admin page.
*
* @param array $row_actions An array of action links for a given snippet.
* @param WP_Post $snippet Snippet object.
*/
$actions = array();
if ( 'trash' === $this->view ) {
if ( current_user_can( 'edit_post', $snippet->ID ) ) {
$actions['untrash'] = sprintf(
'%s',
esc_url(
wp_nonce_url(
add_query_arg(
array(
'action' => 'untrash',
'snippet_id' => $snippet->ID,
),
admin_url( 'admin.php?page=wpcode' )
),
'wpcode_untrash_nonce'
)
),
esc_attr__( 'Restore this snippet', 'insert-headers-and-footers' ),
esc_html__( 'Restore', 'insert-headers-and-footers' )
);
$actions['delete'] = sprintf(
'%s',
esc_url(
wp_nonce_url(
add_query_arg(
array(
'action' => 'delete',
'snippet_id' => $snippet->ID,
),
admin_url( 'admin.php?page=wpcode' )
),
'wpcode_delete_nonce'
)
),
esc_attr__( 'Delete this snippet permanently', 'insert-headers-and-footers' ),
esc_html__( 'Delete Permanently', 'insert-headers-and-footers' )
);
}
} else {
if ( current_user_can( 'edit_post', $snippet->ID ) ) {
$actions['edit'] = sprintf(
'%s',
esc_url( add_query_arg( 'snippet_id', $snippet->ID, admin_url( 'admin.php?page=wpcode-snippet-manager' ) ) ),
esc_attr__( 'Edit This Snippet', 'insert-headers-and-footers' ),
esc_html__( 'Edit', 'insert-headers-and-footers' )
);
}
if ( current_user_can( 'edit_post', $snippet->ID ) ) {
$actions['trash'] = sprintf(
'%s',
esc_url(
wp_nonce_url(
add_query_arg(
array(
'action' => 'trash',
'snippet_id' => $snippet->ID,
),
admin_url( 'admin.php?page=wpcode' )
),
'wpcode_trash_nonce'
)
),
esc_attr__( 'Move this snippet to trash', 'insert-headers-and-footers' ),
esc_html__( 'Trash', 'insert-headers-and-footers' )
);
}
}
return $this->row_actions( apply_filters( 'wpcode_code_snippets_row_actions', $actions, $snippet, $this->view ) );
}
/**
* Define bulk actions available for our table listing.
*
* @return array
*/
public function get_bulk_actions() {
if ( 'trash' === $this->view ) {
return array(
'untrash' => esc_html__( 'Restore', 'insert-headers-and-footers' ),
'delete' => esc_html__( 'Delete Permanently', 'insert-headers-and-footers' ),
);
}
return array(
'trash' => __( 'Trash', 'insert-headers-and-footers' ),
'enable' => __( 'Activate', 'insert-headers-and-footers' ),
'disable' => __( 'Deactivate', 'insert-headers-and-footers' ),
);
}
/**
* Message to be displayed when there are no snippets.
*
* @since 2.0.0
*/
public function no_items() {
esc_html_e( 'No snippets found.', 'insert-headers-and-footers' );
}
/**
* Fetch and set up the final data for the table.
*
* @since 2.0.0
*/
public function prepare_items() {
// Set up the columns.
$columns = $this->get_columns();
// Hidden columns (none).
$hidden = get_hidden_columns( $this->screen );
$sortable = array(
'name' => array( 'title', false ),
'created' => array( 'date', false ),
);
// Set column headers.
$this->_column_headers = array( $columns, $hidden, $sortable );
// phpcs:disable WordPress.Security.NonceVerification.Recommended
$page = $this->get_pagenum();
$order = isset( $_GET['order'] ) && 'asc' === $_GET['order'] ? 'ASC' : 'DESC';
$orderby = isset( $_GET['orderby'] ) ? sanitize_key( $_GET['orderby'] ) : 'ID';
$per_page = $this->get_items_per_page( 'wpcode_snippets_per_page', $this->per_page );
$is_filtered = false;
$args = array(
'orderby' => $orderby,
'order' => $order,
'nopaging' => false,
'posts_per_page' => $per_page,
'paged' => $page,
'no_found_rows' => false,
'post_status' => array( 'publish', 'draft' ),
'post_type' => 'wpcode',
);
if ( ! empty( $_GET['location'] ) ) {
$is_filtered = true;
$args['tax_query'] = array( // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_tax_query
array(
'taxonomy' => 'wpcode_location',
'terms' => array( absint( $_GET['location'] ) ),
),
);
}
if ( ! empty( $_GET['type'] ) ) {
$is_filtered = true;
if ( ! isset( $args['tax_query'] ) ) {
$args['tax_query'] = array(); // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_tax_query
}
$args['tax_query'][] = array(
'taxonomy' => 'wpcode_type',
'terms' => array( sanitize_text_field( wp_unslash( $_GET['type'] ) ) ),
'field' => 'slug',
);
}
if ( ! empty( $_GET['tag'] ) ) {
$is_filtered = true;
if ( ! isset( $args['tax_query'] ) ) {
$args['tax_query'] = array(); // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_tax_query
}
$args['tax_query'][] = array(
'taxonomy' => 'wpcode_tags',
'terms' => array( sanitize_text_field( wp_unslash( $_GET['tag'] ) ) ),
'field' => 'slug',
);
}
if ( ! empty( $_GET['s'] ) ) {
$args['s'] = sanitize_text_field( wp_unslash( $_GET['s'] ) );
// This is a search so let's extend it to meta too.
$this->add_meta_search();
}
// phpcs:enable WordPress.Security.NonceVerification.Recommended
if ( 'all' !== $this->view ) {
$args['post_status'] = $this->get_post_status_from_view();
}
/**
* Filters the `get_posts()` arguments while preparing items for the code snippets table.
*
* @param array $args Arguments array.
*/
$args = (array) apply_filters( 'wpcode_code_snippets_table_prepare_items_args', $args );
$items_query = new WP_Query( $args );
$this->items = $items_query->get_posts();
// Remove filters to avoid conflicts.
$this->remove_meta_search();
$per_page = isset( $args['posts_per_page'] ) ? $args['posts_per_page'] : $this->get_items_per_page( 'wpcode_snippets_per_page', $this->per_page );
$this->update_count( $args );
$count_current_view = empty( $this->count[ $this->view ] ) ? 0 : $this->count[ $this->view ];
if ( $is_filtered ) {
$count_current_view = $items_query->found_posts;
}
// Finalize pagination.
$this->set_pagination_args(
array(
'total_items' => $count_current_view,
'per_page' => $per_page,
'total_pages' => ceil( $count_current_view / $per_page ),
)
);
}
/**
* Retrieve the table columns.
*
* @return array $columns Array of all the list table columns.
*/
public function get_columns() {
$columns = array(
'cb' => '',
'name' => esc_html__( 'Name', 'insert-headers-and-footers' ),
'author' => esc_html__( 'Author', 'insert-headers-and-footers' ),
'location' => esc_html__( 'Location', 'insert-headers-and-footers' ),
'created' => esc_html__( 'Created', 'insert-headers-and-footers' ),
'tags' => esc_html__( 'Tags', 'insert-headers-and-footers' ),
);
if ( 'trash' !== $this->view ) {
$columns['status'] = esc_html__( 'Status', 'insert-headers-and-footers' );
}
return apply_filters( 'wpcode_code_snippets_table_columns', $columns );
}
/**
* Dynamically add filters to extend search to meta fields.
*
* @return void
*/
public function add_meta_search() {
add_filter( 'posts_join', array( $this, 'meta_search_join' ) );
add_filter( 'posts_where', array( $this, 'meta_search_where' ) );
add_filter( 'posts_distinct', array( $this, 'meta_search_distinct' ) );
}
/**
* Remove dynamically added filters to avoid spilling to other queries.
*
* @return void
*/
public function remove_meta_search() {
remove_filter( 'posts_join', array( $this, 'meta_search_join' ) );
remove_filter( 'posts_where', array( $this, 'meta_search_where' ) );
remove_filter( 'posts_distinct', array( $this, 'meta_search_distinct' ) );
}
/**
* Convert custom view names to actual post statuses.
*
* @return string
*/
private function get_post_status_from_view() {
switch ( $this->view ) {
case 'active':
$post_status = 'publish';
break;
case 'inactive':
$post_status = 'draft';
break;
case 'trash':
$post_status = 'trash';
break;
default:
$post_status = 'all';
break;
}
return $post_status;
}
/**
* Calculate and update snippets counts.
*
* @param array $args Get snippets arguments.
*/
private function update_count( $args ) {
/**
* Allow counting snippets filtered by a given search criteria.
*
* If result will not contain `all` key, count All Snippets without filtering will be performed.
*
* @param array $count Contains counts of snippets in different views.
* @param array $args Arguments of the `get_posts`.
*
* @since 2.0.0
*/
$this->count = (array) apply_filters( 'wpcode_code_snippets_table_update_count', array(), $args );
// We do not need to perform all snippets count if we have the result already.
if ( isset( $this->count['all'] ) ) {
return;
}
// Count all snippets.
$counts = wp_count_posts( 'wpcode' );
$this->count['all'] = array_sum( array( $counts->publish, $counts->draft ) );
$this->count['active'] = $counts->publish;
$this->count['inactive'] = $counts->draft;
$this->count['trash'] = $counts->trash;
/**
* Filters snippets count data after counting all snippets.
*
* This filter executes only if the result of `wpcode_code_snippets_table_update_count` filter
* doesn't contain `all` key.
*
* @param array $count Contains counts of snippets in different views.
* @param array $args Arguments of the `get_posts`.
*/
$this->count = (array) apply_filters( 'wpcode_code_snippets_table_update_count_all', $this->count, $args );
}
/**
* Extend the search to meta fields by joining the post meta table.
*
* @param string $join Join clause in the query.
*
* @return string
*/
public function meta_search_join( $join ) {
global $wpdb;
if ( is_admin() && isset( $_GET['s'] ) ) {
$join .= ' LEFT JOIN ' . $wpdb->postmeta . ' ON ' . $wpdb->posts . '.ID = ' . $wpdb->postmeta . '.post_id ';
}
return $join;
}
/**
* Extend the where clause to include the post meta values.
*
* @param string $where Where clause in the query.
*
* @return string
*/
public function meta_search_where( $where ) {
global $wpdb;
if ( is_admin() && isset( $_GET['s'] ) ) {
$where = preg_replace(
"/\(\s*" . $wpdb->posts . ".post_title\s+LIKE\s*(\'[^\']+\')\s*\)/",
"(" . $wpdb->posts . ".post_title LIKE $1) OR (" . $wpdb->postmeta . ".meta_value LIKE $1)", $where );
}
return $where;
}
/**
* Add distinct to the query to avoid duplicate results.
*
* @param string $distinct The distinct clause in the query.
*
* @return string
*/
public function meta_search_distinct( $distinct ) {
if ( is_admin() && isset( $_GET['s'] ) ) {
return "DISTINCT";
}
return $distinct;
}
/**
* Extending the `display_rows()` method in order to add hooks.
*
* @since 1.5.6
*/
public function display_rows() {
do_action( 'wpcode_code_snippets_table_before_rows', $this );
parent::display_rows();
do_action( 'wpcode_code_snippets_table_after_rows', $this );
}
/**
* Display the pagination.
*
* @param string $which The location of the table pagination: 'top' or 'bottom'.
*/
protected function pagination( $which ) {
if ( $this->has_items() ) {
parent::pagination( $which );
return;
}
printf(
'
%s
',
esc_html__( '0 items', 'insert-headers-and-footers' )
);
}
/**
* Extra controls to be displayed between bulk actions and pagination.
*
* @param string $which The location of the table navigation: 'top' or 'bottom'.
*
* @return void
*/
protected function extra_tablenav( $which ) {
if ( 'top' === $which && 'trash' !== $this->view ) {
$this->type_dropdown( 'wpcode' );
$this->location_dropdown( 'wpcode' );
submit_button( __( 'Filter', 'insert-headers-and-footers' ), '', 'filter_action', false, array( 'id' => 'wpcode-filter-submit' ) );
if ( isset( $_GET['filter_action'] ) || isset( $_GET['tag'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
echo ' ';
submit_button( __( 'Clear', 'insert-headers-and-footers' ), '', 'filter_clear', false, array( 'id' => 'wpcode-filter-clear' ) );
}
}
}
/**
* The dropdown to filter by the code type.
*
* @param string $post_type The post type.
*
* @return void
*/
protected function type_dropdown( $post_type ) {
if ( ! is_object_in_taxonomy( $post_type, 'wpcode_type' ) ) {
return;
}
$used_types = get_terms(
array(
'taxonomy' => 'wpcode_type',
'hide_empty' => false,
)
);
if ( ! $used_types ) {
return;
}
$displayed_type = isset( $_GET['type'] ) ? sanitize_text_field( wp_unslash( $_GET['type'] ) ) : ''; // phpcs:ignore WordPress.Security.NonceVerification.Recommended
?>
'wpcode_location',
'hide_empty' => false,
)
);
// Return if there are no posts using locations.
if ( ! $used_locations ) {
return;
}
$displayed_location = isset( $_GET['location'] ) ? absint( $_GET['location'] ) : ''; // phpcs:ignore WordPress.Security.NonceVerification.Recommended
?>
$this->view_markup( 'all', __( 'All', 'insert-headers-and-footers' ) ),
);
if ( $this->count['active'] ) {
$views['active'] = $this->view_markup( 'active', __( 'Active', 'insert-headers-and-footers' ) );
}
if ( $this->count['inactive'] ) {
$views['inactive'] = $this->view_markup( 'inactive', __( 'Inactive', 'insert-headers-and-footers' ) );
}
if ( $this->count['trash'] ) {
$views['trash'] = $this->view_markup( 'trash', __( 'Trash', 'insert-headers-and-footers' ) );
}
return $views;
}
/**
* Get view link markup for the nav above the table.
*
* @param string $slug The slug of the view.
* @param string $label The label for the view.
*
* @return string
*/
private function view_markup( $slug, $label ) {
$base_url = remove_query_arg(
array(
'view',
'trashed',
'untrashed',
'deleted',
'enabled',
'disabled',
's',
)
);
$url = 'all' === $slug ? remove_query_arg( 'view', $base_url ) : add_query_arg( 'view', $slug, $base_url );
$class = $this->view === $slug ? ' class="current"' : '';
$count = isset( $this->count[ $slug ] ) ? $this->count[ $slug ] : 0;
return sprintf( '%3$s (%4$d)', esc_url( $url ), $class, $label, $count );
}
}