Edit File by line

<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileNam

[0] Fix | Delete

/**

[1] Fix | Delete

* Blog Stats Widget.

[2] Fix | Delete

[3] Fix | Delete

* @since 4.5.0

[4] Fix | Delete

[5] Fix | Delete

* @package automattic/jetpack

[6] Fix | Delete

[7] Fix | Delete

[8] Fix | Delete

// phpcs:disable Universal.Files.SeparateFunctionsFromOO.Mixed -- TODO: Move classes to appropriately-named class files.

[9] Fix | Delete

[10] Fix | Delete

use Automattic\Jetpack\Stats\WPCOM_Stats;

[11] Fix | Delete

use Automattic\Jetpack\Status\Host;

[12] Fix | Delete

[13] Fix | Delete

// Disable direct access/execution to/of the widget code.

[14] Fix | Delete

if ( ! defined( 'ABSPATH' ) ) {

[15] Fix | Delete

exit( 0 );

[16] Fix | Delete

}

[17] Fix | Delete

[18] Fix | Delete

/**

[19] Fix | Delete

* Blog Stats Widget.

[20] Fix | Delete

[21] Fix | Delete

* Displays all time stats for that site.

[22] Fix | Delete

[23] Fix | Delete

* @since 4.5.0

[24] Fix | Delete

[25] Fix | Delete

class Jetpack_Blog_Stats_Widget extends WP_Widget {

[26] Fix | Delete

[27] Fix | Delete

/**

[28] Fix | Delete

* Constructor

[29] Fix | Delete

[30] Fix | Delete

public function __construct() {

[31] Fix | Delete

$widget_ops = array(

[32] Fix | Delete

'classname' => 'blog-stats',

[33] Fix | Delete

'description' => esc_html__( 'Show a hit counter for your blog.', 'jetpack' ),

[34] Fix | Delete

'customize_selective_refresh' => true,

[35] Fix | Delete

'show_instance_in_rest' => true,

[36] Fix | Delete

);

[37] Fix | Delete

parent::__construct(

[38] Fix | Delete

'blog-stats',

[39] Fix | Delete

/** This filter is documented in modules/widgets/facebook-likebox.php */

[40] Fix | Delete

apply_filters( 'jetpack_widget_name', esc_html__( 'Blog Stats', 'jetpack' ) ),

[41] Fix | Delete

$widget_ops

[42] Fix | Delete

);

[43] Fix | Delete

$this->alt_option_name = 'widget_statscounter';

[44] Fix | Delete

add_filter( 'widget_types_to_hide_from_legacy_widget_block', array( $this, 'hide_widget_in_block_editor' ) );

[45] Fix | Delete

}

[46] Fix | Delete

[47] Fix | Delete

/**

[48] Fix | Delete

* Remove the "Blog Stats" widget from the Legacy Widget block

[49] Fix | Delete

[50] Fix | Delete

* @param array $widget_types List of widgets that are currently removed from the Legacy Widget block.

[51] Fix | Delete

* @return array $widget_types New list of widgets that will be removed.

[52] Fix | Delete

[53] Fix | Delete

public function hide_widget_in_block_editor( $widget_types ) {

[54] Fix | Delete

// @TODO: Hide for Simple sites when the block API starts working.

[55] Fix | Delete

if ( ! ( new Host() )->is_wpcom_simple() ) {

[56] Fix | Delete

$widget_types[] = 'blog-stats';

[57] Fix | Delete

}

[58] Fix | Delete

return $widget_types;

[59] Fix | Delete

}

[60] Fix | Delete

[61] Fix | Delete

/**

[62] Fix | Delete

* Return an associative array of default values

[63] Fix | Delete

[64] Fix | Delete

* These values are used in new widgets.

[65] Fix | Delete

[66] Fix | Delete

* @return array Array of default values for the Widget's options

[67] Fix | Delete

[68] Fix | Delete

public function defaults() {

[69] Fix | Delete

return array(

[70] Fix | Delete

'title' => esc_html__( 'Blog Stats', 'jetpack' ),

[71] Fix | Delete

/* Translators: Number of views, plural */

[72] Fix | Delete

'hits' => esc_html__( 'hits', 'jetpack' ),

[73] Fix | Delete

);

[74] Fix | Delete

}

[75] Fix | Delete

[76] Fix | Delete

/**

[77] Fix | Delete

* Return All Time Stats for that blog.

[78] Fix | Delete

[79] Fix | Delete

* We query the WordPress.com Stats REST API endpoint.

[80] Fix | Delete

[81] Fix | Delete

* @uses Automattic\Jetpack\Stats\WPCOM_Stats->get_stats. That function caches data locally for 5 minutes.

[82] Fix | Delete

[83] Fix | Delete

* @return string|false $views All Time Stats for that blog.

[84] Fix | Delete

[85] Fix | Delete

public function get_stats() {

[86] Fix | Delete

$wpcom_stats = new WPCOM_Stats();

[87] Fix | Delete

// Get data from the WordPress.com Stats REST API endpoint.

[88] Fix | Delete

$stats = $wpcom_stats->convert_stats_array_to_object( $wpcom_stats->get_stats( array( 'fields' => 'stats' ) ) );

[89] Fix | Delete

[90] Fix | Delete

if ( isset( $stats->stats->views ) ) {

[91] Fix | Delete

return $stats->stats->views;

[92] Fix | Delete

} else {

[93] Fix | Delete

return false;

[94] Fix | Delete

}

[95] Fix | Delete

}

[96] Fix | Delete

[97] Fix | Delete

/**

[98] Fix | Delete

* Back end widget form.

[99] Fix | Delete

[100] Fix | Delete

* @see WP_Widget::form()

[101] Fix | Delete

[102] Fix | Delete

* @param array $instance Previously saved values from database.

[103] Fix | Delete

[104] Fix | Delete

* @return string|void

[105] Fix | Delete

[106] Fix | Delete

public function form( $instance ) {

[107] Fix | Delete

$instance = wp_parse_args( $instance, $this->defaults() );

[108] Fix | Delete

[109] Fix | Delete

[110] Fix | Delete

<p>

[111] Fix | Delete

<label for="<?php echo esc_attr( $this->get_field_id( 'title' ) ); ?>"><?php esc_html_e( 'Title:', 'jetpack' ); ?></label>

[112] Fix | Delete

<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'] ); ?>" />

[113] Fix | Delete

</p>

[114] Fix | Delete

<p>

[115] Fix | Delete

<label for="<?php echo esc_attr( $this->get_field_id( 'hits' ) ); ?>"><?php esc_html_e( 'Pageview Description:', 'jetpack' ); ?></label>

[116] Fix | Delete

<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'] ); ?>" />

[117] Fix | Delete

</p>

[118] Fix | Delete

[119] Fix | Delete

[120] Fix | Delete

<?php

[121] Fix | Delete

}

[122] Fix | Delete

[123] Fix | Delete

/**

[124] Fix | Delete

* Sanitize widget form values as they are saved.

[125] Fix | Delete

[126] Fix | Delete

* @see WP_Widget::update()

[127] Fix | Delete

[128] Fix | Delete

* @param array $new_instance Values just sent to be saved.

[129] Fix | Delete

* @param array $old_instance Previously saved values from database.

[130] Fix | Delete

[131] Fix | Delete

* @return array Updated safe values to be saved.

[132] Fix | Delete

[133] Fix | Delete

public function update( $new_instance, $old_instance ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable

[134] Fix | Delete

$instance = array();

[135] Fix | Delete

$instance['title'] = wp_kses( $new_instance['title'], array() );

[136] Fix | Delete

$instance['hits'] = wp_kses( $new_instance['hits'], array() );

[137] Fix | Delete

[138] Fix | Delete

return $instance;

[139] Fix | Delete

}

[140] Fix | Delete

[141] Fix | Delete

/**

[142] Fix | Delete

* Front-end display of widget.

[143] Fix | Delete

[144] Fix | Delete

* @see WP_Widget::widget()

[145] Fix | Delete

[146] Fix | Delete

* @param array $args Widget arguments.

[147] Fix | Delete

* @param array $instance Saved values from database.

[148] Fix | Delete

[149] Fix | Delete

public function widget( $args, $instance ) {

[150] Fix | Delete

$instance = wp_parse_args( $instance, $this->defaults() );

[151] Fix | Delete

[152] Fix | Delete

/** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */

[153] Fix | Delete

$title = apply_filters( 'widget_title', $instance['title'] );

[154] Fix | Delete

[155] Fix | Delete

echo $args['before_widget']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped

[156] Fix | Delete

[157] Fix | Delete

if ( ! empty( $title ) ) {

[158] Fix | Delete

echo $args['before_title'] . $title . $args['after_title']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped

[159] Fix | Delete

}

[160] Fix | Delete

[161] Fix | Delete

// Get the Site Stats.

[162] Fix | Delete

$views = $this->get_stats();

[163] Fix | Delete

[164] Fix | Delete

if ( 0 === $views ) {

[165] Fix | Delete

esc_html_e( 'There is nothing to display yet', 'jetpack' );

[166] Fix | Delete

} elseif ( $views ) {

[167] Fix | Delete

printf(

[168] Fix | Delete

'<ul><li>%1$s %2$s</li></ul>',

[169] Fix | Delete

esc_html( number_format_i18n( $views ) ),

[170] Fix | Delete

isset( $instance['hits'] ) ? esc_html( $instance['hits'] ) : ''

[171] Fix | Delete

);

[172] Fix | Delete

} else {

[173] Fix | Delete

esc_html_e( 'There was an issue retrieving stats. Please try again later.', 'jetpack' );

[174] Fix | Delete

}

[175] Fix | Delete

[176] Fix | Delete

echo $args['after_widget']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped

[177] Fix | Delete

[178] Fix | Delete

/** This action is already documented in modules/widgets/gravatar-profile.php */

[179] Fix | Delete

do_action( 'jetpack_stats_extra', 'widget_view', 'blog_stats' );

[180] Fix | Delete

}

[181] Fix | Delete

}

[182] Fix | Delete

[183] Fix | Delete

/**

[184] Fix | Delete

* If the Stats module is active in a recent version of Jetpack, register the widget.

[185] Fix | Delete

[186] Fix | Delete

* @since 4.5.0

[187] Fix | Delete

[188] Fix | Delete

function jetpack_blog_stats_widget_init() {

[189] Fix | Delete

if ( Jetpack::is_module_active( 'stats' ) ) {

[190] Fix | Delete

register_widget( 'Jetpack_Blog_Stats_Widget' );

[191] Fix | Delete

}

[192] Fix | Delete

}

[193] Fix | Delete

add_action( 'widgets_init', 'jetpack_blog_stats_widget_init' );

[194] Fix | Delete

[195] Fix | Delete