summaryrefslogtreecommitdiff
blob: 8f8f0f332176521f529f6b4538801c1967485f93 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
<?php
/**
 * Blog Stats Widget.
 *
 * @since 4.5.0
 *
 * @package Jetpack
 */

/**
 * 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
	 */
	function __construct() {
		$widget_ops = array(
			'classname'                   => 'blog-stats',
			'description'                 => esc_html__( 'Show a hit counter for your blog.', 'jetpack' ),
			'customize_selective_refresh' => 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';
	}

	/**
	 * 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 stats_get_from_restapi(). That function caches data locally for 5 minutes.
	 *
	 * @return string|false $views All Time Stats for that blog.
	 */
	public function get_stats() {
		// Get data from the WordPress.com Stats REST API endpoint.
		$stats = stats_get_from_restapi( 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
	 */
	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 echo number_format_i18n( '12345' ); ?></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 60 seconds.', '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.
	 */
	function update( $new_instance, $old_instance ) {
		$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.
	 */
	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'];

		if ( ! empty( $title ) ) {
			echo $args['before_title'] . esc_html( $title ) . $args['after_title'];
		}

		// Get the Site Stats.
		$views = $this->get_stats();

		if ( ! empty( $views ) ) {
			printf(
				'<ul><li>%1$s %2$s</li></ul>',
				number_format_i18n( $views ),
				isset( $instance['hits'] ) ? esc_html( $instance['hits'] ) : ''
			);
		} else {
			esc_html_e( 'No hits.', 'jetpack' );
		}

		echo $args['after_widget'];

		/** 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 ( function_exists( 'stats_get_from_restapi' ) ) {
		register_widget( 'Jetpack_Blog_Stats_Widget' );
	}
}
add_action( 'widgets_init', 'jetpack_blog_stats_widget_init' );