<!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][8785] trunk/src/bp-xprofile: Introduce bp_xprofile_get_groups() procedural wrapper for BP_XProfile_Group::get()</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">
<dt>Revision</dt> <dd><a href="http://buddypress.trac.wordpress.org/changeset/8785">8785</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2014-08-10 20:33:24 +0000 (Sun, 10 Aug 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Introduce bp_xprofile_get_groups() procedural wrapper for BP_XProfile_Group::get()
This wrapper includes a filter on the return values, so that plugin authors can
manipulate data programatically.
Also includes some documentation improvements, and implements new function
throughout BP.
See <a href="http://buddypress.trac.wordpress.org/ticket/5657">#5657</a>
Props tw2113</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpxprofilebpxprofileadminphp">trunk/src/bp-xprofile/bp-xprofile-admin.php</a></li>
<li><a href="#trunksrcbpxprofilebpxprofileclassesphp">trunk/src/bp-xprofile/bp-xprofile-classes.php</a></li>
<li><a href="#trunksrcbpxprofilebpxprofilefunctionsphp">trunk/src/bp-xprofile/bp-xprofile-functions.php</a></li>
<li><a href="#trunksrcbpxprofilebpxprofiletemplatephp">trunk/src/bp-xprofile/bp-xprofile-template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpxprofilebpxprofileadminphp"></a>
<div class="modfile"><h4>Modified: trunk/src/bp-xprofile/bp-xprofile-admin.php (8784 => 8785)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/bp-xprofile/bp-xprofile-admin.php 2014-08-10 18:34:59 UTC (rev 8784)
+++ trunk/src/bp-xprofile/bp-xprofile-admin.php 2014-08-10 20:33:24 UTC (rev 8785)
</span><span class="lines">@@ -36,7 +36,7 @@
</span><span class="cx">
</span><span class="cx"> $type = preg_replace( '|[^a-z]|i', '', $type );
</span><span class="cx">
</span><del>- $groups = BP_XProfile_Group::get( array(
</del><ins>+ $groups = bp_xprofile_get_groups( array(
</ins><span class="cx"> 'fetch_fields' => true
</span><span class="cx"> ) );
</span><span class="cx">
</span><span class="lines">@@ -287,7 +287,7 @@
</span><span class="cx">
</span><span class="cx"> do_action( 'xprofile_fields_saved_field', $field );
</span><span class="cx">
</span><del>- $groups = BP_XProfile_Group::get();
</del><ins>+ $groups = bp_xprofile_get_groups();
</ins><span class="cx"> xprofile_admin( $message, $type );
</span><span class="cx"> }
</span><span class="cx"> } else {
</span></span></pre></div>
<a id="trunksrcbpxprofilebpxprofileclassesphp"></a>
<div class="modfile"><h4>Modified: trunk/src/bp-xprofile/bp-xprofile-classes.php (8784 => 8785)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/bp-xprofile/bp-xprofile-classes.php 2014-08-10 18:34:59 UTC (rev 8784)
+++ trunk/src/bp-xprofile/bp-xprofile-classes.php 2014-08-10 20:33:24 UTC (rev 8785)
</span><span class="lines">@@ -108,18 +108,27 @@
</span><span class="cx"> * @global $wpdb WordPress DB access object.
</span><span class="cx"> * @global BuddyPress $bp The one true BuddyPress instance
</span><span class="cx"> *
</span><del>- * @param array $args Takes an array of parameters:
- * 'profile_group_id' - Limit results to a single profile group
- * 'user_id' - Required if you want to load a specific user's data
- * 'hide_empty_groups' - Hide groups without any fields
- * 'hide_empty_fields' - Hide fields where the user has not provided data
- * 'fetch_fields' - Load each group's fields
- * 'fetch_field_data' - Load each field's data. Requires a user_id
- * 'exclude_groups' - Comma-separated list of groups to exclude
- * 'exclude_fields' - Comma-separated list of fields to exclude
- * 'update_meta_cache' - Whether to pre-fetch xprofilemeta
- * for all retrieved groups, fields, and data
- *
</del><ins>+ * @param array $args {
+ * Array of optional arguments:
+ * @type int $profile_group_id Limit results to a single profile
+ * group.
+ * @type int $user_id Required if you want to load a specific
+ * user's data. Default: displayed user's ID.
+ * @type bool $hide_empty_groups True to hide groups that don't
+ * have any fields. Default: false.
+ * @type bool $hide_empty_fields True to hide fields where the
+ * user has not provided data. Default: false.
+ * @type bool $fetch_fields Whether to fetch each group's fields.
+ * Default: false.
+ * @type bool $fetch_field_data Whether to fetch data for each
+ * field. Requires a $user_id. Default: false.
+ * @type array $exclude_groups Comma-separated list or array of
+ * group IDs to exclude.
+ * @type array $exclude_fields Comma-separated list or array of
+ * field IDs to exclude.
+ * @type bool $update_meta_cache Whether to pre-fetch xprofilemeta
+ * for all retrieved groups, fields, and data. Default: true.
+ * }
</ins><span class="cx"> * @return array $groups
</span><span class="cx"> */
</span><span class="cx"> public static function get( $args = array() ) {
</span><span class="lines">@@ -1223,7 +1232,7 @@
</span><span class="cx"> public static function get_all_for_user( $user_id ) {
</span><span class="cx"> global $wpdb, $bp;
</span><span class="cx">
</span><del>- $groups = BP_XProfile_Group::get( array(
</del><ins>+ $groups = bp_xprofile_get_groups( array(
</ins><span class="cx"> 'user_id' => $user_id,
</span><span class="cx"> 'hide_empty_groups' => true,
</span><span class="cx"> 'hide_empty_fields' => true,
</span></span></pre></div>
<a id="trunksrcbpxprofilebpxprofilefunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/src/bp-xprofile/bp-xprofile-functions.php (8784 => 8785)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/bp-xprofile/bp-xprofile-functions.php 2014-08-10 18:34:59 UTC (rev 8784)
+++ trunk/src/bp-xprofile/bp-xprofile-functions.php 2014-08-10 20:33:24 UTC (rev 8785)
</span><span class="lines">@@ -17,6 +17,24 @@
</span><span class="cx">
</span><span class="cx"> /*** Field Group Management **************************************************/
</span><span class="cx">
</span><ins>+/**
+ * Fetch a set of field groups, populated with fields and field data.
+ *
+ * Procedural wrapper for BP_XProfile_Group::get() method.
+ *
+ * @since BuddyPress (2.1.0)
+ *
+ * @param array $args See {@link BP_XProfile_Group::get()} for description of
+ * arguments.
+ * @return array $groups
+ */
+function bp_xprofile_get_groups( $args = array() ) {
+
+ $groups = BP_XProfile_Group::get( $args );
+
+ return apply_filters( 'bp_xprofile_get_groups', $groups, $args );
+}
+
</ins><span class="cx"> function xprofile_insert_field_group( $args = '' ) {
</span><span class="cx"> $defaults = array(
</span><span class="cx"> 'field_group_id' => false,
</span></span></pre></div>
<a id="trunksrcbpxprofilebpxprofiletemplatephp"></a>
<div class="modfile"><h4>Modified: trunk/src/bp-xprofile/bp-xprofile-template.php (8784 => 8785)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/bp-xprofile/bp-xprofile-template.php 2014-08-10 18:34:59 UTC (rev 8784)
+++ trunk/src/bp-xprofile/bp-xprofile-template.php 2014-08-10 20:33:24 UTC (rev 8785)
</span><span class="lines">@@ -25,7 +25,7 @@
</span><span class="cx"> var $user_id;
</span><span class="cx">
</span><span class="cx"> function __construct( $user_id, $profile_group_id, $hide_empty_groups = false, $fetch_fields = false, $fetch_field_data = false, $exclude_groups = false, $exclude_fields = false, $hide_empty_fields = false, $fetch_visibility_level = false, $update_meta_cache = true ) {
</span><del>- $this->groups = BP_XProfile_Group::get( array(
</del><ins>+ $this->groups = bp_xprofile_get_groups( array(
</ins><span class="cx"> 'profile_group_id' => $profile_group_id,
</span><span class="cx"> 'user_id' => $user_id,
</span><span class="cx"> 'hide_empty_groups' => $hide_empty_groups,
</span><span class="lines">@@ -600,7 +600,7 @@
</span><span class="cx"> $groups = wp_cache_get( 'xprofile_groups_inc_empty', 'bp' );
</span><span class="cx">
</span><span class="cx"> if ( empty( $groups ) ) {
</span><del>- $groups = BP_XProfile_Group::get( array( 'fetch_fields' => true ) );
</del><ins>+ $groups = bp_xprofile_get_groups( array( 'fetch_fields' => true ) );
</ins><span class="cx"> wp_cache_set( 'xprofile_groups_inc_empty', $groups, 'bp' );
</span><span class="cx"> }
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>