<!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][13475] trunk/src/bp-xprofile/classes: Improve inline doc, informing about `$wpdb` usage in functions</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 { white-space: pre-line; 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/13475">13475</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/13475","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>imath</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-05-13 08:57:35 +0000 (Sat, 13 May 2023)</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'>Improve inline doc, informing about `$wpdb` usage in functions
Props upadalavipul
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/8890">#8890</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpxprofileclassesclassbpxprofilegroupphp">trunk/src/bp-xprofile/classes/class-bp-xprofile-group.php</a></li>
<li><a href="#trunksrcbpxprofileclassesclassbpxprofilemetaqueryphp">trunk/src/bp-xprofile/classes/class-bp-xprofile-meta-query.php</a></li>
<li><a href="#trunksrcbpxprofileclassesclassbpxprofileprofiledataphp">trunk/src/bp-xprofile/classes/class-bp-xprofile-profiledata.php</a></li>
<li><a href="#trunksrcbpxprofileclassesclassbpxprofilequeryphp">trunk/src/bp-xprofile/classes/class-bp-xprofile-query.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpxprofileclassesclassbpxprofilegroupphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-xprofile/classes/class-bp-xprofile-group.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-xprofile/classes/class-bp-xprofile-group.php 2023-05-08 09:59:01 UTC (rev 13474)
+++ trunk/src/bp-xprofile/classes/class-bp-xprofile-group.php 2023-05-13 08:57:35 UTC (rev 13475)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -84,8 +84,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @global wpdb $wpdb WordPress database object.
- *
</del><span class="cx" style="display: block; padding: 0 10px"> * @param int $id Field group ID.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return boolean
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -467,6 +465,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 11.0.0 `$profile_group_id` accepts an array of profile group ids.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @global wpdb $wpdb WordPress database object.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args {
</span><span class="cx" style="display: block; padding: 0 10px"> * Array of optional arguments.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -524,6 +524,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Gets group field IDs, based on passed parameters.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.0.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @global wpdb $wpdb WordPress database object.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $group_ids Array of group IDs.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -616,6 +618,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Get data about a set of groups, based on IDs.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.0.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @global wpdb $wpdb WordPress database object.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $group_ids Array of IDs.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -786,6 +790,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Fetch the admin-set preferences for all fields.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.6.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @global wpdb $wpdb WordPress database object.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array $default_visibility_levels An array, keyed by field_id, of default
</span><span class="cx" style="display: block; padding: 0 10px"> * visibility level + allow_custom
</span></span></pre></div>
<a id="trunksrcbpxprofileclassesclassbpxprofilemetaqueryphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-xprofile/classes/class-bp-xprofile-meta-query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-xprofile/classes/class-bp-xprofile-meta-query.php 2023-05-08 09:59:01 UTC (rev 13474)
+++ trunk/src/bp-xprofile/classes/class-bp-xprofile-meta-query.php 2023-05-13 08:57:35 UTC (rev 13475)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -152,6 +152,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * "First-order" means that it's an array with a 'key' or 'value'.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.3.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @global wpdb $wpdb WordPress database object.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $clause Query clause, passed by reference.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $parent_query Parent query array.
</span></span></pre></div>
<a id="trunksrcbpxprofileclassesclassbpxprofileprofiledataphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-xprofile/classes/class-bp-xprofile-profiledata.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-xprofile/classes/class-bp-xprofile-profiledata.php 2023-05-08 09:59:01 UTC (rev 13474)
+++ trunk/src/bp-xprofile/classes/class-bp-xprofile-profiledata.php 2023-05-13 08:57:35 UTC (rev 13475)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -76,6 +76,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Populates the XProfile profile data.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.0.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @global wpdb $wpdb WordPress database object.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $field_id Field ID to populate.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $user_id User ID to populate for.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -175,6 +177,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Save the data for the XProfile field.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.0.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @global wpdb $wpdb WordPress database object.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -317,6 +321,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 8.0.0 Checks if a null field data is an xProfile WP Field.
</span><span class="cx" style="display: block; padding: 0 10px"> * Adds a new parameter `$field_type_objects` to pass the list of field type objects.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @global wpdb $wpdb WordPress database object.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $user_id ID of user whose data is being queried.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $field_ids Array of field IDs to query for.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -474,6 +480,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Get the user's field data id by the id of the xprofile field.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.6.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @global wpdb $wpdb WordPress database object.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $field_id Field ID being queried for.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $user_id User ID associated with field.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -507,6 +515,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 8.0.0 Checks if a null field data is an xProfile WP Field.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @global wpdb $wpdb WordPress database object.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $field_id ID of the field.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int|array|null $user_ids ID or IDs of user(s).
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -615,6 +625,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Get profile field values by field name and user ID.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.0.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @global wpdb $wpdb WordPress database object.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @deprecated 8.0.0 This function is not used anymore.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array|string $fields Field(s) to get.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -681,6 +694,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Delete field.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.0.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @global wpdb $wpdb WordPress database object.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $field_id ID of the field to delete.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -701,6 +716,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Get time for last XProfile field data update by user.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.0.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @global wpdb $wpdb WordPress database object.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $user_id User ID to get time for.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return null|string
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -719,6 +736,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Delete all data for provided user ID.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.0.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @global wpdb $wpdb WordPress database object.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $user_id User ID to remove data for.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return false|int
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -745,6 +764,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Get random field type by user ID.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.0.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @global wpdb $wpdb WordPress database object.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $user_id User ID to query for.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $exclude_fullname SQL portion used to exclude by field ID.
</span></span></pre></div>
<a id="trunksrcbpxprofileclassesclassbpxprofilequeryphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-xprofile/classes/class-bp-xprofile-query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-xprofile/classes/class-bp-xprofile-query.php 2023-05-08 09:59:01 UTC (rev 13474)
+++ trunk/src/bp-xprofile/classes/class-bp-xprofile-query.php 2023-05-13 08:57:35 UTC (rev 13475)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -340,6 +340,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * "First-order" means that it's an array with a 'field' or 'value'.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.2.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @global wpdb $wpdb WordPress database object.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $clause Query clause.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $parent_query Parent query array.
</span></span></pre>
</div>
</div>
</body>
</html>