<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileNam /** * Blog Stats Widget. * * @since 4.5.0 * * @package automattic/jetpack */ // phpcs:disable Universal.Files.SeparateFunctionsFromOO.Mixed -- TODO: Move classes to appropriately-named class files. use Automattic\Jetpack\Stats\WPCOM_Stats; use Automattic\Jetpack\Status\Host; // Disable direct access/execution to/of the widget code. if ( ! defined( 'ABSPATH' ) ) { exit; } /** * Blog Stats Widget. * * Displays all time stats for that site. * * @since 4.5.0 */ class Jetpack_Blog_Stats_Widget extends WP_Widget { /** * Constructor */ public function __construct() { $widget_ops = array( 'classname' => 'blog-stats', 'description' => esc_html__( 'Show a hit counter for your blog.', 'jetpack' ), 'customize_selective_refresh' => true, 'show_instance_in_rest' => true, ); parent::__construct( 'blog-stats', /** This filter is documented in modules/widgets/facebook-likebox.php */ apply_filters( 'jetpack_widget_name', esc_html__( 'Blog Stats', 'jetpack' ) ), $widget_ops ); $this->alt_option_name = 'widget_statscounter'; add_filter( 'widget_types_to_hide_from_legacy_widget_block', array( $this, 'hide_widget_in_block_editor' ) ); } /** * Remove the "Blog Stats" widget from the Legacy Widget block * * @param array $widget_types List of widgets that are currently removed from the Legacy Widget block. * @return array $widget_types New list of widgets that will be removed. */ public function hide_widget_in_block_editor( $widget_types ) { // @TODO: Hide for Simple sites when the block API starts working. if ( ! ( new Host() )->is_wpcom_simple() ) { $widget_types[] = 'blog-stats'; } return $widget_types; } /** * Return an associative array of default values * * These values are used in new widgets. * * @return array Array of default values for the Widget's options */ public function defaults() { return array( 'title' => esc_html__( 'Blog Stats', 'jetpack' ), /* Translators: Number of views, plural */ 'hits' => esc_html__( 'hits', 'jetpack' ), ); } /** * Return All Time Stats for that blog. * * We query the WordPress.com Stats REST API endpoint. * * @uses Automattic\Jetpack\Stats\WPCOM_Stats->get_stats. That function caches data locally for 5 minutes. * * @return string|false $views All Time Stats for that blog. */ public function get_stats() { $wpcom_stats = new WPCOM_Stats(); // Get data from the WordPress.com Stats REST API endpoint. $stats = $wpcom_stats->convert_stats_array_to_object( $wpcom_stats->get_stats( array( 'fields' => 'stats' ) ) ); if ( isset( $stats->stats->views ) ) { return $stats->stats->views; } else { return false; } } /** * Back end widget form. * * @see WP_Widget::form() * * @param array $instance Previously saved values from database. * * @return void */ public function form( $instance ) { $instance = wp_parse_args( $instance, $this->defaults() ); ?> <p> <label for="<?php echo esc_attr( $this->get_field_id( 'title' ) ); ?>"><?php esc_html_e( 'Title:', 'jetpack' ); ?></label> <input class="widefat" id="<?php echo esc_attr( $this->get_field_id( 'title' ) ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'title' ) ); ?>" type="text" value="<?php echo esc_attr( $instance['title'] ); ?>" /> </p> <p> <label for="<?php echo esc_attr( $this->get_field_id( 'hits' ) ); ?>"><?php esc_html_e( 'Pageview Description:', 'jetpack' ); ?></label> <input class="widefat" id="<?php echo esc_attr( $this->get_field_id( 'hits' ) ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'hits' ) ); ?>" type="text" value="<?php echo esc_attr( $instance['hits'] ); ?>" /> </p> <p><?php esc_html_e( 'Hit counter is delayed by up to 5 minutes.', 'jetpack' ); ?></p> <?php } /** * Sanitize widget form values as they are saved. * * @see WP_Widget::update() * * @param array $new_instance Values just sent to be saved. * @param array $old_instance Previously saved values from database. * * @return array Updated safe values to be saved. */ public function update( $new_instance, $old_instance ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable $instance = array(); $instance['title'] = wp_kses( $new_instance['title'], array() ); $instance['hits'] = wp_kses( $new_instance['hits'], array() ); return $instance; } /** * Front-end display of widget. * * @see WP_Widget::widget() * * @param array $args Widget arguments. * @param array $instance Saved values from database. */ public function widget( $args, $instance ) { $instance = wp_parse_args( $instance, $this->defaults() ); /** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */ $title = apply_filters( 'widget_title', $instance['title'] ); echo $args['before_widget']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped if ( ! empty( $title ) ) { echo $args['before_title'] . $title . $args['after_title']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped } // Get the Site Stats. $views = $this->get_stats(); if ( 0 === $views ) { esc_html_e( 'There is nothing to display yet', 'jetpack' ); } elseif ( $views ) { printf( '<ul><li>%1$s %2$s</li></ul>', esc_html( number_format_i18n( $views ) ), isset( $instance['hits'] ) ? esc_html( $instance['hits'] ) : '' ); } else { esc_html_e( 'There was an issue retrieving stats. Please try again later.', 'jetpack' ); } echo $args['after_widget']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped /** This action is already documented in modules/widgets/gravatar-profile.php */ do_action( 'jetpack_stats_extra', 'widget_view', 'blog_stats' ); } } /** * If the Stats module is active in a recent version of Jetpack, register the widget. * * @since 4.5.0 */ function jetpack_blog_stats_widget_init() { if ( Jetpack::is_module_active( 'stats' ) ) { register_widget( 'Jetpack_Blog_Stats_Widget' ); } } add_action( 'widgets_init', 'jetpack_blog_stats_widget_init' );
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
authors | Folder | 0755 |
|
|
contact-info | Folder | 0755 |
|
|
eu-cookie-law | Folder | 0755 |
|
|
facebook-likebox | Folder | 0755 |
|
|
flickr | Folder | 0755 |
|
|
gallery | Folder | 0755 |
|
|
goodreads | Folder | 0755 |
|
|
google-translate | Folder | 0755 |
|
|
image-widget | Folder | 0755 |
|
|
Folder | 0755 |
|
||
internet-defense-league | Folder | 0755 |
|
|
migrate-to-core | Folder | 0755 |
|
|
milestone | Folder | 0755 |
|
|
my-community | Folder | 0755 |
|
|
simple-payments | Folder | 0755 |
|
|
social-icons | Folder | 0755 |
|
|
social-media-icons | Folder | 0755 |
|
|
top-posts | Folder | 0755 |
|
|
wordpress-post-widget | Folder | 0755 |
|
|
authors.php | File | 8.95 KB | 0644 |
|
blog-stats.php | File | 6.11 KB | 0644 |
|
class-jetpack-eu-cookie-law-widget.php | File | 10.55 KB | 0644 |
|
class-jetpack-instagram-widget.php | File | 24.05 KB | 0644 |
|
contact-info.php | File | 17.95 KB | 0644 |
|
customizer-controls.css | File | 165 B | 0644 |
|
customizer-utils.js | File | 4.06 KB | 0644 |
|
facebook-likebox.php | File | 15.28 KB | 0644 |
|
flickr.php | File | 7.46 KB | 0644 |
|
gallery.php | File | 16.14 KB | 0644 |
|
goodreads.php | File | 8.71 KB | 0644 |
|
google-translate.php | File | 6.44 KB | 0644 |
|
gravatar-profile.css | File | 1.23 KB | 0644 |
|
gravatar-profile.php | File | 16.04 KB | 0644 |
|
image-widget.php | File | 12.09 KB | 0644 |
|
internet-defense-league.php | File | 5.65 KB | 0644 |
|
mailchimp.php | File | 4.29 KB | 0644 |
|
milestone.php | File | 346 B | 0644 |
|
my-community.php | File | 10.93 KB | 0644 |
|
rsslinks-widget.php | File | 10.6 KB | 0644 |
|
simple-payments.php | File | 21.91 KB | 0644 |
|
social-icons.php | File | 22.41 KB | 0644 |
|
social-media-icons.php | File | 10.72 KB | 0644 |
|
top-posts.php | File | 27.65 KB | 0644 |
|
twitter-timeline-admin.js | File | 2.18 KB | 0644 |
|
twitter-timeline.php | File | 19.9 KB | 0644 |
|
upcoming-events.php | File | 6.73 KB | 0644 |
|
wordpress-post-widget.php | File | 3.71 KB | 0644 |
|