<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[BuddyPress][9725] trunk/src/bp-members/bp-members-widgets.php: Members: Improvements to `BP_Core_Whos_Online_Widget`</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://buddypress.trac.wordpress.org/changeset/9725">9725</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/9725","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>johnjamesjacoby</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-04-09 19:15:42 +0000 (Thu, 09 Apr 2015)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Members: Improvements to `BP_Core_Whos_Online_Widget`
* Escape gettext output
* Add missing semicolons after PHP execution
* Introduce `parse_settings()` method for setting smart default values
* Remove `extract()` usages
* Code formatting improvements
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/6362">#6362</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpmembersbpmemberswidgetsphp">trunk/src/bp-members/bp-members-widgets.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpmembersbpmemberswidgetsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-members/bp-members-widgets.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-members/bp-members-widgets.php 2015-04-09 19:04:18 UTC (rev 9724)
+++ trunk/src/bp-members/bp-members-widgets.php 2015-04-09 19:15:42 UTC (rev 9725)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -63,9 +63,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Get widget settings
</span><span class="cx" style="display: block; padding: 0 10px"> $settings = $this->parse_settings( $instance );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Output any content before the widget
- echo $args['before_widget'];
-
</del><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the title of the Members widget.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -79,8 +76,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $title = apply_filters( 'widget_title', $settings['title'], $settings, $this->id_base );
</span><span class="cx" style="display: block; padding: 0 10px"> $title = $settings['link_title'] ? '<a href="' . bp_get_members_directory_permalink() . '">' . $title . '</a>' : $title;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Output title (and maybe content before & after it)
- echo $args['before_title']
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Output before widget HTMl, title (and maybe content before & after it)
+ echo $args['before_widget']
+ . $args['before_title']
</ins><span class="cx" style="display: block; padding: 0 10px"> . $title
</span><span class="cx" style="display: block; padding: 0 10px"> . $args['after_title'];
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -245,12 +243,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Constructor method.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- function __construct() {
- $widget_ops = array(
- 'description' => __( 'Profile photos of online users', 'buddypress' ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function __construct() {
+ $name = _x( "(BuddyPress) Who's Online", 'widget name', 'buddypress' );
+ $description = __( 'Profile photos of online users', 'buddypress' );
+ parent::__construct( false, $name, array(
+ 'description' => $description,
</ins><span class="cx" style="display: block; padding: 0 10px"> 'classname' => 'widget_bp_core_whos_online_widget buddypress widget',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- );
- parent::__construct( false, $name = _x( "(BuddyPress) Who's Online", 'widget name', 'buddypress' ), $widget_ops );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -261,9 +260,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args Widget arguments.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $instance Widget settings, as saved by the user.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- function widget($args, $instance) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function widget( $args, $instance ) {
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- extract( $args );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Get widget settings
+ $settings = $this->parse_settings( $instance );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the title of the Who's Online widget.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -272,45 +272,49 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since BuddyPress (2.3.0) Added 'instance' and 'id_base' to arguments passed to filter.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $title The widget title.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $instance The settings for the particular instance of the widget.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $settings The settings for the particular instance of the widget.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $id_base Root ID for all widgets of this type.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $title = apply_filters( 'widget_title', $instance['title'], $instance, $this->id_base );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $title = apply_filters( 'widget_title', $settings['title'], $settings, $this->id_base );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- echo $before_widget;
- echo $before_title
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ echo $args['before_widget']
+ . $args['before_title']
</ins><span class="cx" style="display: block; padding: 0 10px"> . $title
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- . $after_title;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ . $args['after_title'];
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Setup args for querying members
</ins><span class="cx" style="display: block; padding: 0 10px"> $members_args = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'user_id' => 0,
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'online',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'per_page' => $instance['max_members'],
- 'max' => $instance['max_members'],
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'per_page' => $settings['max_members'],
+ 'max' => $settings['max_members'],
</ins><span class="cx" style="display: block; padding: 0 10px"> 'populate_extras' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> 'search_terms' => false,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ ); ?>
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- ?>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <?php if ( bp_has_members( $members_args ) ) : ?>
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <?php if ( bp_has_members( $members_args ) ) : ?>
</del><span class="cx" style="display: block; padding: 0 10px"> <div class="avatar-block">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> <?php while ( bp_members() ) : bp_the_member(); ?>
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> <div class="item-avatar">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <a href="<?php bp_member_permalink() ?>" title="<?php bp_member_name() ?>"><?php bp_member_avatar() ?></a>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <a href="<?php bp_member_permalink(); ?>" title="<?php bp_member_name(); ?>"><?php bp_member_avatar(); ?></a>
</ins><span class="cx" style="display: block; padding: 0 10px"> </div>
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> <?php endwhile; ?>
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> </div>
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> <?php else: ?>
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> <div class="widget-error">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <?php _e( 'There are no users currently online', 'buddypress' ) ?>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <?php esc_html_e( 'There are no users currently online', 'buddypress' ); ?>
</ins><span class="cx" style="display: block; padding: 0 10px"> </div>
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> <?php endif; ?>
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <?php echo $after_widget; ?>
- <?php
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <?php echo $args['after_widget'];
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -320,9 +324,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $old_instance The old instance options.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array $instance The parsed options to be saved.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- function update( $new_instance, $old_instance ) {
- $instance = $old_instance;
- $instance['title'] = strip_tags( $new_instance['title'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function update( $new_instance, $old_instance ) {
+ $instance = $old_instance;
+ $instance['title'] = strip_tags( $new_instance['title'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> $instance['max_members'] = strip_tags( $new_instance['max_members'] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $instance;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -333,22 +337,44 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param $instance Settings for this widget.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- function form( $instance ) {
- $defaults = array(
- 'title' => __( "Who's Online", 'buddypress' ),
- 'max_members' => 15
- );
- $instance = wp_parse_args( (array) $instance, $defaults );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function form( $instance ) {
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $title = strip_tags( $instance['title'] );
- $max_members = strip_tags( $instance['max_members'] );
- ?>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Get widget settings
+ $settings = $this->parse_settings( $instance );
+ $title = strip_tags( $settings['title'] );
+ $max_members = strip_tags( $settings['max_members'] ); ?>
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <p><label for="bp-core-widget-title"><?php _e('Title:', 'buddypress'); ?> <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 ); ?>" style="width: 100%" /></label></p>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <p>
+ <label for="bp-core-widget-title">
+ <?php esc_html_e( 'Title:', 'buddypress' ); ?>
+ <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 ); ?>" style="width: 100%" />
+ </label>
+ </p>
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <p><label for="bp-core-widget-members-max"><?php _e('Max Members to show:', 'buddypress'); ?> <input class="widefat" id="<?php echo $this->get_field_id( 'max_members' ); ?>" name="<?php echo $this->get_field_name( 'max_members' ); ?>" type="text" value="<?php echo esc_attr( $max_members ); ?>" style="width: 30%" /></label></p>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <p>
+ <label for="bp-core-widget-members-max">
+ <?php esc_html_e( 'Max Members to show:', 'buddypress' ); ?>
+ <input class="widefat" id="<?php echo $this->get_field_id( 'max_members' ); ?>" name="<?php echo $this->get_field_name( 'max_members' ); ?>" type="text" value="<?php echo esc_attr( $max_members ); ?>" style="width: 30%" />
+ </label>
+ </p>
+
</ins><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Merge the widget settings into defaults array.
+ *
+ * @since BuddyPress (2.3.0)
+ *
+ * @param $instance Instance
+ * @uses bp_parse_args() To merge widget settings into defaults
+ */
+ public function parse_settings( $instance = array() ) {
+ return bp_parse_args( $instance, array(
+ 'title' => __( "Who's Online", 'buddypress' ),
+ 'max_members' => 15,
+ ), 'members_widget_settings' );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre>
</div>
</div>
</body>
</html>