Viewing file:  class-yoast-dashboard-widget.php (5.39 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/**
* @package WPSEO\Admin
*/
/**
* Class to change or add WordPress dashboard widgets
*/
class Yoast_Dashboard_Widget {
const CACHE_TRANSIENT_KEY = 'wpseo-dashboard-totals';
/**
* @var WPSEO_Statistics
*/
protected $statistics;
/**
* @param WPSEO_Statistics $statistics The statistics class to retrieve statistics from.
*/
public function __construct( WPSEO_Statistics $statistics = null ) {
if ( null === $statistics ) {
$statistics = new WPSEO_Statistics();
}
$this->statistics = $statistics;
add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_dashboard_stylesheet' ) );
add_action( 'wp_insert_post', array( $this, 'clear_cache' ) );
add_action( 'delete_post', array( $this, 'clear_cache' ) );
if ( $this->show_widget() ) {
add_action( 'wp_dashboard_setup', array( $this, 'add_dashboard_widget' ) );
}
}
/**
* Adds dashboard widget to WordPress
*/
public function add_dashboard_widget() {
add_filter( 'postbox_classes_dashboard_wpseo-dashboard-overview', array( $this, 'wpseo_dashboard_overview_class' ) );
wp_add_dashboard_widget(
'wpseo-dashboard-overview',
/* translators: %s is the plugin name */
sprintf( __( '%s Posts Overview', 'wordpress-seo' ), 'Yoast SEO' ),
array( $this, 'display_dashboard_widget' )
);
}
/**
* Adds CSS classes to the dashboard widget.
*
* @param array $classes An array of postbox CSS classes.
*
* @return array
*/
public function wpseo_dashboard_overview_class( $classes ) {
$classes[] = 'yoast wpseo-dashboard-overview';
return $classes;
}
/**
* Display the dashboard widget
*/
public function display_dashboard_widget() {
$statistics = $this->statistic_items();
$onpage_option = new WPSEO_OnPage_Option();
$onpage = false;
if ( $onpage_option->is_enabled() ) {
$onpage = array(
'indexable' => $onpage_option->get_status(),
'can_fetch' => $onpage_option->should_be_fetched(),
);
}
include WPSEO_PATH . '/admin/views/dashboard-widget.php';
}
/**
* Enqueue's stylesheet for the dashboard if the current page is the dashboard
*/
public function enqueue_dashboard_stylesheet() {
$current_screen = get_current_screen();
if ( $current_screen instanceof WP_Screen && 'dashboard' === $current_screen->id ) {
$asset_manager = new WPSEO_Admin_Asset_Manager();
$asset_manager->enqueue_style( 'wp-dashboard' );
}
}
/**
* Clears the dashboard widget items cache
*/
public function clear_cache() {
delete_transient( self::CACHE_TRANSIENT_KEY );
}
/**
* An array representing items to be added to the At a Glance dashboard widget
*
* @return array
*/
private function statistic_items() {
$transient = get_transient( self::CACHE_TRANSIENT_KEY );
$user_id = get_current_user_id();
if ( isset( $transient[ $user_id ] ) ) {
return $transient[ $user_id ];
}
return $this->set_statistic_items_for_this_user( $transient );
}
/**
* Set the cache for a specific user
*
* @param array|boolean $transient The current stored transient with the cached data.
*
* @return mixed
*/
private function set_statistic_items_for_this_user( $transient ) {
if ( $transient === false ) {
$transient = array();
}
$user_id = get_current_user_id();
$transient[ $user_id ] = array_filter( $this->get_seo_scores_with_post_count(), array( $this, 'filter_items' ) );
set_transient( self::CACHE_TRANSIENT_KEY, $transient, DAY_IN_SECONDS );
return $transient[ $user_id ];
}
/**
* Set the SEO scores belonging to their SEO score result
*
* @return array
*/
private function get_seo_scores_with_post_count() {
$ranks = WPSEO_Rank::get_all_ranks();
return array_map( array( $this, 'map_rank_to_widget' ), $ranks );
}
/**
* Converts a rank to data usable in the dashboard widget
*
* @param WPSEO_Rank $rank The rank to map.
*
* @return array
*/
private function map_rank_to_widget( WPSEO_Rank $rank ) {
return array(
'seo_rank' => $rank->get_rank(),
'title' => $this->get_title_for_rank( $rank ),
'class' => 'wpseo-glance-' . $rank->get_css_class(),
'icon_class' => $rank->get_css_class(),
'count' => $this->statistics->get_post_count( $rank ),
);
}
/**
* Returns a dashboard widget label to use for a certain rank
*
* @param WPSEO_Rank $rank The rank to return a label for.
*
* @return string
*/
private function get_title_for_rank( WPSEO_Rank $rank ) {
$labels = array(
WPSEO_Rank::NO_FOCUS => __( 'Posts without focus keyword', 'wordpress-seo' ),
WPSEO_Rank::BAD => __( 'Posts with bad SEO score', 'wordpress-seo' ),
WPSEO_Rank::OK => __( 'Posts with OK SEO score', 'wordpress-seo' ),
WPSEO_Rank::GOOD => __( 'Posts with good SEO score', 'wordpress-seo' ),
/* translators: %s expands to <span lang="en">noindex</span> */
WPSEO_Rank::NO_INDEX => sprintf( __( 'Posts that are set to “%s”', 'wordpress-seo' ), '<span lang="en">noindex</span>' ),
);
return $labels[ $rank->get_rank() ];
}
/**
* Filter items if they have a count of zero
*
* @param array $item Data array.
*
* @return bool
*/
private function filter_items( $item ) {
return 0 !== $item['count'];
}
/**
* Returns true when the dashboard widget should be shown.
*
* @return bool
*/
private function show_widget() {
$analysis_seo = new WPSEO_Metabox_Analysis_SEO();
return $analysis_seo->is_enabled() && current_user_can( 'edit_posts' );
}
}
|