'wpcode-snippet',
'plural' => 'wpcode-snippets',
'ajax' => false,
)
);
// Default number of snippets to show per page.
$this->per_page = $this->get_items_per_page( 'wpcode_snippets_per_page', (int) apply_filters( 'wpcode_code_snippets_per_page', 20 ) );
$this->view = $this->get_current_view();
$this->process_request_parameters();
}
/**
* Adjust query arguments based on GET parameters.
*/
protected function process_request_parameters() {
if ( isset( $_GET['type'] ) && ! empty( $_GET['type'] ) ) {
// Store the type in a class property or use it immediately in query preparations.
$this->requested_type = sanitize_text_field( wp_unslash( $_GET['type'] ) );
} else {
$this->requested_type = null;
}
}
/**
* 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 '%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 'updated':
$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_modified_date( get_option( 'date_format' ), $snippet->get_post_data() ),
get_the_modified_date( 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 ) {
$url = add_query_arg( 'tag', $tag );
$url = remove_query_arg( 'paged', $url );
$tags_links[] = sprintf(
'%3$s ',
esc_url( $url ),
// Translators: The tag by which to filter the list of snippets in the admin.
sprintf( __( 'Filter snippets by tag: %s', 'insert-headers-and-footers' ), esc_attr( $tag ) ),
esc_html( $tag )
);
}
} else {
$tags_links = $tags;
}
$value = implode( ', ', $tags_links );
break;
case 'status':
$value = $this->get_status_toggle( $snippet->is_active(), $snippet->get_id() );
break;
case 'shortcode':
$shortcode = apply_filters( 'wpcode_shortcode_preview', '[wpcode id="' . absint( $snippet->get_id() ) . '"]', $snippet );
// Show the shortcode in a code tag so it's easy to copy.
$value = '' . esc_html( $shortcode ) . get_wpcode_icon( 'copy' ) . '';
break;
case 'code_type':
// Let's display the code type with a link to filter by code type.
$code_type = $snippet->get_code_type();
if ( 'trash' === $this->view ) {
$value = $code_type;
} else {
$url = add_query_arg(
array(
'filter_action' => 'Filter',
'type' => $code_type,
),
$this->admin_url( 'admin.php?page=wpcode' )
);
$value = sprintf( '%2$s ', esc_url( $url ), esc_html( $code_type ) );
}
break;
case 'priority':
echo esc_html( $snippet->get_priority() );
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 = '';
$markup .= '' . esc_html__( 'Toggle Snippet Status', 'insert-headers-and-footers' ) . ' ';
$markup .= ' ';
$snippets_with_errors = wpcode()->error->get_snippets_with_errors();
// Let's check if the snippet threw an error.
if ( ! empty( $snippets_with_errors ) && in_array( $snippet_id, $snippets_with_errors, true ) ) {
$last_error = get_post_meta( $snippet_id, '_wpcode_last_error', true );
if ( ! empty( $last_error ) ) {
$type = 'error';
if ( isset( $last_error['wpc_type'] ) && 'deactivated' === $last_error['wpc_type'] ) {
$tooltip_text = sprintf(
// Translators: %1$s is the time since the snippet was deactivated, %2$s is the date and time of deactivation.
__( 'This snippet was automatically deactivated because of a fatal error at %2$s on %3$s (%1$s ago)', 'insert-headers-and-footers' ),
human_time_diff( $last_error['time'], time() ),
gmdate( 'H:i:s', $last_error['time'] ),
gmdate( 'Y-m-d', $last_error['time'] )
);
$type = 'deactivated';
} else {
$tooltip_text = esc_html__( 'This snippet threw an error, you can see more details when editing the snippet.', 'insert-headers-and-footers' );
}
$markup .= '' . get_wpcode_icon( 'info' ) . '' . $tooltip_text . ' ';
}
}
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 %s ' . $currently_editing . '
' . $name;
}
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,
),
$this->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,
),
$this->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, $this->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 ) && ! wpcode_testing_mode_enabled() ) {
$actions['trash'] = sprintf(
'%s ',
esc_url(
wp_nonce_url(
add_query_arg(
array(
'action' => 'trash',
'snippet_id' => $snippet->ID,
),
$this->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' )
);
}
if ( current_user_can( 'edit_post', $snippet->ID ) ) {
$actions['duplicate'] = sprintf(
'%s ',
esc_url(
wp_nonce_url(
add_query_arg(
array(
'action' => 'duplicate',
'snippet_id' => $snippet->ID,
),
$this->admin_url( 'admin.php?page=wpcode' )
),
'wpcode_duplicate_nonce'
)
),
esc_attr__( 'Duplicate this snippet', 'insert-headers-and-footers' ),
esc_html__( 'Duplicate', '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 ) {
$bulk_actions = array(
'untrash' => esc_html__( 'Restore', 'insert-headers-and-footers' ),
'delete' => esc_html__( 'Delete Permanently', 'insert-headers-and-footers' ),
);
} else {
$bulk_actions = array(
'trash' => __( 'Trash', 'insert-headers-and-footers' ),
'enable' => __( 'Activate', 'insert-headers-and-footers' ),
'disable' => __( 'Deactivate', 'insert-headers-and-footers' ),
);
}
return apply_filters( 'wpcode_snippets_bulk_actions', $bulk_actions );
}
/**
* 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() {
$columns = $this->get_columns();
$hidden = get_user_option( 'manage' . $this->screen->id . 'columnshidden' );
// Check if $hidden is false and set it to an empty array if so.
if ( false === $hidden ) {
$hidden = array();
}
$sortable = array(
'name' => array( 'title', false ),
'created' => array( 'date', false ),
'updated' => array( 'last_updated', false ),
'priority' => array( 'priority', false ),
);
$sortable_query_params = array(
'last_updated' => 'modified',
'title' => 'title',
'date' => 'id',
'priority' => 'priority',
);
// Set column headers.
$this->_column_headers = array( $columns, $hidden, $sortable, 'name' );
// phpcs:disable WordPress.Security.NonceVerification.Recommended
$page = $this->get_pagenum();
// Reset page to 1 if a search or filter is being applied.
if ( isset( $_REQUEST['submitted'] ) ) {
$page = 1;
}
if ( isset( $_GET['order'] ) ) {
$order = 'asc' === $_GET['order'] ? 'ASC' : 'DESC';
} else {
$order = 'DESC';
$user_order = get_user_option( 'wpcode_snippets_order' );
if ( ! empty( $user_order ) ) {
$order = $user_order;
}
}
// Same thing but for order by.
if ( isset( $_GET['orderby'] ) ) {
$order_by = sanitize_key( $_GET['orderby'] );
} else {
$order_by = 'ID';
$user_orderby = get_user_option( 'wpcode_snippets_order_by' );
if ( ! empty( $user_orderby ) ) {
$order_by = $user_orderby;
}
}
if ( isset( $sortable_query_params[ $order_by ] ) ) {
$order_by = $sortable_query_params[ $order_by ];
} else {
$order_by = 'ID';
}
$per_page = $this->get_items_per_page( 'wpcode_snippets_per_page', $this->per_page );
$is_filtered = false;
$args = array(
'orderby' => $order_by,
'order' => $order,
'nopaging' => false,
'posts_per_page' => $per_page,
'paged' => $page,
'no_found_rows' => false,
'post_status' => array( 'publish', 'draft' ),
'post_type' => $this->get_post_type(),
);
if ( 'priority' === $order_by ) {
$args['orderby'] = 'meta_value_num';
$args['meta_key'] = '_wpcode_priority'; // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key
}
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( sanitize_key( $_GET['location'] ) ),
'field' => 'slug',
),
);
}
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( $this->requested_type ) ) {
$args['tax_query'][] = array(
'taxonomy' => 'wpcode_type',
'terms' => array( $this->requested_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();
}
if ( 'has_error' === $this->view ) {
$args['meta_query'] = array( // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query
'relation' => 'OR',
array(
'key' => '_wpcode_last_error',
'compare' => 'EXISTS',
),
);
}
/**
* 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' => '« ';
} else {
$page_links[] = sprintf(
'%s ',
esc_url( add_query_arg( 'paged', 1, $base_url ) ),
'«'
);
}
if ( $disable_prev ) {
$page_links[] = '‹ ';
} else {
$page_links[] = sprintf(
'%s ',
esc_url( add_query_arg( 'paged', max( 1, $current_page - 1 ), $base_url ) ),
'‹'
);
}
// Pagination input with hidden fields for filter parameters.
$page_links[] = sprintf(
'
%s
' . esc_html__( 'of' ) . ' %s
',
esc_html__( 'Current Page' ),
esc_html( $current_page ),
strlen( $total_pages ),
number_format_i18n( $total_pages )
);
if ( $disable_next ) {
$page_links[] = '› ';
} else {
$page_links[] = sprintf(
'%s ',
esc_url( add_query_arg( 'paged', min( $total_pages, $current_page + 1 ), $base_url ) ),
'›'
);
}
if ( $disable_last ) {
$page_links[] = '» ';
} else {
$page_links[] = sprintf(
'%s ',
esc_url( add_query_arg( 'paged', $total_pages, $base_url ) ),
'»'
);
}
// Output the pagination.
echo '';
echo '' . sprintf( _n( '%s item', '%s items', absint( $total_items ), 'insert-headers-and-footers' ), number_format_i18n( $total_items ) ) . ' ';
echo '
';
}
/**
* 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 ) {
echo '';
$this->location_dropdown( $this->get_post_type() );
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' ) );
}
echo '
';
}
}
/**
* The dropdown to filter by location.
*
* @param string $post_type The post type.
*
* @return void
*/
protected function location_dropdown( $post_type ) {
if ( ! is_object_in_taxonomy( $post_type, 'wpcode_location' ) ) {
return;
}
$used_locations = get_terms(
array(
'taxonomy' => 'wpcode_location',
'hide_empty' => true,
)
);
// Return if there are no posts using locations.
if ( ! $used_locations ) {
return;
}
$displayed_location = isset( $_GET['location'] ) ? sanitize_key( $_GET['location'] ) : ''; // phpcs:ignore WordPress.Security.NonceVerification.Recommended
?>
value="">
auto_insert->get_location_label( $used_location->slug );
?>
slug ); ?> value="slug ); ?>">
count['all'] ) {
$views['all'] = $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'] && ! wpcode_testing_mode_enabled() ) {
$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 ) {
$start_url = admin_url( 'admin.php' );
// Start with a clean URL by removing specific query arguments.
$base_url = remove_query_arg(
array(
'view',
'trashed',
'duplicated',
'untrashed',
'deleted',
'enabled',
'disabled',
's',
),
$start_url
);
$base_url = add_query_arg( 'page', 'wpcode', $base_url );
$current_params = $_GET;
// Remove the same specific query arguments from current params to ensure they are not reintroduced.
$params_to_remove = array(
'view',
'trashed',
'duplicated',
'untrashed',
'deleted',
'enabled',
'disabled',
's'
);
foreach ( $params_to_remove as $param ) {
unset( $current_params[ $param ] );
}
$current_params['view'] = $slug;
$url = add_query_arg( $current_params, $base_url );
$class = ( $slug === $this->view ) ? 'current' : '';
$count = isset( $this->count[ $slug ] ) ? $this->count[ $slug ] : 0;
return sprintf(
'%3$s (%4$d) ',
esc_url( $url ),
esc_attr( $class ),
esc_html( $label ),
esc_html( $count )
);
}
/**
* Get an admin URL.
*
* @param string $path The path to append to the admin URL.
*
* @return string
*/
public function admin_url( $path ) {
return admin_url( $path );
}
}