<!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][9462] trunk/src/bp-groups: Add PHPDoc to some functions in `bp-groups-template.php`.</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/9462">9462</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/9462","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-02-09 21:12:01 +0000 (Mon, 09 Feb 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'>Add PHPDoc to some functions in `bp-groups-template.php`. Also clean-up `bp_group_status_message()` and check `$group->status` before comparing.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpgroupsbpgroupsfiltersphp">trunk/src/bp-groups/bp-groups-filters.php</a></li>
<li><a href="#trunksrcbpgroupsbpgroupstemplatephp">trunk/src/bp-groups/bp-groups-template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpgroupsbpgroupsfiltersphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-groups/bp-groups-filters.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-groups/bp-groups-filters.php 2015-02-09 20:54:26 UTC (rev 9461)
+++ trunk/src/bp-groups/bp-groups-filters.php 2015-02-09 21:12:01 UTC (rev 9462)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -61,9 +61,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'bp_get_new_group_description', 'esc_textarea' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Format numberical output
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-add_filter( 'bp_get_total_group_count', 'bp_core_number_format' );
-add_filter( 'bp_get_group_total_for_member', 'bp_core_number_format' );
-add_filter( 'bp_get_group_total_members', 'bp_core_number_format' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+add_filter( 'bp_get_total_group_count', 'bp_core_number_format' );
+add_filter( 'bp_get_group_total_for_member', 'bp_core_number_format' );
+add_filter( 'bp_get_group_total_members', 'bp_core_number_format' );
+add_filter( 'bp_get_total_group_count_for_user', 'bp_core_number_format' );
</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"> * Filter output of Group Description through WordPress's KSES API.
</span></span></pre></div>
<a id="trunksrcbpgroupsbpgroupstemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-groups/bp-groups-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-groups/bp-groups-template.php 2015-02-09 20:54:26 UTC (rev 9461)
+++ trunk/src/bp-groups/bp-groups-template.php 2015-02-09 21:12:01 UTC (rev 9462)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2956,37 +2956,60 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Prints a message if the group is not visible to the current user (it is a
</span><span class="cx" style="display: block; padding: 0 10px"> * hidden or private group, and the user does not have access).
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since BuddyPress (1.0.0)
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @global BP_Groups_Template $groups_template Groups template object
</span><span class="cx" style="display: block; padding: 0 10px"> * @param object $group Group to get status message for. Optional; defaults to current group.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since BuddyPress (1.0.0)
</del><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_group_status_message( $group = null ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $groups_template;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! $group )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Group not passed so look for loop
+ if ( empty( $group ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $group =& $groups_template->group;
</span><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">- if ( 'private' == $group->status ) {
- if ( ! bp_group_has_requested_membership() ) {
- if ( is_user_logged_in() && bp_group_is_invited() ) {
- $message = __( 'You must accept your pending invitation before you can access this private group.', 'buddypress' );
- } elseif ( is_user_logged_in() ) {
- $message = __( 'This is a private group and you must request group membership in order to join.', 'buddypress' );
- } else {
- $message = __( 'This is a private group. To join you must be a registered site member and request group membership.', 'buddypress' );
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Group status is not set (maybe outside of group loop?)
+ if ( empty( $group->status ) ) {
+ $message = __( 'This group is not currently accessible.', 'buddypress' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- } else {
- $message = __( 'This is a private group. Your membership request is awaiting approval from the group administrator.', 'buddypress' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Group has a status
+ } else {
+ switch( $group->status ) {
+
+ // Private group
+ case 'private' :
+ if ( ! bp_group_has_requested_membership() ) {
+ if ( is_user_logged_in() ) {
+ if ( bp_group_is_invited() ) {
+ $message = __( 'You must accept your pending invitation before you can access this private group.', 'buddypress' );
+ } else {
+ $message = __( 'This is a private group and you must request group membership in order to join.', 'buddypress' );
+ }
+ } else {
+ $message = __( 'This is a private group. To join you must be a registered site member and request group membership.', 'buddypress' );
+ }
+ } else {
+ $message = __( 'This is a private group. Your membership request is awaiting approval from the group administrator.', 'buddypress' );
+ }
+
+ // Hidden group
+ case 'hidden' :
+ default :
+ $message = __( 'This is a hidden group and only invited members can join.', 'buddypress' );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- } else {
- $message = __( 'This is a hidden group and only invited members can join.', 'buddypress' );
</del><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"> echo apply_filters( 'bp_group_status_message', $message, $group );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * Output hidden form fields for group.
+ *
+ * This function is no longer used, but may still be used by older themes.
+ *
+ * @since BuddyPress (1.0.0)
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> function bp_group_hidden_fields() {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $_REQUEST['s'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> echo '<input type="hidden" id="search_terms" value="' . esc_attr( $_REQUEST['s'] ) . '" name="search_terms" />';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3001,26 +3024,51 @@
</span><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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * Output the total number of groups
+ *
+ * @since BuddyPress (1.0.0)
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> function bp_total_group_count() {
</span><span class="cx" style="display: block; padding: 0 10px"> echo bp_get_total_group_count();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Return the total number of groups
+ *
+ * @since BuddyPress (1.0.0)
+ * @return type
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> function bp_get_total_group_count() {
</span><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_get_total_group_count', groups_get_total_group_count() );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * Output the total number of groups a user belongs to
+ *
+ * @since BuddyPress (1.0.0)
+ *
+ * @param int $user_id User ID to get group membership count
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> function bp_total_group_count_for_user( $user_id = 0 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> echo bp_get_total_group_count_for_user( $user_id );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Return the total number of groups a user belongs to
+ *
+ * Filtered by `bp_core_number_format()` by default
+ *
+ * @since BuddyPress (1.0.0)
+ *
+ * @param int $user_id User ID to get group membership count
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> function bp_get_total_group_count_for_user( $user_id = 0 ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return apply_filters( 'bp_get_total_group_count_for_user', groups_total_groups_for_user( $user_id ), $user_id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $count = groups_total_groups_for_user( $user_id );
+
+ return apply_filters( 'bp_get_total_group_count_for_user', $count, $user_id );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- add_filter( 'bp_get_total_group_count_for_user', 'bp_core_number_format' );
</del><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/** Group 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">-/***************************************************************************
- * Group Members Template Tags
- **/
-
</del><span class="cx" style="display: block; padding: 0 10px"> class BP_Groups_Group_Members_Template {
</span><span class="cx" style="display: block; padding: 0 10px"> var $current_member = -1;
</span><span class="cx" style="display: block; padding: 0 10px"> var $member_count;
</span></span></pre>
</div>
</div>
</body>
</html>