A list of the view labels linked to the view
*/
public function get_views(): array {
global $totals, $status;
$status_links = parent::get_views();
// Loop through the view counts.
foreach ( $totals as $type => $count ) {
$labels = [];
if ( ! $count ) {
continue;
}
// translators: %s: total number of snippets.
$labels['all'] = _n(
'All (%s)',
'All (%s)',
$count,
'code-snippets'
);
// translators: %s: total number of active snippets.
$labels['active'] = _n(
'Active (%s)',
'Active (%s)',
$count,
'code-snippets'
);
// translators: %s: total number of inactive snippets.
$labels['inactive'] = _n(
'Inactive (%s)',
'Inactive (%s)',
$count,
'code-snippets'
);
// translators: %s: total number of recently activated snippets.
$labels['recently_activated'] = _n(
'Recently Active (%s)',
'Recently Active (%s)',
$count,
'code-snippets'
);
// The page URL with the status parameter.
$url = esc_url( add_query_arg( 'status', $type ) );
// Add a class if this view is currently being viewed.
$class = $type === $status ? ' class="current"' : '';
// Add the view count to the label.
$text = sprintf( $labels[ $type ], number_format_i18n( $count ) );
$status_links[ $type ] = sprintf( '%s', $url, $class, $text );
}
return apply_filters( 'code_snippets/list_table/views', $status_links );
}
/**
* Gets the tags of the snippets currently being viewed in the table
*
* @since 2.0
*/
public function get_current_tags() {
global $snippets, $status;
// If we're not viewing a snippets table, get all used tags instead.
if ( ! isset( $snippets, $status ) ) {
$tags = get_all_snippet_tags();
} else {
$tags = array();
// Merge all tags into a single array.
foreach ( $snippets[ $status ] as $snippet ) {
$tags = array_merge( $snippet->tags, $tags );
}
// Remove duplicate tags.
$tags = array_unique( $tags );
}
sort( $tags );
return $tags;
}
/**
* Add filters and extra actions above and below the table
*
* @param string $which Whether the actions are displayed on the before (true) or after (false) the table.
*/
public function extra_tablenav( $which ) {
/**
* Status global.
*
* @var string $status
*/
global $status;
if ( 'top' === $which ) {
// Tags dropdown filter.
$tags = $this->get_current_tags();
if ( count( $tags ) ) {
$query = isset( $_GET['tag'] ) ? sanitize_text_field( wp_unslash( $_GET['tag'] ) ) : '';
echo '';
echo '';
submit_button( __( 'Filter', 'code-snippets' ), 'button', 'filter_action', false );
echo '
';
}
}
echo '';
if ( 'recently_activated' === $status ) {
submit_button( __( 'Clear List', 'code-snippets' ), 'secondary', 'clear-recent-list', false );
}
do_action( 'code_snippets/list_table/actions', $which );
echo '
';
}
/**
* Output form fields needed to preserve important
* query vars over form submissions
*
* @param string $context The context in which the fields are being outputted.
*/
public static function required_form_fields( string $context = 'main' ) {
$vars = apply_filters(
'code_snippets/list_table/required_form_fields',
array( 'page', 's', 'status', 'paged', 'tag' ),
$context
);
if ( 'search_box' === $context ) {
// Remove the 's' var if we're doing this for the search box.
$vars = array_diff( $vars, array( 's' ) );
}
foreach ( $vars as $var ) {
if ( ! empty( $_REQUEST[ $var ] ) ) {
$value = sanitize_text_field( wp_unslash( $_REQUEST[ $var ] ) );
printf( '', esc_attr( $var ), esc_attr( $value ) );
echo "\n";
}
}
do_action( 'code_snippets/list_table/print_required_form_fields', $context );
}
/**
* Perform an action on a single snippet.
*
* @param int $id Snippet ID.
* @param string $action Action to perform.
*
* @return bool|string Result of performing action
*/
private function perform_action( int $id, string $action ) {
switch ( $action ) {
case 'activate':
activate_snippet( $id, $this->is_network );
return 'activated';
case 'deactivate':
deactivate_snippet( $id, $this->is_network );
return 'deactivated';
case 'run-once':
$this->perform_action( $id, 'activate' );
return 'executed';
case 'run-once-shared':
$this->perform_action( $id, 'activate-shared' );
return 'executed';
case 'activate-shared':
$active_shared_snippets = get_option( 'active_shared_network_snippets', array() );
if ( ! in_array( $id, $active_shared_snippets, true ) ) {
$active_shared_snippets[] = $id;
update_option( 'active_shared_network_snippets', $active_shared_snippets );
clean_active_snippets_cache( code_snippets()->db->ms_table );
}
return 'activated';
case 'deactivate-shared':
$active_shared_snippets = get_option( 'active_shared_network_snippets', array() );
update_option( 'active_shared_network_snippets', array_diff( $active_shared_snippets, array( $id ) ) );
clean_active_snippets_cache( code_snippets()->db->ms_table );
return 'deactivated';
case 'clone':
$this->clone_snippets( [ $id ] );
return 'cloned';
case 'delete':
delete_snippet( $id, $this->is_network );
return 'deleted';
case 'export':
$export = new Export_Attachment( [ $id ], $this->is_network );
$export->download_snippets_json();
break;
case 'download':
$export = new Export_Attachment( [ $id ], $this->is_network );
$export->download_snippets_code();
break;
}
return false;
}
/**
* Processes actions requested by the user.
*
* @return void
*/
public function process_requested_actions() {
// Clear the recent snippets list if requested to do so.
if ( isset( $_POST['clear-recent-list'] ) ) {
check_admin_referer( 'bulk-' . $this->_args['plural'] );
if ( $this->is_network ) {
update_site_option( 'recently_activated_snippets', array() );
} else {
update_option( 'recently_activated_snippets', array() );
}
}
// Check if there are any single snippet actions to perform.
if ( isset( $_GET['action'], $_GET['id'] ) ) {
$id = absint( $_GET['id'] );
$scope = isset( $_GET['scope'] ) ? sanitize_key( wp_unslash( $_GET['scope'] ) ) : '';
// Verify they were sent from a trusted source.
$nonce_action = 'code_snippets_manage_snippet_' . $id;
if ( ! isset( $_GET['_wpnonce'] ) || ! wp_verify_nonce( sanitize_key( wp_unslash( $_GET['_wpnonce'] ) ), $nonce_action ) ) {
wp_nonce_ays( $nonce_action );
}
$_SERVER['REQUEST_URI'] = remove_query_arg( array( 'action', 'id', 'scope', '_wpnonce' ) );
// If so, then perform the requested action and inform the user of the result.
$result = $this->perform_action( $id, sanitize_key( $_GET['action'] ), $scope );
if ( $result ) {
wp_safe_redirect( esc_url_raw( add_query_arg( 'result', $result ) ) );
exit;
}
}
// Only continue from this point if there are bulk actions to process.
if ( ! isset( $_POST['ids'] ) && ! isset( $_POST['shared_ids'] ) ) {
return;
}
check_admin_referer( 'bulk-' . $this->_args['plural'] );
$ids = isset( $_POST['ids'] ) ? array_map( 'intval', $_POST['ids'] ) : array();
$_SERVER['REQUEST_URI'] = remove_query_arg( 'action' );
switch ( $this->current_action() ) {
case 'activate-selected':
activate_snippets( $ids );
// Process the shared network snippets.
if ( isset( $_POST['shared_ids'] ) && is_multisite() && ! $this->is_network ) {
$active_shared_snippets = get_option( 'active_shared_network_snippets', array() );
foreach ( array_map( 'intval', $_POST['shared_ids'] ) as $id ) {
if ( ! in_array( $id, $active_shared_snippets, true ) ) {
$active_shared_snippets[] = $id;
}
}
update_option( 'active_shared_network_snippets', $active_shared_snippets );
clean_active_snippets_cache( code_snippets()->db->ms_table );
}
$result = 'activated-multi';
break;
case 'deactivate-selected':
foreach ( $ids as $id ) {
deactivate_snippet( $id, $this->is_network );
}
// Process the shared network snippets.
if ( isset( $_POST['shared_ids'] ) && is_multisite() && ! $this->is_network ) {
$active_shared_snippets = get_option( 'active_shared_network_snippets', array() );
$active_shared_snippets = ( '' === $active_shared_snippets ) ? array() : $active_shared_snippets;
$active_shared_snippets = array_diff( $active_shared_snippets, array_map( 'intval', $_POST['shared_ids'] ) );
update_option( 'active_shared_network_snippets', $active_shared_snippets );
clean_active_snippets_cache( code_snippets()->db->ms_table );
}
$result = 'deactivated-multi';
break;
case 'export-selected':
$export = new Export_Attachment( $ids, $this->is_network );
$export->download_snippets_json();
break;
case 'download-selected':
$export = new Export_Attachment( $ids, $this->is_network );
$export->download_snippets_code();
break;
case 'clone-selected':
$this->clone_snippets( $ids );
$result = 'cloned-multi';
break;
case 'delete-selected':
foreach ( $ids as $id ) {
delete_snippet( $id, $this->is_network );
}
$result = 'deleted-multi';
break;
}
if ( isset( $result ) ) {
wp_safe_redirect( esc_url_raw( add_query_arg( 'result', $result ) ) );
exit;
}
}
/**
* Message to display if no snippets are found.
*
* @return void
*/
public function no_items() {
if ( ! empty( $GLOBALS['s'] ) || ! empty( $_GET['tag'] ) ) {
esc_html_e( 'No snippets were found matching the current search query. Please enter a new query or use the "Clear Filters" button above.', 'code-snippets' );
} else {
$add_url = code_snippets()->get_menu_url( 'add' );
if ( empty( $_GET['type'] ) ) {
esc_html_e( "It looks like you don't have any snippets.", 'code-snippets' );
} else {
esc_html_e( "It looks like you don't have any snippets of this type.", 'code-snippets' );
$add_url = add_query_arg( 'type', sanitize_key( wp_unslash( $_GET['type'] ) ), $add_url );
}
printf(
' %s',
esc_url( $add_url ),
esc_html__( 'Perhaps you would like to add a new one?', 'code-snippets' )
);
}
}
/**
* Fetch all shared network snippets for the current site.
*
* @return void
*/
private function fetch_shared_network_snippets() {
/**
* Table data.
*
* @var $snippets array
*/
global $snippets;
$ids = get_site_option( 'shared_network_snippets' );
if ( ! is_multisite() || ! $ids ) {
return;
}
if ( $this->is_network ) {
$limit = count( $snippets['all'] );
for ( $i = 0; $i < $limit; $i++ ) {
$snippet = &$snippets['all'][ $i ];
if ( in_array( $snippet->id, $ids, true ) ) {
$snippet->shared_network = true;
$snippet->tags = array_merge( $snippet->tags, array( 'shared on network' ) );
$snippet->active = false;
}
}
} else {
$active_shared_snippets = get_option( 'active_shared_network_snippets', array() );
$shared_snippets = get_snippets( $ids, true );
foreach ( $shared_snippets as $snippet ) {
$snippet->shared_network = true;
$snippet->tags = array_merge( $snippet->tags, array( 'shared on network' ) );
$snippet->active = in_array( $snippet->id, $active_shared_snippets, true );
}
$snippets['all'] = array_merge( $snippets['all'], $shared_snippets );
}
}
/**
* Prepares the items to later display in the table.
* Should run before any headers are sent.
*
* @phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
*
* @return void
*/
public function prepare_items() {
/**
* Global variables.
*
* @var string $status Current status view.
* @var array $snippets List of snippets for views.
* @var array $totals List of total items for views.
* @var string $s Current search term.
*/
global $status, $snippets, $totals, $s;
wp_reset_vars( array( 'orderby', 'order', 's' ) );
// Redirect tag filter from POST to GET.
if ( isset( $_POST['filter_action'] ) ) {
$location = empty( $_POST['tag'] ) ?
remove_query_arg( 'tag' ) :
add_query_arg( 'tag', sanitize_text_field( wp_unslash( $_POST['tag'] ) ) );
wp_safe_redirect( esc_url_raw( $location ) );
exit;
}
$this->process_requested_actions();
$snippets = array_fill_keys( $this->statuses, array() );
$snippets['all'] = apply_filters( 'code_snippets/list_table/get_snippets', get_snippets() );
$this->fetch_shared_network_snippets();
// Filter snippets by type.
$type = sanitize_key( wp_unslash( $_GET['type'] ?? '' ) );
if ( $type && 'all' !== $type ) {
$snippets['all'] = array_filter(
$snippets['all'],
function ( Snippet $snippet ) use ( $type ) {
return $type === $snippet->type;
}
);
}
// Add scope tags.
foreach ( $snippets['all'] as $snippet ) {
if ( 'global' !== $snippet->scope ) {
$snippet->add_tag( $snippet->scope );
}
}
// Filter snippets by tag.
if ( ! empty( $_GET['tag'] ) ) {
$snippets['all'] = array_filter( $snippets['all'], array( $this, 'tags_filter_callback' ) );
}
// Filter snippets based on search query.
if ( $s ) {
$snippets['all'] = array_filter( $snippets['all'], array( $this, 'search_by_line_callback' ) );
}
// Clear recently activated snippets older than a week.
$recently_activated = $this->is_network ?
get_site_option( 'recently_activated_snippets', array() ) :
get_option( 'recently_activated_snippets', array() );
foreach ( $recently_activated as $key => $time ) {
if ( $time + WEEK_IN_SECONDS < time() ) {
unset( $recently_activated[ $key ] );
}
}
$this->is_network ?
update_site_option( 'recently_activated_snippets', $recently_activated ) :
update_option( 'recently_activated_snippets', $recently_activated );
/**
* Filter snippets into individual sections
*
* @var Snippet $snippet
*/
foreach ( $snippets['all'] as $snippet ) {
if ( $snippet->active ) {
$snippets['active'][] = $snippet;
} else {
$snippets['inactive'][] = $snippet;
// Was the snippet recently deactivated?
if ( isset( $recently_activated[ $snippet->id ] ) ) {
$snippets['recently_activated'][] = $snippet;
}
}
}
// Count the totals for each section.
$totals = array_map(
function ( $section_snippets ) {
return count( $section_snippets );
},
$snippets
);
// If the current status is empty, default to all.
if ( empty( $snippets[ $status ] ) ) {
$status = 'all';
}
// Get the current data.
$data = $snippets[ $status ];
// Decide how many records per page to show by getting the user's setting in the Screen Options panel.
$sort_by = $this->screen->get_option( 'per_page', 'option' );
$per_page = get_user_meta( get_current_user_id(), $sort_by, true );
if ( empty( $per_page ) || $per_page < 1 ) {
$per_page = $this->screen->get_option( 'per_page', 'default' );
}
$per_page = (int) $per_page;
$this->set_order_vars();
usort( $data, array( $this, 'usort_reorder_callback' ) );
// Determine what page the user is currently looking at.
$current_page = $this->get_pagenum();
// Check how many items are in the data array.
$total_items = count( $data );
// The WP_List_Table class does not handle pagination for us, so we need to ensure that the data is trimmed to only the current page.
$data = array_slice( $data, ( ( $current_page - 1 ) * $per_page ), $per_page );
// Now we can add our *sorted* data to the 'items' property, where it can be used by the rest of the class.
$this->items = $data;
// We register our pagination options and calculations.
$this->set_pagination_args(
[
'total_items' => $total_items, // Calculate the total number of items.
'per_page' => $per_page, // Determine how many items to show on a page.
'total_pages' => ceil( $total_items / $per_page ), // Calculate the total number of pages.
]
);
}
/**
* Determine the sort ordering for two pieces of data.
*
* @param mixed $a_data First piece of data.
* @param mixed $b_data Second piece of data.
*
* @return int Returns -1 if $a_data is less than $b_data; 0 if they are equal; 1 otherwise
* @ignore
*/
private function get_sort_direction( $a_data, $b_data ) {
// If the data is numeric, then calculate the ordering directly.
if ( is_numeric( $a_data ) && is_numeric( $b_data ) ) {
return $a_data - $b_data;
}
// If only one of the data points is empty, then place it before the one which is not.
if ( empty( $a_data ) xor empty( $b_data ) ) {
return empty( $a_data ) ? 1 : -1;
}
// Sort using the default string sort order if possible.
if ( is_string( $a_data ) && is_string( $b_data ) ) {
return strcasecmp( $a_data, $b_data );
}
// Otherwise, use basic comparison operators.
return $a_data === $b_data ? 0 : ( $a_data < $b_data ? -1 : 1 );
}
/**
* Set the $order_by and $order_dir class variables.
*/
private function set_order_vars() {
$order = Settings\get_setting( 'general', 'list_order' );
// set the order by based on the query variable, if set.
if ( ! empty( $_REQUEST['orderby'] ) ) {
$this->order_by = sanitize_key( wp_unslash( $_REQUEST['orderby'] ) );
} else {
// otherwise, fetch the order from the setting, ensuring it is valid.
$valid_fields = [ 'id', 'name', 'type', 'modified', 'priority' ];
$order_parts = explode( '-', $order, 2 );
$this->order_by = in_array( $order_parts[0], $valid_fields, true ) ? $order_parts[0] :
apply_filters( 'code_snippets/list_table/default_orderby', 'priority' );
}
// set the order dir based on the query variable, if set.
if ( ! empty( $_REQUEST['order'] ) ) {
$this->order_dir = sanitize_key( wp_unslash( $_REQUEST['order'] ) );
} elseif ( '-desc' === substr( $order, -5 ) ) {
$this->order_dir = 'desc';
} elseif ( '-asc' === substr( $order, -4 ) ) {
$this->order_dir = 'asc';
} else {
$this->order_dir = apply_filters( 'code_snippets/list_table/default_order', 'asc' );
}
}
/**
* Callback for usort() used to sort snippets
*
* @param Snippet $a The first snippet to compare.
* @param Snippet $b The second snippet to compare.
*
* @return int The sort order.
* @ignore
*/
private function usort_reorder_callback( Snippet $a, Snippet $b ) {
$orderby = $this->order_by;
$result = $this->get_sort_direction( $a->$orderby, $b->$orderby );
if ( 0 === $result && 'id' !== $orderby ) {
$result = $this->get_sort_direction( $a->id, $b->id );
}
// Apply the sort direction to the calculated order.
return ( 'asc' === $this->order_dir ) ? $result : -$result;
}
/**
* Callback for search function
*
* @param Snippet $snippet The snippet being filtered.
*
* @return bool The result of the filter
* @ignore
*/
private function search_callback( Snippet $snippet ): bool {
global $s;
$fields = array( 'name', 'desc', 'code', 'tags_list' );
foreach ( $fields as $field ) {
if ( false !== stripos( $snippet->$field, $s ) ) {
return true;
}
}
return false;
}
/**
* Callback for search function
*
* @param Snippet $snippet The snippet being filtered.
*
* @return bool The result of the filter
* @ignore
*/
private function search_by_line_callback( Snippet $snippet ): bool {
global $s;
static $line_num;
if ( is_null( $line_num ) ) {
if ( preg_match( '/@line:(?P\d+)/', $s, $matches ) ) {
$s = trim( str_replace( $matches[0], '', $s ) );
$line_num = (int) $matches['line'] - 1;
} else {
$line_num = -1;
}
}
if ( $line_num < 0 ) {
return $this->search_callback( $snippet );
}
$code_lines = explode( "\n", $snippet->code );
return isset( $code_lines[ $line_num ] ) && false !== stripos( $code_lines[ $line_num ], $s );
}
/**
* Callback for filtering snippets by tag.
*
* @param Snippet $snippet The snippet being filtered.
*
* @return bool The result of the filter.
* @ignore
*/
private function tags_filter_callback( Snippet $snippet ): bool {
$tags = isset( $_GET['tag'] ) ?
explode( ',', sanitize_text_field( wp_unslash( $_GET['tag'] ) ) ) :
array();
foreach ( $tags as $tag ) {
if ( in_array( $tag, $snippet->tags, true ) ) {
return true;
}
}
return false;
}
/**
* Display a notice showing the current search terms
*
* @since 1.7
*/
public function search_notice() {
if ( ! empty( $_REQUEST['s'] ) || ! empty( $_GET['tag'] ) ) {
echo '' . esc_html__( 'Search results', 'code-snippets' );
if ( ! empty( $_REQUEST['s'] ) ) {
$s = sanitize_text_field( wp_unslash( $_REQUEST['s'] ) );
if ( preg_match( '/@line:(?P\d+)/', $s, $matches ) ) {
// translators: 1: search query, 2: line number.
$text = __( ' for “%1$s” on line %2$d', 'code-snippets' );
printf(
esc_html( $text ),
esc_html( trim( str_replace( $matches[0], '', $s ) ) ),
intval( $matches['line'] )
);
} else {
// translators: %s: search query.
echo esc_html( sprintf( __( ' for “%s”', 'code-snippets' ), $s ) );
}
}
if ( ! empty( $_GET['tag'] ) ) {
$tag = sanitize_text_field( wp_unslash( $_GET['tag'] ) );
// translators: %s: tag name.
echo esc_html( sprintf( __( ' in tag “%s”', 'code-snippets' ), $tag ) );
}
echo '';
// translators: 1: link URL, 2: link text.
printf(
' %s',
esc_url( remove_query_arg( array( 's', 'tag', 'cloud_search' ) ) ),
esc_html__( 'Clear Filters', 'code-snippets' )
);
}
}
/**
* Outputs content for a single row of the table
*
* @param Snippet $item The snippet being used for the current row.
*/
public function single_row( $item ) {
$status = $item->active ? 'active' : 'inactive';
$row_class = "snippet $status-snippet $item->type-snippet $item->scope-scope";
if ( $item->shared_network ) {
$row_class .= ' shared-network-snippet';
}
printf( '', esc_attr( $row_class ), esc_attr( $item->scope ) );
$this->single_row_columns( $item );
echo '
';
}
/**
* Clone a selection of snippets
*
* @param array $ids List of snippet IDs.
*/
private function clone_snippets( array $ids ) {
$snippets = get_snippets( $ids, $this->is_network );
foreach ( $snippets as $snippet ) {
$snippet->id = 0;
$snippet->active = false;
$snippet->cloud_id = '';
// translators: %s: snippet title.
$snippet->name = sprintf( __( '%s [CLONE]', 'code-snippets' ), $snippet->name );
$snippet = apply_filters( 'code_snippets/list_table/clone_snippet', $snippet );
save_snippet( $snippet );
}
}
}