page_type) there will be constructed an url part, for subpages and
* navigation
*
* @var string
*/
protected $page_url;
/**
* The settings which will be used in the __construct.
*
* @var array
*/
protected $settings;
/**
* @var array
*/
protected $pagination = array();
/**
* Class constructor
*/
function __construct() {
parent::__construct( $this->settings );
$this->request_url = $_SERVER['REQUEST_URI'];
$this->current_page = ( ! empty( $_GET['paged'] ) ) ? $_GET['paged'] : 1;
$this->current_filter = ( ! empty( $_GET['post_type_filter'] ) ) ? $_GET['post_type_filter'] : 1;
$this->current_status = ( ! empty( $_GET['post_status'] ) ) ? $_GET['post_status'] : 1;
$this->current_order = array(
'order' => ( ! empty( $_GET['order'] ) ) ? $_GET['order'] : 'asc',
'orderby' => ( ! empty( $_GET['orderby'] ) ) ? $_GET['orderby'] : 'post_title',
);
$this->verify_nonce();
$this->nonce = wp_create_nonce( 'bulk-editor-table' );
$this->page_url = "&nonce={$this->nonce}&type={$this->page_type}#top#{$this->page_type}";
$this->populate_editable_post_types();
}
/**
* Verifies nonce if additional parameters have been sent.
*
* Shows an error notification if the nonce check fails.
*/
private function verify_nonce() {
if ( $this->should_verify_nonce() && ! wp_verify_nonce( filter_input( INPUT_GET, 'nonce' ), 'bulk-editor-table' ) ) {
Yoast_Notification_Center::get()->add_notification(
new Yoast_Notification(
__( 'You are not allowed to access this page.', 'wordpress-seo' ),
array( 'type' => Yoast_Notification::ERROR )
)
);
Yoast_Notification_Center::get()->display_notifications();
die;
}
}
/**
* Checks if additional parameters have been sent to determine if nonce should be checked or not.
*
* @return bool
*/
private function should_verify_nonce() {
$possible_params = array(
'type',
'paged',
'post_type_filter',
'post_status',
'order',
'orderby',
);
foreach ( $possible_params as $param_name ) {
if ( filter_input( INPUT_GET, $param_name ) ) {
return true;
}
}
}
/**
* Prepares the data and renders the page.
*/
public function show_page() {
$this->prepare_page_navigation();
$this->prepare_items();
$this->views();
$this->display();
}
/**
* Used in the constructor to build a reference list of post types the current user can edit.
*/
protected function populate_editable_post_types() {
$post_types = get_post_types( array( 'public' => true, 'exclude_from_search' => false ), 'object' );
$this->all_posts = array();
$this->own_posts = array();
if ( is_array( $post_types ) && $post_types !== array() ) {
foreach ( $post_types as $post_type ) {
if ( ! current_user_can( $post_type->cap->edit_posts ) ) {
continue;
}
if ( current_user_can( $post_type->cap->edit_others_posts ) ) {
$this->all_posts[] = esc_sql( $post_type->name );
}
else {
$this->own_posts[] = esc_sql( $post_type->name );
}
}
}
}
/**
* Will shown the navigation for the table like pagenavigation and pagefilter;
*
* @param string $which Table nav location (such as top).
*/
function display_tablenav( $which ) {
$post_status = sanitize_text_field( filter_input( INPUT_GET, 'post_status' ) );
?>
prepare(), passing the current user_id in as the first parameter.
*/
function get_base_subquery() {
global $wpdb;
$all_posts_string = "'" . implode( "', '", $this->all_posts ) . "'";
$own_posts_string = "'" . implode( "', '", $this->own_posts ) . "'";
$post_author = esc_sql( (int) get_current_user_id() );
$subquery = "(
SELECT *
FROM {$wpdb->posts}
WHERE post_type IN ({$all_posts_string})
UNION ALL
SELECT *
FROM {$wpdb->posts}
WHERE post_type IN ({$own_posts_string}) AND post_author = {$post_author}
) sub_base";
return $subquery;
}
/**
* @return array
*/
function get_views() {
global $wpdb;
$status_links = array();
$states = get_post_stati( array( 'show_in_admin_all_list' => true ) );
$states['trash'] = 'trash';
$states = esc_sql( $states );
$all_states = "'" . implode( "', '", $states ) . "'";
$subquery = $this->get_base_subquery();
$total_posts = $wpdb->get_var(
"
SELECT COUNT(ID) FROM {$subquery}
WHERE post_status IN ({$all_states})
"
);
$post_status = filter_input( INPUT_GET, 'post_status' );
$class = empty( $post_status ) ? ' class="current"' : '';
$status_links['all'] = '' . sprintf( _nx( 'All (%s)', 'All (%s)', $total_posts, 'posts', 'wordpress-seo' ), number_format_i18n( $total_posts ) ) . '';
$post_stati = get_post_stati( array( 'show_in_admin_all_list' => true ), 'objects' );
if ( is_array( $post_stati ) && $post_stati !== array() ) {
foreach ( $post_stati as $status ) {
$status_name = esc_sql( $status->name );
$total = (int) $wpdb->get_var(
$wpdb->prepare(
"
SELECT COUNT(ID) FROM {$subquery}
WHERE post_status = %s
",
$status_name
)
);
if ( $total === 0 ) {
continue;
}
$class = '';
if ( $status_name === $post_status ) {
$class = ' class="current"';
}
$status_links[ $status_name ] = '' . sprintf( translate_nooped_plural( $status->label_count, $total ), number_format_i18n( $total ) ) . '';
}
}
unset( $post_stati, $status, $status_name, $total, $class );
$trashed_posts = $wpdb->get_var(
"
SELECT COUNT(ID) FROM {$subquery}
WHERE post_status IN ('trash')
"
);
$class = '';
if ( 'trash' === $post_status ) {
$class = 'class="current"';
}
$status_links['trash'] = '' . sprintf( _nx( 'Trash (%s)', 'Trash (%s)', $trashed_posts, 'posts', 'wordpress-seo' ), number_format_i18n( $trashed_posts ) ) . '';
return $status_links;
}
/**
* @param string $which Table nav location (such as top).
*/
function extra_tablenav( $which ) {
if ( 'top' === $which ) {
$post_types = get_post_types( array( 'public' => true, 'exclude_from_search' => false ) );
$instance_type = esc_attr( $this->page_type );
if ( is_array( $post_types ) && $post_types !== array() ) {
global $wpdb;
echo '';
$post_types = esc_sql( $post_types );
$post_types = "'" . implode( "', '", $post_types ) . "'";
$states = get_post_stati( array( 'show_in_admin_all_list' => true ) );
$states['trash'] = 'trash';
$states = esc_sql( $states );
$all_states = "'" . implode( "', '", $states ) . "'";
$subquery = $this->get_base_subquery();
$post_types = $wpdb->get_results(
"
SELECT DISTINCT post_type FROM {$subquery}
WHERE post_status IN ({$all_states})
ORDER BY 'post_type' ASC
"
);
$post_type_filter = filter_input( INPUT_GET, 'post_type_filter' );
$selected = ( ! empty( $post_type_filter ) ) ? sanitize_text_field( $post_type_filter ) : '-1';
$options = '';
if ( is_array( $post_types ) && $post_types !== array() ) {
foreach ( $post_types as $post_type ) {
$obj = get_post_type_object( $post_type->post_type );
$options .= sprintf( '', $obj->labels->name, $post_type->post_type, selected( $selected, $post_type->post_type, false ) );
}
}
printf(
'',
'post-type-filter-' . $instance_type,
__( 'Filter by post type', 'wordpress-seo' )
);
echo sprintf( '', $options, $instance_type );
submit_button( __( 'Filter', 'wordpress-seo' ), 'button', false, false, array( 'id' => 'post-query-submit' ) );
echo '
';
}
}
}
/**
*
* @return array
*/
function get_sortable_columns() {
return $sortable = array(
'col_page_title' => array( 'post_title', true ),
'col_post_type' => array( 'post_type', false ),
'col_post_date' => array( 'post_date', false ),
);
}
/**
* Sets the correct pagenumber and pageurl for the navigation
*/
function prepare_page_navigation() {
$request_url = $this->request_url . $this->page_url;
$current_page = $this->current_page;
$current_filter = $this->current_filter;
$current_status = $this->current_status;
$current_order = $this->current_order;
// If current type doesn't compare with objects page_type, than we have to unset some vars in the requested url (which will be use for internal table urls).
if ( $_GET['type'] != $this->page_type ) {
$request_url = remove_query_arg( 'paged', $request_url ); // Page will be set with value 1 below.
$request_url = remove_query_arg( 'post_type_filter', $request_url );
$request_url = remove_query_arg( 'post_status', $request_url );
$request_url = remove_query_arg( 'orderby', $request_url );
$request_url = remove_query_arg( 'order', $request_url );
$request_url = add_query_arg( 'pages', 1, $request_url );
$current_page = 1;
$current_filter = '-1';
$current_status = '';
$current_order = array( 'orderby' => 'post_title', 'order' => 'asc' );
}
$_SERVER['REQUEST_URI'] = $request_url;
$_GET['paged'] = $current_page;
$_REQUEST['paged'] = $current_page;
$_REQUEST['post_type_filter'] = $current_filter;
$_GET['post_type_filter'] = $current_filter;
$_GET['post_status'] = $current_status;
$_GET['orderby'] = $current_order['orderby'];
$_GET['order'] = $current_order['order'];
}
/**
* Preparing the requested pagerows and setting the needed variables
*/
function prepare_items() {
$post_type_clause = $this->get_post_type_clause();
$all_states = $this->get_all_states();
$subquery = $this->get_base_subquery();
// Setting the column headers.
$this->set_column_headers();
// Count the total number of needed items and setting pagination given $total_items.
$total_items = $this->count_items( $subquery, $all_states, $post_type_clause );
$this->set_pagination( $total_items );
// Getting items given $query.
$query = $this->parse_item_query( $subquery, $all_states, $post_type_clause );
$this->get_items( $query );
// Get the metadata for the current items ($this->items).
$this->get_meta_data();
}
/**
* Getting the columns for first row
*
* @return array
*/
public function get_columns() {
return $this->merge_columns();
}
/**
* Setting the column headers
*/
protected function set_column_headers() {
$columns = $this->get_columns();
$hidden = array();
$sortable = $this->get_sortable_columns();
$this->_column_headers = array( $columns, $hidden, $sortable );
}
/**
* Counting total items
*
* @param string $subquery SQL FROM part.
* @param string $all_states SQL IN part.
* @param string $post_type_clause SQL post type part.
*
* @return mixed
*/
protected function count_items( $subquery, $all_states, $post_type_clause ) {
global $wpdb;
$total_items = $wpdb->get_var(
"
SELECT COUNT(ID)
FROM {$subquery}
WHERE post_status IN ({$all_states}) $post_type_clause
"
);
return $total_items;
}
/**
* Getting the post_type_clause filter
*
* @return string
*/
protected function get_post_type_clause() {
// Filter Block.
$post_types = null;
$post_type_clause = '';
$post_type_filter = filter_input( INPUT_GET, 'post_type_filter' );
if ( ! empty( $post_type_filter ) && get_post_type_object( sanitize_text_field( $post_type_filter ) ) ) {
$post_types = esc_sql( sanitize_text_field( $post_type_filter ) );
$post_type_clause = "AND post_type IN ('{$post_types}')";
}
return $post_type_clause;
}
/**
* Setting the pagination.
*
* Total items is the number of all visible items.
*
* @param int $total_items Total items counts.
*/
protected function set_pagination( $total_items ) {
// Calculate items per page.
$per_page = $this->get_items_per_page( 'wpseo_posts_per_page', 10 );
$paged = esc_sql( sanitize_text_field( filter_input( INPUT_GET, 'paged' ) ) );
if ( empty( $paged ) || ! is_numeric( $paged ) || $paged <= 0 ) {
$paged = 1;
}
$this->set_pagination_args(
array(
'total_items' => $total_items,
'total_pages' => ceil( $total_items / $per_page ),
'per_page' => $per_page,
)
);
$this->pagination = array(
'per_page' => $per_page,
'offset' => ( $paged - 1 ) * $per_page,
);
}
/**
* Parse the query to get items from database.
*
* Based on given parameters there will be parse a query which will get all the pages/posts and other post_types
* from the database.
*
* @param string $subquery SQL FROM part.
* @param string $all_states SQL IN part.
* @param string $post_type_clause SQL post type part.
*
* @return string
*/
protected function parse_item_query( $subquery, $all_states, $post_type_clause ) {
// Order By block.
$orderby = filter_input( INPUT_GET, 'orderby' );
$orderby = ! empty( $orderby ) ? esc_sql( sanitize_text_field( $orderby ) ) : 'post_title';
$orderby = $this->sanitize_orderby( $orderby );
// Order clause.
$order = filter_input( INPUT_GET, 'order' );
$order = ! empty( $order ) ? esc_sql( strtoupper( sanitize_text_field( $order ) ) ) : 'ASC';
$order = $this->sanitize_order( $order );
// Get all needed results.
$query = "
SELECT ID, post_title, post_type, post_status, post_modified, post_date
FROM {$subquery}
WHERE post_status IN ({$all_states}) $post_type_clause
ORDER BY {$orderby} {$order}
LIMIT %d,%d
";
return $query;
}
/**
* Heavily restricts the possible columns by which a user can order the table in the bulk editor, thereby preventing a possible CSRF vulnerability.
*
* @param string $orderby The column by which we want to order.
*
* @return string $orderby
*/
protected function sanitize_orderby( $orderby ) {
$valid_column_names = array(
'post_title',
'post_type',
'post_date',
);
if ( in_array( $orderby, $valid_column_names ) ) {
return $orderby;
}
return 'post_title';
}
/**
* Makes sure the order clause is always ASC or DESC for the bulk editor table, thereby preventing a possible CSRF vulnerability.
*
* @param string $order Whether we want to sort ascending or descending.
*
* @return string $order SQL order string (ASC, DESC).
*/
protected function sanitize_order( $order ) {
if ( in_array( strtoupper( $order ), array( 'ASC', 'DESC' ) ) ) {
return $order;
}
return 'ASC';
}
/**
* Getting all the items.
*
* @param string $query SQL query to use.
*/
protected function get_items( $query ) {
global $wpdb;
$this->items = $wpdb->get_results(
$wpdb->prepare(
$query,
$this->pagination['offset'],
$this->pagination['per_page']
)
);
}
/**
* Getting all the states.
*
* @return string
*/
protected function get_all_states() {
$states = get_post_stati( array( 'show_in_admin_all_list' => true ) );
$states['trash'] = 'trash';
if ( ! empty( $_GET['post_status'] ) ) {
$requested_state = sanitize_text_field( $_GET['post_status'] );
if ( in_array( $requested_state, $states ) ) {
$states = array( $requested_state );
}
}
$states = esc_sql( $states );
$all_states = "'" . implode( "', '", $states ) . "'";
return $all_states;
}
/**
* Based on $this->items and the defined columns, the table rows will be displayed.
*/
function display_rows() {
$records = $this->items;
list( $columns, $hidden, $sortable, $primary ) = $this->get_column_info();
if ( ( is_array( $records ) && $records !== array() ) && ( is_array( $columns ) && $columns !== array() ) ) {
foreach ( $records as $rec ) {
echo '';
foreach ( $columns as $column_name => $column_display_name ) {
$classes = '';
if ( $primary === $column_name ) {
$classes .= ' has-row-actions column-primary';
}
$attributes = $this->column_attributes( $column_name, $hidden, $classes );
$column_value = $this->parse_column( $column_name, $rec );
if ( method_exists( $this, 'parse_page_specific_column' ) && empty( $column_value ) ) {
$column_value = $this->parse_page_specific_column( $column_name, $rec, $attributes );
}
if ( ! empty( $column_value ) ) {
echo sprintf( '| %1$s | ', $column_value, $attributes );
}
}
echo '
';
}
}
}
/**
* Getting the attributes for each table cell.
*
* @param string $column_name Column name string.
* @param array $hidden Set of hidden columns.
* @param string $classes Additional CSS classes.
*
* @return string
*/
protected function column_attributes( $column_name, $hidden, $classes ) {
$attributes = '';
$class = array( $column_name, "column-$column_name$classes" );
if ( in_array( $column_name, $hidden ) ) {
$class[] = 'hidden';
}
if ( ! empty( $class ) ) {
$attributes = 'class="' . implode( ' ', $class ) . '"';
}
return $attributes;
}
/**
* Parsing the title.
*
* @param WP_Post $rec Post object.
*
* @return string
*/
protected function parse_page_title_column( $rec ) {
$title = empty( $rec->post_title ) ? __( '(no title)', 'wordpress-seo' ) : $rec->post_title;
$return = sprintf( '%1$s', stripslashes( wp_strip_all_tags( $title ) ) );
$post_type_object = get_post_type_object( $rec->post_type );
$can_edit_post = current_user_can( $post_type_object->cap->edit_post, $rec->ID );
$actions = array();
if ( $can_edit_post && 'trash' !== $rec->post_status ) {
$actions['edit'] = sprintf(
'%s',
esc_url( get_edit_post_link( $rec->ID, true ) ),
/* translators: %s: post title */
esc_attr( sprintf( __( 'Edit “%s”', 'wordpress-seo' ), $title ) ),
__( 'Edit', 'wordpress-seo' )
);
}
if ( $post_type_object->public ) {
if ( in_array( $rec->post_status, array( 'pending', 'draft', 'future' ) ) ) {
if ( $can_edit_post ) {
$actions['view'] = sprintf(
'%s',
esc_url( add_query_arg( 'preview', 'true', get_permalink( $rec->ID ) ) ),
/* translators: %s: post title */
esc_attr( sprintf( __( 'Preview “%s”', 'wordpress-seo' ), $title ) ),
__( 'Preview', 'wordpress-seo' )
);
}
}
elseif ( 'trash' !== $rec->post_status ) {
$actions['view'] = sprintf(
'%s',
esc_url( get_permalink( $rec->ID ) ),
/* translators: %s: post title */
esc_attr( sprintf( __( 'View “%s”', 'wordpress-seo' ), $title ) ),
__( 'View', 'wordpress-seo' )
);
}
}
$return .= $this->row_actions( $actions );
return $return;
}
/**
* Parsing the column based on the $column_name.
*
* @param string $column_name Column name.
* @param WP_Post $rec Post object.
*
* @return string
*/
protected function parse_column( $column_name, $rec ) {
static $date_format;
if ( $date_format == null ) {
$date_format = get_option( 'date_format' );
}
switch ( $column_name ) {
case 'col_page_title':
$column_value = $this->parse_page_title_column( $rec );
break;
case 'col_page_slug':
$permalink = get_permalink( $rec->ID );
$display_slug = str_replace( get_bloginfo( 'url' ), '', $permalink );
$column_value = sprintf( '%1$s', stripslashes( $display_slug ), esc_url( $permalink ) );
break;
case 'col_post_type':
$post_type = get_post_type_object( $rec->post_type );
$column_value = $post_type->labels->singular_name;
break;
case 'col_post_status':
$post_status = get_post_status_object( $rec->post_status );
$column_value = $post_status->label;
break;
case 'col_post_date':
$column_value = date_i18n( $date_format, strtotime( $rec->post_date ) );
break;
case 'col_row_action':
$column_value = sprintf( 'Save | Save All', $rec->ID );
break;
}
if ( ! empty( $column_value ) ) {
return $column_value;
}
}
/**
* Parse the field where the existing meta-data value is displayed.
*
* @param integer $record_id Record ID.
* @param string $attributes HTML attributes.
* @param bool|array $values Optional values data array.
*
* @return string
*/
protected function parse_meta_data_field( $record_id, $attributes, $values = false ) {
// Fill meta data if exists in $this->meta_data.
$meta_data = ( ! empty( $this->meta_data[ $record_id ] ) ) ? $this->meta_data[ $record_id ] : array();
$meta_key = WPSEO_Meta::$meta_prefix . $this->target_db_field;
$meta_value = ( ! empty( $meta_data[ $meta_key ] ) ) ? $meta_data[ $meta_key ] : '';
if ( ! empty( $values ) ) {
$meta_value = $values[ $meta_value ];
}
return sprintf( '%1$s | ', $meta_value, $attributes, $record_id, $this->target_db_field );
}
/**
* Method for setting the meta data, which belongs to the records that will be shown on the current page.
*
* This method will loop through the current items ($this->items) for getting the post_id. With this data
* ($needed_ids) the method will query the meta-data table for getting the title.
*/
protected function get_meta_data() {
$post_ids = $this->get_post_ids();
$meta_data = $this->get_meta_data_result( $post_ids );
$this->parse_meta_data( $meta_data );
// Little housekeeping.
unset( $post_ids, $meta_data );
}
/**
* Getting all post_ids from to $this->items.
*
* @return string
*/
protected function get_post_ids() {
$needed_ids = array();
foreach ( $this->items as $item ) {
$needed_ids[] = $item->ID;
}
$post_ids = "'" . implode( "', '", $needed_ids ) . "'";
return $post_ids;
}
/**
* Getting the meta_data from database.
*
* @param string $post_ids Post IDs string for SQL IN part.
*
* @return mixed
*/
protected function get_meta_data_result( $post_ids ) {
global $wpdb;
$meta_data = $wpdb->get_results(
"
SELECT *
FROM {$wpdb->postmeta}
WHERE post_id IN({$post_ids}) && meta_key = '" . WPSEO_Meta::$meta_prefix . $this->target_db_field . "'
"
);
return $meta_data;
}
/**
* Setting $this->meta_data.
*
* @param array $meta_data Meta data set.
*/
protected function parse_meta_data( $meta_data ) {
foreach ( $meta_data as $row ) {
$this->meta_data[ $row->post_id ][ $row->meta_key ] = $row->meta_value;
}
}
/**
* This method will merge general array with given parameter $columns.
*
* @param array $columns Optional columns set.
*
* @return array
*/
protected function merge_columns( $columns = array() ) {
$columns = array_merge(
array(
'col_page_title' => __( 'WP Page Title', 'wordpress-seo' ),
'col_post_type' => __( 'Post Type', 'wordpress-seo' ),
'col_post_status' => __( 'Post Status', 'wordpress-seo' ),
'col_post_date' => __( 'Publication date', 'wordpress-seo' ),
'col_page_slug' => __( 'Page URL/Slug', 'wordpress-seo' ),
),
$columns
);
$columns['col_row_action'] = __( 'Action', 'wordpress-seo' );
return $columns;
}
} /* End of class */