<!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][12481] trunk/src/bp-core/bp-core-functions.php: Docs: fix typos and code comments gone rogue.</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/12481">12481</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/12481","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>2019-10-24 01:17:50 +0000 (Thu, 24 Oct 2019)</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'>Docs: fix typos and code comments gone rogue.
This commit fixes a few random typos and weirdly misplaced code comments I stumbled across in the Core Functions file while looking at something else entirely. {U+01F43F}</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcorebpcorefunctionsphp">trunk/src/bp-core/bp-core-functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpcorebpcorefunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-core/bp-core-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/bp-core-functions.php 2019-10-18 18:09:27 UTC (rev 12480)
+++ trunk/src/bp-core/bp-core-functions.php 2019-10-24 01:17:50 UTC (rev 12481)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -16,7 +16,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Output the BuddyPress version.
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- *
</del><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_version() {
</span><span class="cx" style="display: block; padding: 0 10px"> echo bp_get_version();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -36,7 +35,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Output the BuddyPress database version.
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- *
</del><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_db_version() {
</span><span class="cx" style="display: block; padding: 0 10px"> echo bp_get_db_version();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -56,7 +54,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Output the BuddyPress database version.
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- *
</del><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_db_version_raw() {
</span><span class="cx" style="display: block; padding: 0 10px"> echo bp_get_db_version_raw();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -236,7 +233,7 @@
</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><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $old_args_keys Old argument indexs, keyed to their positions.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $old_args_keys Old argument indexes, keyed to their positions.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param array $func_args The parameters passed to the originating function.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array $new_args The parsed arguments.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -321,7 +318,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Sanitizes a pagination argument based on both the request override and the
</span><span class="cx" style="display: block; padding: 0 10px"> * original value submitted via a query argument, likely to a template class
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * responsible for limiting the resultset of a template loop.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * responsible for limiting the result set of a template loop.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.2.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1422,7 +1419,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * so that the message is not shown to the user multiple times.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.1.0
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- *
</del><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_core_setup_message() {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1506,8 +1502,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">- * usermeta table.
- *
</del><span class="cx" style="display: block; padding: 0 10px"> * @return false|null Returns false if there is nothing to do.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_core_record_activity() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1563,8 +1557,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">- * representation of the time elapsed.
- *
</del><span class="cx" style="display: block; padding: 0 10px"> * @param int|string $last_activity_date The date of last activity.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $string A sprintf()-able statement of the form 'active %s'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string $last_active A string of the form '3 years ago'.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1598,7 +1590,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Get the meta_key for a given piece of user metadata
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * BuddyPress stores a number of pieces of userdata in the WordPress central
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * BuddyPress stores a number of pieces of user data in the WordPress central
</ins><span class="cx" style="display: block; padding: 0 10px"> * usermeta table. In order to allow plugins to enable multiple instances of
</span><span class="cx" style="display: block; padding: 0 10px"> * BuddyPress on a single WP installation, BP's usermeta keys are filtered
</span><span class="cx" style="display: block; padding: 0 10px"> * through this function, so that they can be altered on the fly.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3110,11 +3102,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $email_type Type of email being sent.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|array|int|WP_User $to Either a email address, user ID, WP_User object,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * or an array containg the address and name.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * or an array containing the address and name.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param array $args {
</span><span class="cx" style="display: block; padding: 0 10px"> * Optional. Array of extra parameters.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type array $tokens Optional. Assocative arrays of string replacements for the email.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type array $tokens Optional. Associative arrays of string replacements for the email.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool|WP_Error True if the email was sent successfully. Otherwise, a WP_Error object
</span><span class="cx" style="display: block; padding: 0 10px"> * describing why the email failed to send. The contents will vary based
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3166,7 +3158,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param BP_Email $email The email (object) about to be sent.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $email_type Type of email being sent.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|array|int|WP_User $to Either a email address, user ID, WP_User object,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * or an array containg the address and name.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * or an array containing the address and name.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param array $args {
</span><span class="cx" style="display: block; padding: 0 10px"> * Optional. Array of extra parameters.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3220,7 +3212,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args {
</span><span class="cx" style="display: block; padding: 0 10px"> * Optional. Array of extra parameters.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type array $tokens Optional. Assocative arrays of string replacements for the email.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type array $tokens Optional. Associative arrays of string replacements for the email.
</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"> $delivery_class = apply_filters( 'bp_send_email_delivery_class', 'BP_PHPMailer', $email_type, $to, $args );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3247,7 +3239,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</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">- * Fires after BuddyPress has succesfully sent an email.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Fires after BuddyPress has successfully sent an email.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span></span></pre>
</div>
</div>
</body>
</html>