authors
8 years ago
contact-info
5 years ago
eu-cookie-law
2 years ago
facebook-likebox
11 years ago
flickr
2 years ago
gallery
4 years ago
goodreads
5 years ago
google-translate
4 years ago
image-widget
8 years ago
instagram
6 years ago
internet-defense-league
3 years ago
migrate-to-core
3 years ago
milestone
2 years ago
my-community
8 years ago
simple-payments
4 years ago
social-icons
4 years ago
social-media-icons
5 years ago
top-posts
8 years ago
wordpress-post-widget
3 years ago
authors.php
3 years ago
blog-stats.php
2 years ago
class-jetpack-eu-cookie-law-widget.php
3 years ago
class-jetpack-instagram-widget.php
2 years ago
contact-info.php
2 years ago
customizer-controls.css
9 years ago
customizer-utils.js
6 years ago
facebook-likebox.php
3 years ago
flickr.php
3 years ago
gallery.php
3 years ago
goodreads.php
3 years ago
google-translate.php
2 years ago
gravatar-profile.css
10 years ago
gravatar-profile.php
3 years ago
image-widget.php
3 years ago
internet-defense-league.php
3 years ago
mailchimp.php
3 years ago
milestone.php
5 years ago
my-community.php
2 years ago
rsslinks-widget.php
3 years ago
simple-payments.php
2 years ago
social-icons.php
2 years ago
social-media-icons.php
3 years ago
top-posts.php
2 years ago
twitter-timeline-admin.js
6 years ago
twitter-timeline.php
3 years ago
upcoming-events.php
3 years ago
wordpress-post-widget.php
4 years ago
my-community.php
313 lines
| 1 | <?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName |
| 2 | |
| 3 | // phpcs:disable Universal.Files.SeparateFunctionsFromOO.Mixed -- TODO: Move classes to appropriately-named class files. |
| 4 | |
| 5 | use Automattic\Jetpack\Redirect; |
| 6 | |
| 7 | // Disable direct access/execution to/of the widget code. |
| 8 | if ( ! defined( 'ABSPATH' ) ) { |
| 9 | exit; |
| 10 | } |
| 11 | |
| 12 | /** |
| 13 | * Jetpack_My_Community_Widget displays community members of this site. |
| 14 | * |
| 15 | * A community member is a WordPress.com user that liked or commented on an entry or subscribed to the site. |
| 16 | * Requires WordPress.com connection to work. Otherwise it won't be visible in Widgets screen in admin. |
| 17 | */ |
| 18 | class Jetpack_My_Community_Widget extends WP_Widget { |
| 19 | /** |
| 20 | * Transient expiration time. |
| 21 | * |
| 22 | * @var int $expiration |
| 23 | */ |
| 24 | public static $expiration = 600; |
| 25 | |
| 26 | /** |
| 27 | * Default widget title. |
| 28 | * |
| 29 | * @var string $default_title |
| 30 | */ |
| 31 | public $default_title; |
| 32 | |
| 33 | /** |
| 34 | * Registers the widget with WordPress. |
| 35 | */ |
| 36 | public function __construct() { |
| 37 | parent::__construct( |
| 38 | 'jetpack_my_community', // Base ID. |
| 39 | /** This filter is documented in modules/widgets/facebook-likebox.php */ |
| 40 | apply_filters( 'jetpack_widget_name', esc_html__( 'My Community', 'jetpack' ) ), |
| 41 | array( |
| 42 | 'description' => esc_html__( "Display members of your site's community.", 'jetpack' ), |
| 43 | 'customize_selective_refresh' => true, |
| 44 | ) |
| 45 | ); |
| 46 | |
| 47 | if ( is_active_widget( false, false, $this->id_base ) || is_active_widget( false, false, 'monster' ) || is_customize_preview() ) { |
| 48 | add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_style' ) ); |
| 49 | } |
| 50 | |
| 51 | $this->default_title = esc_html__( 'Community', 'jetpack' ); |
| 52 | |
| 53 | add_filter( 'widget_types_to_hide_from_legacy_widget_block', array( $this, 'hide_widget_in_block_editor' ) ); |
| 54 | } |
| 55 | |
| 56 | /** |
| 57 | * Remove the "My Community" widget from the Legacy Widget block |
| 58 | * |
| 59 | * @param array $widget_types List of widgets that are currently removed from the Legacy Widget block. |
| 60 | * @return array $widget_types New list of widgets that will be removed. |
| 61 | */ |
| 62 | public function hide_widget_in_block_editor( $widget_types ) { |
| 63 | $widget_types[] = 'jetpack_my_community'; |
| 64 | return $widget_types; |
| 65 | } |
| 66 | |
| 67 | /** |
| 68 | * Enqueue stylesheet for grid layout. |
| 69 | */ |
| 70 | public function enqueue_style() { |
| 71 | wp_register_style( 'jetpack-my-community-widget', plugins_url( 'my-community/style.css', __FILE__ ), array(), '20160129' ); |
| 72 | wp_enqueue_style( 'jetpack-my-community-widget' ); |
| 73 | } |
| 74 | |
| 75 | /** |
| 76 | * Back end widget form. |
| 77 | * |
| 78 | * @see WP_Widget::form() |
| 79 | * |
| 80 | * @param array $instance Previously saved values from database. |
| 81 | * |
| 82 | * @return string|void |
| 83 | */ |
| 84 | public function form( $instance ) { |
| 85 | $title = isset( $instance['title'] ) ? $instance['title'] : false; |
| 86 | if ( false === $title ) { |
| 87 | $title = $this->default_title; |
| 88 | } |
| 89 | |
| 90 | $number = isset( $instance['number'] ) ? (int) $instance['number'] : 10; |
| 91 | if ( ! in_array( $number, array( 10, 50 ), true ) ) { |
| 92 | $number = 10; |
| 93 | } |
| 94 | |
| 95 | $include_likers = isset( $instance['include_likers'] ) ? (bool) $instance['include_likers'] : true; |
| 96 | $include_followers = isset( $instance['include_followers'] ) ? (bool) $instance['include_followers'] : true; |
| 97 | $include_commenters = isset( $instance['include_commenters'] ) ? (bool) $instance['include_commenters'] : true; |
| 98 | ?> |
| 99 | |
| 100 | <p> |
| 101 | <label for="<?php echo esc_attr( $this->get_field_id( 'title' ) ); ?>"><?php esc_html_e( 'Title:', 'jetpack' ); ?></label> |
| 102 | <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( $title ); ?>" /> |
| 103 | </p> |
| 104 | |
| 105 | <p> |
| 106 | <label><?php esc_html_e( 'Show a maximum of', 'jetpack' ); ?></label> |
| 107 | </p> |
| 108 | <ul> |
| 109 | <li><label><input id="<?php echo esc_attr( $this->get_field_id( 'number' ) ); ?>-few" name="<?php echo esc_attr( $this->get_field_name( 'number' ) ); ?>" type="radio" value="10" <?php checked( '10', $number ); ?> /> <?php esc_html_e( '10 community members', 'jetpack' ); ?></label></li> |
| 110 | <li><label><input id="<?php echo esc_attr( $this->get_field_id( 'number' ) ); ?>-lots" name="<?php echo esc_attr( $this->get_field_name( 'number' ) ); ?>" type="radio" value="50" <?php checked( '50', $number ); ?> /> <?php esc_html_e( '50 community members', 'jetpack' ); ?></label></li> |
| 111 | </ul> |
| 112 | |
| 113 | <p> |
| 114 | <label for="<?php echo esc_attr( $this->get_field_id( 'include_likers' ) ); ?>"> |
| 115 | <input type="checkbox" class="checkbox" id="<?php echo esc_attr( $this->get_field_id( 'include_likers' ) ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'include_likers' ) ); ?>" value="1" <?php checked( $include_likers, 1 ); ?> /> |
| 116 | <?php esc_html_e( 'Include activity from likers', 'jetpack' ); ?> |
| 117 | </label> |
| 118 | </p> |
| 119 | |
| 120 | <p> |
| 121 | <label for="<?php echo esc_attr( $this->get_field_id( 'include_followers' ) ); ?>"> |
| 122 | <input type="checkbox" class="checkbox" id="<?php echo esc_attr( $this->get_field_id( 'include_followers' ) ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'include_followers' ) ); ?>" value="1" <?php checked( $include_followers, 1 ); ?> /> |
| 123 | <?php esc_html_e( 'Include activity from followers', 'jetpack' ); ?> |
| 124 | </label> |
| 125 | </p> |
| 126 | |
| 127 | <p> |
| 128 | <label for="<?php echo esc_attr( $this->get_field_id( 'include_commenters' ) ); ?>"> |
| 129 | <input type="checkbox" class="checkbox" id="<?php echo esc_attr( $this->get_field_id( 'include_commenters' ) ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'include_commenters' ) ); ?>" value="1" <?php checked( $include_commenters, 1 ); ?> /> |
| 130 | <?php esc_html_e( 'Include activity from commenters', 'jetpack' ); ?> |
| 131 | </label> |
| 132 | </p> |
| 133 | |
| 134 | <?php |
| 135 | } |
| 136 | |
| 137 | /** |
| 138 | * Sanitize widget form values as they are saved. |
| 139 | * |
| 140 | * @see WP_Widget::update() |
| 141 | * |
| 142 | * @param array $new_instance Values just sent to be saved. |
| 143 | * @param array $old_instance Previously saved values from database. |
| 144 | * |
| 145 | * @return array Updated safe values to be saved. |
| 146 | */ |
| 147 | public function update( $new_instance, $old_instance ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable |
| 148 | $instance = array(); |
| 149 | $instance['title'] = wp_kses( $new_instance['title'], array() ); |
| 150 | if ( $instance['title'] === $this->default_title ) { |
| 151 | $instance['title'] = false; // Store as false in case of language change. |
| 152 | } |
| 153 | |
| 154 | $instance['number'] = (int) $new_instance['number']; |
| 155 | if ( ! in_array( $instance['number'], array( 10, 50 ), true ) ) { |
| 156 | $instance['number'] = 10; |
| 157 | } |
| 158 | |
| 159 | $instance['include_likers'] = (bool) $new_instance['include_likers']; |
| 160 | $instance['include_followers'] = (bool) $new_instance['include_followers']; |
| 161 | $instance['include_commenters'] = (bool) $new_instance['include_commenters']; |
| 162 | |
| 163 | delete_transient( "$this->id-v2-{$instance['number']}" . (int) $instance['include_likers'] . (int) $instance['include_followers'] . (int) $instance['include_commenters'] ); |
| 164 | |
| 165 | return $instance; |
| 166 | } |
| 167 | |
| 168 | /** |
| 169 | * Front-end display of widget. |
| 170 | * |
| 171 | * @see WP_Widget::widget() |
| 172 | * |
| 173 | * @param array $args Widget arguments. |
| 174 | * @param array $instance Saved values from database. |
| 175 | */ |
| 176 | public function widget( $args, $instance ) { |
| 177 | $instance = wp_parse_args( |
| 178 | $instance, |
| 179 | array( |
| 180 | 'title' => false, |
| 181 | 'number' => true, |
| 182 | 'include_likers' => true, |
| 183 | 'include_followers' => true, |
| 184 | 'include_commenters' => true, |
| 185 | ) |
| 186 | ); |
| 187 | |
| 188 | $title = $instance['title']; |
| 189 | |
| 190 | if ( false === $title ) { |
| 191 | $title = $this->default_title; |
| 192 | } |
| 193 | |
| 194 | echo $args['before_widget']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped |
| 195 | |
| 196 | /** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */ |
| 197 | $title = apply_filters( 'widget_title', $title ); |
| 198 | if ( ! empty( $title ) ) { |
| 199 | echo $args['before_title'] . $title . $args['after_title']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped |
| 200 | } |
| 201 | |
| 202 | $transient_name = "$this->id-v2-{$instance['number']}" . (int) $instance['include_likers'] . (int) $instance['include_followers'] . (int) $instance['include_commenters']; |
| 203 | |
| 204 | $my_community = get_transient( $transient_name ); |
| 205 | |
| 206 | if ( empty( $my_community ) ) { |
| 207 | $my_community = $this->get_community( $instance ); |
| 208 | |
| 209 | set_transient( $transient_name, $my_community, self::$expiration ); |
| 210 | } |
| 211 | |
| 212 | echo $my_community; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped |
| 213 | |
| 214 | echo $args['after_widget']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped |
| 215 | |
| 216 | /** This action is documented in modules/widgets/gravatar-profile.php */ |
| 217 | do_action( 'jetpack_stats_extra', 'widget_view', 'my_community' ); |
| 218 | } |
| 219 | |
| 220 | /** |
| 221 | * Initiate request and render the response. |
| 222 | * |
| 223 | * @since 4.0 |
| 224 | * |
| 225 | * @param array $query Saved widget values from database. |
| 226 | * |
| 227 | * @return string |
| 228 | */ |
| 229 | private function get_community( $query ) { |
| 230 | $members = $this->fetch_remote_community( $query ); |
| 231 | |
| 232 | if ( ! empty( $members ) ) { |
| 233 | |
| 234 | $my_community = '<div class="widgets-multi-column-grid"><ul>'; |
| 235 | |
| 236 | foreach ( $members as $member ) { |
| 237 | $my_community .= sprintf( |
| 238 | '<li><a href="%s" title="%s"><img alt="%s" src="%s" class="avatar avatar-48" height="48" width="48"></a></li>', |
| 239 | esc_url( $member->profile_URL ), // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase |
| 240 | esc_attr( $member->name ), |
| 241 | esc_attr( $member->name ), |
| 242 | esc_url( $member->avatar_URL ) // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase |
| 243 | ); |
| 244 | } |
| 245 | |
| 246 | $my_community .= '</ul></div>'; |
| 247 | |
| 248 | } elseif ( current_user_can( 'edit_theme_options' ) ) { |
| 249 | $my_community = '<p>' . wp_kses( |
| 250 | sprintf( |
| 251 | /* Translators: 1. link to the widgets settings screen. 2. link to support document. */ |
| 252 | __( 'There are no users to display in this <a href="%1$s">My Community widget</a>. <a href="%2$s">Want more traffic?</a>', 'jetpack' ), |
| 253 | admin_url( 'widgets.php' ), |
| 254 | esc_url( Redirect::get_url( 'jetpack-support-getting-more-views-and-traffic' ) ) |
| 255 | ), |
| 256 | array( 'a' => array( 'href' => true ) ) |
| 257 | ) . '</p>'; |
| 258 | } else { |
| 259 | $my_community = '<p>' . esc_html__( "I'm just starting out; leave me a comment or a like :)", 'jetpack' ) . '</p>'; |
| 260 | } |
| 261 | |
| 262 | return $my_community; |
| 263 | } |
| 264 | |
| 265 | /** |
| 266 | * Request community members to WordPress.com endpoint. |
| 267 | * |
| 268 | * @since 4.0 |
| 269 | * |
| 270 | * @param array $query Saved widget values from database. |
| 271 | * |
| 272 | * @return array |
| 273 | */ |
| 274 | private function fetch_remote_community( $query ) { |
| 275 | $jetpack_blog_id = Jetpack_Options::get_option( 'id' ); |
| 276 | $url = add_query_arg( |
| 277 | array( |
| 278 | 'number' => $query['number'], |
| 279 | 'likers' => (int) $query['include_likers'], |
| 280 | 'followers' => (int) $query['include_followers'], |
| 281 | 'commenters' => (int) $query['include_commenters'], |
| 282 | ), |
| 283 | "https://public-api.wordpress.com/rest/v1.1/sites/$jetpack_blog_id/community" |
| 284 | ); |
| 285 | $response = wp_remote_get( $url ); |
| 286 | $response_body = wp_remote_retrieve_body( $response ); |
| 287 | |
| 288 | if ( empty( $response_body ) ) { |
| 289 | return array(); |
| 290 | } |
| 291 | |
| 292 | $response_body = json_decode( $response_body ); |
| 293 | |
| 294 | if ( isset( $response_body->users ) ) { |
| 295 | return $response_body->users; |
| 296 | } |
| 297 | |
| 298 | return array(); |
| 299 | } |
| 300 | } |
| 301 | |
| 302 | /** |
| 303 | * If site is connected to WordPress.com, register the widget. |
| 304 | * |
| 305 | * @since 4.0 |
| 306 | */ |
| 307 | function jetpack_my_community_init() { |
| 308 | if ( Jetpack::is_connection_ready() ) { |
| 309 | register_widget( 'Jetpack_My_Community_Widget' ); |
| 310 | } |
| 311 | } |
| 312 | add_action( 'widgets_init', 'jetpack_my_community_init' ); |
| 313 |