<!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][9493] trunk/src/bp-groups/classes/class-bp-groups-group.php: Adds hooks documentation to class-bp-groups-group.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/9493">9493</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/9493","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>tw2113</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-02-17 06:59:02 +0000 (Tue, 17 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'>Adds hooks documentation to class-bp-groups-group.php.
See <a href="http://buddypress.trac.wordpress.org/ticket/5943">#5943</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpgroupsclassesclassbpgroupsgroupphp">trunk/src/bp-groups/classes/class-bp-groups-group.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpgroupsclassesclassbpgroupsgroupphp"></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/classes/class-bp-groups-group.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-groups/classes/class-bp-groups-group.php 2015-02-17 06:54:37 UTC (rev 9492)
+++ trunk/src/bp-groups/classes/class-bp-groups-group.php 2015-02-17 06:59:02 UTC (rev 9493)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -213,7 +213,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Are we getting extra group data?
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $this->args['populate_extras'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Get group admins and mods
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the SQL prepared statement used to fetch group admins and mods.
+ *
+ * @since BuddyPress (1.5.0)
+ *
+ * @param string $value SQL select statement used to fetch admins and mods.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $admin_mods = $wpdb->get_results( apply_filters( 'bp_group_admin_mods_user_join_filter', $wpdb->prepare( "SELECT u.ID as user_id, u.user_login, u.user_email, u.user_nicename, m.is_admin, m.is_mod FROM {$wpdb->users} u, {$bp->groups->table_name_members} m WHERE u.ID = m.user_id AND m.group_id = %d AND ( m.is_admin = 1 OR m.is_mod = 1 )", $this->id ) ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Add admins and moderators to their respective arrays
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -270,6 +276,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->enable_forum = apply_filters( 'groups_group_enable_forum_before_save', $this->enable_forum, $this->id );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->date_created = apply_filters( 'groups_group_date_created_before_save', $this->date_created, $this->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">+ /**
+ * Fires before the current group item gets saved.
+ *
+ * Please use this hook to filter the properties above. Each part will be passed in.
+ *
+ * @since BuddyPress (1.0.0)
+ *
+ * @param BP_Groups_Group Current instance of the group item being saved. Passed by reference.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action_ref_array( 'groups_group_before_save', array( &$this ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Groups need at least a name
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -343,6 +358,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $this->id ) )
</span><span class="cx" style="display: block; padding: 0 10px"> $this->id = $wpdb->insert_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">+ /**
+ * Fires after the current group item has been saved.
+ *
+ * @since BuddyPress (1.0.0)
+ *
+ * @param BP_Groups_Group Current instance of the group item that was saved. Passed by reference.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action_ref_array( 'groups_group_after_save', array( &$this ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> wp_cache_delete( $this->id, 'bp_groups' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -371,6 +393,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Now delete all group member entries
</span><span class="cx" style="display: block; padding: 0 10px"> BP_Groups_Member::delete_all( $this->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">+ /**
+ * Fires before the deletion of a group.
+ *
+ * @since BuddyPress (1.2.0)
+ *
+ * @param BP_Groups_Group $this Current instance of the group item being deleted. Passed by reference.
+ * @param array $user_ids Array of user IDs that were members of the group.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action_ref_array( 'bp_groups_delete_group', array( &$this, $user_ids ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> wp_cache_delete( $this->id, 'bp_groups' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -768,6 +798,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // If a 'type' parameter was passed, parse it and overwrite
</span><span class="cx" style="display: block; padding: 0 10px"> // 'order' and 'orderby' params passed to the function
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $r['type'] ) ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters the 'type' parameter used to overwrite 'order' and 'orderby' values.
+ *
+ * @since BuddyPress (2.1.0)
+ *
+ * @param array $value Converted 'type' value for order and orderby.
+ * @param string $value Parsed 'type' value for the get method.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $order_orderby = apply_filters( 'bp_groups_get_orderby', self::convert_type_to_order_orderby( $r['type'] ), $r['type'] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // If an invalid type is passed, $order_orderby will be
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -785,7 +824,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Sanitize 'order'
</span><span class="cx" style="display: block; padding: 0 10px"> $order = bp_esc_sql_order( $order );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Convert 'orderby' into the proper ORDER BY term
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the converted 'orderby' term.
+ *
+ * @since BuddyPress (2.1.0)
+ *
+ * @param string $value Converted 'orderby' term.
+ * @param string $orderby Original orderby value.
+ * @param string $value Parsed 'type' value for the get method.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $orderby = apply_filters( 'bp_groups_get_orderby_converted_by_term', self::convert_orderby_to_order_by_term( $orderby ), $orderby, $r['type'] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Random order is a special case
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -799,7 +846,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $sql['pagination'] = $wpdb->prepare( "LIMIT %d, %d", intval( ( $r['page'] - 1 ) * $r['per_page']), intval( $r['per_page'] ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Get paginated results
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the pagination SQL statement.
+ *
+ * @since BuddyPress (1.5.0)
+ *
+ * @param string $value Concatenated SQL statement.
+ * @param array $sql Array of SQL parts before concatenation.
+ * @param array $r Array of parsed arguments for the get method.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $paged_groups_sql = apply_filters( 'bp_groups_get_paged_groups_sql', join( ' ', (array) $sql ), $sql, $r );
</span><span class="cx" style="display: block; padding: 0 10px"> $paged_groups = $wpdb->get_results( $paged_groups_sql );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -851,7 +906,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $t_sql .= " WHERE " . join( ' AND ', (array) $total_sql['where'] );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Get total group results
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the SQL used to retrieve total group results.
+ *
+ * @since BuddyPress (1.5.0)
+ *
+ * @param string $t_sql Concatenated SQL statement used for retrieving total group results.
+ * @param array $total_sql Array of SQL parts for the query.
+ * @param array $r Array of parsed arguments for the get method.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $total_groups_sql = apply_filters( 'bp_groups_get_total_groups_sql', $t_sql, $total_sql, $r );
</span><span class="cx" style="display: block; padding: 0 10px"> $total_groups = $wpdb->get_var( $total_groups_sql );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1036,8 +1099,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public static function get_by_most_forum_topics( $limit = null, $page = null, $user_id = 0, $search_terms = false, $populate_extras = true, $exclude = false ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wpdb, $bbdb;
</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 ( empty( $bbdb ) )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( empty( $bbdb ) ) {
+
+ /** This action is documented in bp-forums/bp-forums-screens */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bbpress_init' );
</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><span class="cx" style="display: block; padding: 0 10px"> if ( !empty( $limit ) && !empty( $page ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $pag_sql = $wpdb->prepare( " LIMIT %d, %d", intval( ( $page - 1 ) * $limit), intval( $limit ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1102,8 +1168,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public static function get_by_most_forum_posts( $limit = null, $page = null, $search_terms = false, $populate_extras = true, $exclude = false ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wpdb, $bbdb;
</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 ( empty( $bbdb ) )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( empty( $bbdb ) ) {
+
+ /** This action is documented in bp-forums/bp-forums-screens */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bbpress_init' );
</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><span class="cx" style="display: block; padding: 0 10px"> if ( !empty( $limit ) && !empty( $page ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $pag_sql = $wpdb->prepare( " LIMIT %d, %d", intval( ( $page - 1 ) * $limit), intval( $limit ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1411,7 +1480,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'unreplied' == $type )
</span><span class="cx" style="display: block; padding: 0 10px"> $bp->groups->filter_sql = ' AND t.topic_posts = 1';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // https://buddypress.trac.wordpress.org/ticket/4306
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the portion of the SQL related to global count of forum topics in public groups.
+ *
+ * https://buddypress.trac.wordpress.org/ticket/4306.
+ *
+ * @since BuddyPress (1.6.0)
+ *
+ * @param string $filter_sql SQL portion for the query.
+ * @param string $type Type of forum topics to query for.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $extra_sql = apply_filters( 'get_global_forum_topic_count_extra_sql', $bp->groups->filter_sql, $type );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Make sure the $extra_sql begins with an AND
</span></span></pre>
</div>
</div>
</body>
</html>