diff options
Diffstat (limited to 'plugins/jetpack/modules/widgets/my-community.php')
| -rw-r--r-- | plugins/jetpack/modules/widgets/my-community.php | 290 |
1 files changed, 290 insertions, 0 deletions
diff --git a/plugins/jetpack/modules/widgets/my-community.php b/plugins/jetpack/modules/widgets/my-community.php new file mode 100644 index 00000000..897ed9f3 --- /dev/null +++ b/plugins/jetpack/modules/widgets/my-community.php @@ -0,0 +1,290 @@ +<?php +/** + * Disable direct access/execution to/of the widget code. + */ +if ( ! defined( 'ABSPATH' ) ) { + exit; +} + +/** + * Jetpack_My_Community_Widget displays community members of this site. + * + * A community member is a WordPress.com user that liked or commented on an entry or subscribed to the site. + * Requires WordPress.com connection to work. Otherwise it won't be visible in Widgets screen in admin. + */ +class Jetpack_My_Community_Widget extends WP_Widget { + /** + * Transient expiration time. + * + * @var int $expiration + */ + static $expiration = 600; + + /** + * Default widget title. + * + * @var string $default_title + */ + var $default_title; + + /** + * Registers the widget with WordPress. + */ + function __construct() { + parent::__construct( + 'jetpack_my_community', // Base ID + /** This filter is documented in modules/widgets/facebook-likebox.php */ + apply_filters( 'jetpack_widget_name', esc_html__( 'My Community', 'jetpack' ) ), + array( + 'description' => esc_html__( "Display members of your site's community.", 'jetpack' ), + 'customize_selective_refresh' => true, + ) + ); + + if ( is_active_widget( false, false, $this->id_base ) || is_active_widget( false, false, 'monster' ) || is_customize_preview() ) { + add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_style' ) ); + } + + $this->default_title = esc_html__( 'Community', 'jetpack' ); + } + + /** + * Enqueue stylesheet for grid layout. + */ + function enqueue_style() { + wp_register_style( 'jetpack-my-community-widget', plugins_url( 'my-community/style.css', __FILE__ ), array(), '20160129' ); + wp_enqueue_style( 'jetpack-my-community-widget' ); + } + + /** + * Back-end widget form. + * + * @see WP_Widget::form() + * + * @param array $instance Previously saved values from database. + * + * @return string|void + */ + function form( $instance ) { + $title = isset( $instance['title' ] ) ? $instance['title'] : false; + if ( false === $title ) { + $title = $this->default_title; + } + + $number = isset( $instance['number'] ) ? $instance['number'] : 10; + if ( ! in_array( $number, array( 10, 50 ) ) ) { + $number = 10; + } + + $include_likers = isset( $instance['include_likers'] ) ? (bool) $instance['include_likers'] : true; + $include_followers = isset( $instance['include_followers'] ) ? (bool) $instance['include_followers'] : true; + $include_commenters = isset( $instance['include_commenters'] ) ? (bool) $instance['include_commenters'] : true; + ?> + + <p> + <label for="<?php echo $this->get_field_id( 'title' ); ?>"><?php esc_html_e( 'Title:', 'jetpack' ); ?></label> + <input class="widefat" id="<?php echo $this->get_field_id( 'title' ); ?>" name="<?php echo $this->get_field_name( 'title' ); ?>" type="text" value="<?php echo esc_attr( $title ); ?>" /> + </p> + + <p> + <label><?php esc_html_e( 'Show a maximum of', 'jetpack' ); ?></label> + </p> + <ul> + <li><label><input id="<?php echo $this->get_field_id( 'number' ); ?>-few" name="<?php echo $this->get_field_name( 'number' ); ?>" type="radio" value="10" <?php checked( '10', $number ); ?> /> <?php esc_html_e( '10 community members', 'jetpack' ); ?></label></li> + <li><label><input id="<?php echo $this->get_field_id( 'number' ); ?>-lots" name="<?php echo $this->get_field_name( 'number' ); ?>" type="radio" value="50" <?php checked( '50', $number ); ?> /> <?php esc_html_e( '50 community members', 'jetpack' ); ?></label></li> + </ul> + + <p> + <label for="<?php echo $this->get_field_id( 'include_likers' ); ?>"> + <input type="checkbox" class="checkbox" id="<?php echo $this->get_field_id( 'include_likers' ); ?>" name="<?php echo $this->get_field_name( 'include_likers' ); ?>" value="1" <?php checked( $include_likers, 1 ); ?> /> + <?php esc_html_e( 'Include activity from likers', 'jetpack' ); ?> + </label> + </p> + + <p> + <label for="<?php echo $this->get_field_id( 'include_followers' ); ?>"> + <input type="checkbox" class="checkbox" id="<?php echo $this->get_field_id( 'include_followers' ); ?>" name="<?php echo $this->get_field_name( 'include_followers' ); ?>" value="1" <?php checked( $include_followers, 1 ); ?> /> + <?php esc_html_e( 'Include activity from followers', 'jetpack' ); ?> + </label> + </p> + + <p> + <label for="<?php echo $this->get_field_id( 'include_commenters' ); ?>"> + <input type="checkbox" class="checkbox" id="<?php echo $this->get_field_id( 'include_commenters' ); ?>" name="<?php echo $this->get_field_name( 'include_commenters' ); ?>" value="1" <?php checked( $include_commenters, 1 ); ?> /> + <?php esc_html_e( 'Include activity from commenters', 'jetpack' ); ?> + </label> + </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() ); + if ( $instance['title'] === $this->default_title ) { + $instance['title'] = false; // Store as false in case of language change + } + + $instance['number'] = (int) $new_instance['number']; + if ( !in_array( $instance['number'], array( 10, 50 ) ) ) { + $instance['number'] = 10; + } + + $instance['include_likers'] = (bool) $new_instance['include_likers']; + $instance['include_followers'] = (bool) $new_instance['include_followers']; + $instance['include_commenters'] = (bool) $new_instance['include_commenters']; + + delete_transient( "$this->id-{$instance['number']}" . (int) $instance['include_likers'] . (int) $instance['include_followers'] . (int) $instance['include_commenters'] ); + + 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, array( + 'title' => false, + 'number' => true, + 'include_likers' => true, + 'include_followers' => true, + 'include_commenters' => true, + ) ); + + $title = $instance['title']; + + if ( false === $title ) { + $title = $this->default_title; + } + + /** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */ + $title = apply_filters( 'widget_title', $title ); + + echo $args['before_widget']; + + if ( ! empty( $title ) ) { + echo $args['before_title'] . $title . $args['after_title']; + } + + $transient_name = "$this->id-{$instance['number']}" . (int) $instance['include_likers'] . (int) $instance['include_followers'] . (int) $instance['include_commenters']; + + $my_community = get_transient( $transient_name ); + + if ( empty( $my_community ) ) { + $my_community = $this->get_community( $instance ); + + set_transient( $transient_name, $my_community, self::$expiration ); + } + + echo $my_community; + + echo $args['after_widget']; + + /** This action is documented in modules/widgets/gravatar-profile.php */ + do_action( 'jetpack_stats_extra', 'widget_view', 'my_community' ); + } + + /** + * Initiate request and render the response. + * + * @since 4.0 + * + * @param array $query + * + * @return string + */ + function get_community( $query ) { + $members = $this->fetch_remote_community( $query ); + + if ( ! empty( $members ) ) { + + $my_community = '<div class="widgets-multi-column-grid"><ul>'; + + foreach ( $members as $member ) { + $my_community .= sprintf( '<li><a href="%s" %s><img alt="" src="%s" class="avatar avatar-240" height="48" width="48" originals="240" scale="1" /></a></li>', + $member->profile_URL, + empty( $member->name ) ? '' : 'title="' . $member->name . '"', + $member->avatar_URL + ); + } + + $my_community .= '</ul></div>'; + + } else { + if ( current_user_can( 'edit_theme_options' ) ) { + $my_community = '<p>' . wp_kses( sprintf( __( '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' ), + admin_url( 'widgets.php' ), + 'https://jetpack.com/support/getting-more-views-and-traffic/' + ), array( 'a' => array( 'href' => true ) ) ) . '</p>'; + } else { + $my_community = '<p>' . esc_html__( "I'm just starting out; leave me a comment or a like :)", 'jetpack' ) . '</p>'; + } + } + + return $my_community; + } + + /** + * Request community members to WordPress.com endpoint. + * + * @since 4.0 + * + * @param $query + * + * @return array + */ + function fetch_remote_community( $query ) { + $jetpack_blog_id = Jetpack_Options::get_option( 'id' ); + $url = add_query_arg( + array( + 'number' => $query['number'], + 'likers' => (int) $query['include_likers'], + 'followers' => (int) $query['include_followers'], + 'commenters' => (int) $query['include_commenters'], + ), + "https://public-api.wordpress.com/rest/v1.1/sites/$jetpack_blog_id/community" + ); + $response = wp_remote_get( $url ); + $response_body = wp_remote_retrieve_body( $response ); + + if ( empty( $response_body ) ) { + return array(); + } + + $response_body = json_decode( $response_body ); + + if ( isset( $response_body->users ) ) { + return $response_body->users; + } + + return array(); + } +} + +/** + * If site is connected to WordPress.com, register the widget. + * + * @since 4.0 + */ +function jetpack_my_community_init() { + if ( Jetpack::is_active() ) { + register_widget( 'Jetpack_My_Community_Widget' ); + } +} + +add_action( 'widgets_init', 'jetpack_my_community_init' ); |