| 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( 0 ); |
| 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 |
$this->default_title = esc_html__( 'Community', 'jetpack' ); |
| 48 |
|
| 49 |
add_filter( 'widget_types_to_hide_from_legacy_widget_block', array( $this, 'hide_widget_in_block_editor' ) ); |
| 50 |
} |
| 51 |
|
| 52 |
/** |
| 53 |
* Remove the "My Community" widget from the Legacy Widget block |
| 54 |
* |
| 55 |
* @param array $widget_types List of widgets that are currently removed from the Legacy Widget block. |
| 56 |
* @return array $widget_types New list of widgets that will be removed. |
| 57 |
*/ |
| 58 |
public function hide_widget_in_block_editor( $widget_types ) { |
| 59 |
$widget_types[] = 'jetpack_my_community'; |
| 60 |
return $widget_types; |
| 61 |
} |
| 62 |
|
| 63 |
/** |
| 64 |
* Enqueue stylesheet for grid layout. |
| 65 |
*/ |
| 66 |
public function enqueue_style() { |
| 67 |
wp_register_style( 'jetpack-my-community-widget', plugins_url( 'my-community/style.css', __FILE__ ), array(), '20160129' ); |
| 68 |
wp_enqueue_style( 'jetpack-my-community-widget' ); |
| 69 |
} |
| 70 |
|
| 71 |
/** |
| 72 |
* Back end widget form. |
| 73 |
* |
| 74 |
* @see WP_Widget::form() |
| 75 |
* |
| 76 |
* @param array $instance Previously saved values from database. |
| 77 |
* |
| 78 |
* @return string|void |
| 79 |
*/ |
| 80 |
public function form( $instance ) { |
| 81 |
$title = $instance['title'] ?? false; |
| 82 |
if ( false === $title ) { |
| 83 |
$title = $this->default_title; |
| 84 |
} |
| 85 |
|
| 86 |
$number = isset( $instance['number'] ) ? (int) $instance['number'] : 10; |
| 87 |
if ( ! in_array( $number, array( 10, 50 ), true ) ) { |
| 88 |
$number = 10; |
| 89 |
} |
| 90 |
|
| 91 |
$include_likers = isset( $instance['include_likers'] ) ? (bool) $instance['include_likers'] : true; |
| 92 |
$include_followers = isset( $instance['include_followers'] ) ? (bool) $instance['include_followers'] : true; |
| 93 |
$include_commenters = isset( $instance['include_commenters'] ) ? (bool) $instance['include_commenters'] : true; |
| 94 |
?> |
| 95 |
|
| 96 |
<p> |
| 97 |
<label for="<?php echo esc_attr( $this->get_field_id( 'title' ) ); ?>"><?php esc_html_e( 'Title:', 'jetpack' ); ?></label> |
| 98 |
<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 ); ?>" /> |
| 99 |
</p> |
| 100 |
|
| 101 |
<p> |
| 102 |
<label><?php esc_html_e( 'Show a maximum of', 'jetpack' ); ?></label> |
| 103 |
</p> |
| 104 |
<ul> |
| 105 |
<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> |
| 106 |
<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> |
| 107 |
</ul> |
| 108 |
|
| 109 |
<p> |
| 110 |
<label for="<?php echo esc_attr( $this->get_field_id( 'include_likers' ) ); ?>"> |
| 111 |
<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 ); ?> /> |
| 112 |
<?php esc_html_e( 'Include activity from likers', 'jetpack' ); ?> |
| 113 |
</label> |
| 114 |
</p> |
| 115 |
|
| 116 |
<p> |
| 117 |
<label for="<?php echo esc_attr( $this->get_field_id( 'include_followers' ) ); ?>"> |
| 118 |
<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 ); ?> /> |
| 119 |
<?php esc_html_e( 'Include activity from followers', 'jetpack' ); ?> |
| 120 |
</label> |
| 121 |
</p> |
| 122 |
|
| 123 |
<p> |
| 124 |
<label for="<?php echo esc_attr( $this->get_field_id( 'include_commenters' ) ); ?>"> |
| 125 |
<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 ); ?> /> |
| 126 |
<?php esc_html_e( 'Include activity from commenters', 'jetpack' ); ?> |
| 127 |
</label> |
| 128 |
</p> |
| 129 |
|
| 130 |
<?php |
| 131 |
} |
| 132 |
|
| 133 |
/** |
| 134 |
* Sanitize widget form values as they are saved. |
| 135 |
* |
| 136 |
* @see WP_Widget::update() |
| 137 |
* |
| 138 |
* @param array $new_instance Values just sent to be saved. |
| 139 |
* @param array $old_instance Previously saved values from database. |
| 140 |
* |
| 141 |
* @return array Updated safe values to be saved. |
| 142 |
*/ |
| 143 |
public function update( $new_instance, $old_instance ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable |
| 144 |
$instance = array(); |
| 145 |
$instance['title'] = wp_kses( $new_instance['title'], array() ); |
| 146 |
if ( $instance['title'] === $this->default_title ) { |
| 147 |
$instance['title'] = false; // Store as false in case of language change. |
| 148 |
} |
| 149 |
|
| 150 |
$instance['number'] = (int) $new_instance['number']; |
| 151 |
if ( ! in_array( $instance['number'], array( 10, 50 ), true ) ) { |
| 152 |
$instance['number'] = 10; |
| 153 |
} |
| 154 |
|
| 155 |
$instance['include_likers'] = (bool) $new_instance['include_likers']; |
| 156 |
$instance['include_followers'] = (bool) $new_instance['include_followers']; |
| 157 |
$instance['include_commenters'] = (bool) $new_instance['include_commenters']; |
| 158 |
|
| 159 |
delete_transient( "$this->id-v2-{$instance['number']}" . (int) $instance['include_likers'] . (int) $instance['include_followers'] . (int) $instance['include_commenters'] ); |
| 160 |
|
| 161 |
return $instance; |
| 162 |
} |
| 163 |
|
| 164 |
/** |
| 165 |
* Front-end display of widget. |
| 166 |
* |
| 167 |
* @see WP_Widget::widget() |
| 168 |
* |
| 169 |
* @param array $args Widget arguments. |
| 170 |
* @param array $instance Saved values from database. |
| 171 |
*/ |
| 172 |
public function widget( $args, $instance ) { |
| 173 |
$instance = wp_parse_args( |
| 174 |
$instance, |
| 175 |
array( |
| 176 |
'title' => false, |
| 177 |
'number' => true, |
| 178 |
'include_likers' => true, |
| 179 |
'include_followers' => true, |
| 180 |
'include_commenters' => true, |
| 181 |
) |
| 182 |
); |
| 183 |
|
| 184 |
$title = $instance['title']; |
| 185 |
|
| 186 |
if ( false === $title ) { |
| 187 |
$title = $this->default_title; |
| 188 |
} |
| 189 |
|
| 190 |
// Enqueue front end assets. |
| 191 |
$this->enqueue_style(); |
| 192 |
|
| 193 |
echo $args['before_widget']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped |
| 194 |
|
| 195 |
/** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */ |
| 196 |
$title = apply_filters( 'widget_title', $title ); |
| 197 |
if ( ! empty( $title ) ) { |
| 198 |
echo $args['before_title'] . $title . $args['after_title']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped |
| 199 |
} |
| 200 |
|
| 201 |
$transient_name = "$this->id-v2-{$instance['number']}" . (int) $instance['include_likers'] . (int) $instance['include_followers'] . (int) $instance['include_commenters']; |
| 202 |
|
| 203 |
$my_community = get_transient( $transient_name ); |
| 204 |
|
| 205 |
if ( empty( $my_community ) ) { |
| 206 |
$my_community = $this->get_community( $instance ); |
| 207 |
|
| 208 |
set_transient( $transient_name, $my_community, self::$expiration ); |
| 209 |
} |
| 210 |
|
| 211 |
echo $my_community; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped |
| 212 |
|
| 213 |
echo $args['after_widget']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped |
| 214 |
|
| 215 |
/** This action is documented in modules/widgets/gravatar-profile.php */ |
| 216 |
do_action( 'jetpack_stats_extra', 'widget_view', 'my_community' ); |
| 217 |
} |
| 218 |
|
| 219 |
/** |
| 220 |
* Initiate request and render the response. |
| 221 |
* |
| 222 |
* @since 4.0 |
| 223 |
* |
| 224 |
* @param array $query Saved widget values from database. |
| 225 |
* |
| 226 |
* @return string |
| 227 |
*/ |
| 228 |
private function get_community( $query ) { |
| 229 |
$members = $this->fetch_remote_community( $query ); |
| 230 |
|
| 231 |
if ( ! empty( $members ) ) { |
| 232 |
|
| 233 |
$my_community = '<div class="widgets-multi-column-grid"><ul>'; |
| 234 |
|
| 235 |
foreach ( $members as $member ) { |
| 236 |
$my_community .= sprintf( |
| 237 |
'<li><a href="%s" title="%s"><img alt="%s" src="%s" class="avatar avatar-48" height="48" width="48"></a></li>', |
| 238 |
esc_url( $member->profile_URL ), // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase |
| 239 |
esc_attr( $member->name ), |
| 240 |
esc_attr( $member->name ), |
| 241 |
esc_url( $member->avatar_URL ) // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase |
| 242 |
); |
| 243 |
} |
| 244 |
|
| 245 |
$my_community .= '</ul></div>'; |
| 246 |
|
| 247 |
} elseif ( current_user_can( 'edit_theme_options' ) ) { |
| 248 |
$my_community = '<p>' . wp_kses( |
| 249 |
sprintf( |
| 250 |
/* Translators: 1. link to the widgets settings screen. 2. link to support document. */ |
| 251 |
__( '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' ), |
| 252 |
admin_url( 'widgets.php' ), |
| 253 |
esc_url( Redirect::get_url( 'jetpack-support-getting-more-views-and-traffic' ) ) |
| 254 |
), |
| 255 |
array( 'a' => array( 'href' => true ) ) |
| 256 |
) . '</p>'; |
| 257 |
} else { |
| 258 |
$my_community = '<p>' . esc_html__( "I'm just starting out; leave me a comment or a like :)", 'jetpack' ) . '</p>'; |
| 259 |
} |
| 260 |
|
| 261 |
return $my_community; |
| 262 |
} |
| 263 |
|
| 264 |
/** |
| 265 |
* Request community members to WordPress.com endpoint. |
| 266 |
* |
| 267 |
* @since 4.0 |
| 268 |
* |
| 269 |
* @param array $query Saved widget values from database. |
| 270 |
* |
| 271 |
* @return array |
| 272 |
*/ |
| 273 |
private function fetch_remote_community( $query ) { |
| 274 |
$jetpack_blog_id = Jetpack_Options::get_option( 'id' ); |
| 275 |
$url = add_query_arg( |
| 276 |
array( |
| 277 |
'number' => $query['number'], |
| 278 |
'likers' => (int) $query['include_likers'], |
| 279 |
'followers' => (int) $query['include_followers'], |
| 280 |
'commenters' => (int) $query['include_commenters'], |
| 281 |
), |
| 282 |
"https://public-api.wordpress.com/rest/v1.1/sites/$jetpack_blog_id/community" |
| 283 |
); |
| 284 |
$response = wp_remote_get( $url ); |
| 285 |
$response_body = wp_remote_retrieve_body( $response ); |
| 286 |
|
| 287 |
if ( empty( $response_body ) ) { |
| 288 |
return array(); |
| 289 |
} |
| 290 |
|
| 291 |
$response_body = json_decode( $response_body ); |
| 292 |
|
| 293 |
if ( isset( $response_body->users ) ) { |
| 294 |
return $response_body->users; |
| 295 |
} |
| 296 |
|
| 297 |
return array(); |
| 298 |
} |
| 299 |
} |
| 300 |
|
| 301 |
/** |
| 302 |
* If site is connected to WordPress.com, register the widget. |
| 303 |
* |
| 304 |
* @since 4.0 |
| 305 |
*/ |
| 306 |
function jetpack_my_community_init() { |
| 307 |
if ( Jetpack::is_connection_ready() ) { |
| 308 |
register_widget( 'Jetpack_My_Community_Widget' ); |
| 309 |
} |
| 310 |
} |
| 311 |
add_action( 'widgets_init', 'jetpack_my_community_init' ); |
| 312 |
|
