<!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][7428] trunk/bp-core/bp-core-avatars.php: Whitespace improvements for bp_core_fetch_avatar() docblock</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/7428">7428</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2013-10-15 03:07:44 +0000 (Tue, 15 Oct 2013)</dd>
</dl>

<h3>Log Message</h3>
<pre>Whitespace improvements for bp_core_fetch_avatar() docblock

See <a href="http://buddypress.trac.wordpress.org/ticket/5022">#5022</a></pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpcorebpcoreavatarsphp">trunk/bp-core/bp-core-avatars.php</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpcorebpcoreavatarsphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-core/bp-core-avatars.php (7427 => 7428)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-core/bp-core-avatars.php        2013-10-14 23:28:49 UTC (rev 7427)
+++ trunk/bp-core/bp-core-avatars.php   2013-10-15 03:07:44 UTC (rev 7428)
</span><span class="lines">@@ -109,88 +109,70 @@
</span><span class="cx">  *     arguments.
</span><span class="cx">  *
</span><span class="cx">  *     @type int|bool $item_id The numeric ID of the item for which you're
</span><del>- *                             requesting an avatar (eg, a user ID). If no
- *                             'item_id' is present, the function attempts to
- *                             infer an ID from the 'object' + the current
- *                             context: if 'object' is 'user' and the current
- *                             page is a user page, 'item_id' will default to
- *                             the displayed user ID; if 'group' and on a group
- *                             page, to the current group ID; if 'blog', to the
- *                             current blog's ID. If no 'item_id' can be
- *                             determined in this way, the function returns
- *                             false. Default: false.
</del><ins>+ *           requesting an avatar (eg, a user ID). If no 'item_id' is present,
+ *           the function attempts to infer an ID from the 'object' + the
+ *           current context: if 'object' is 'user' and the current page is a
+ *           user page, 'item_id' will default to the displayed user ID; if
+ *           'group' and on a group page, to the current group ID; if 'blog',
+ *           to the current blog's ID. If no 'item_id' can be determined in
+ *           this way, the function returns false. Default: false.
</ins><span class="cx">  *     @type string $object The kind of object for which you're getting an
</span><del>- *                          avatar. BuddyPress natively supports three options:
- *                          'user', 'group', 'blog'; a plugin may register more.
- *                          Default: 'user'.
</del><ins>+ *           avatar. BuddyPress natively supports three options: 'user',
+ *           'group', 'blog'; a plugin may register more.  Default: 'user'.
</ins><span class="cx">  *     @type string $type When a new avatar is uploaded to BP, 'thumb' and
</span><del>- *                        'full' versions are saved. This parameter specifies
- *                        whether you'd like the 'full' or smaller 'thumb'
- *                        avatar. Default: 'thumb'.
</del><ins>+ *           'full' versions are saved. This parameter specifies whether you'd
+ *           like the 'full' or smaller 'thumb' avatar. Default: 'thumb'.
</ins><span class="cx">  *     @type string|bool $avatar_dir The name of the subdirectory where the
</span><del>- *                                   requested avatar should be found. If no
- *                                   value is passed, 'avatar_dir' is inferred
- *                                   from 'object': 'user' becomes 'avatars',
- *                                   'group' becomes 'group-avatars', 'blog'
- *                                   becomes 'blog-avatars'. Remember that this
- *                                   string denotes a subdirectory of BP's
- *                                   main avatar directory (usually based on
- *                                   {@link wp_upload_dir()}); it's a string
- *                                   like 'group-avatars' rather than the full
- *                                   directory path. Generally, it'll only be
- *                                   necessary to override the default value if
- *                                   storing avatars in a non-default location.
- *                                   Defaults to false (auto-detected).
</del><ins>+ *           requested avatar should be found. If no value is passed,
+ *           'avatar_dir' is inferred from 'object': 'user' becomes 'avatars',
+ *           'group' becomes 'group-avatars', 'blog' becomes 'blog-avatars'.
+ *           Remember that this string denotes a subdirectory of BP's main
+ *           avatar directory (usually based on {@link wp_upload_dir()}); it's a
+ *           string like 'group-avatars' rather than the full directory path.
+ *           Generally, it'll only be necessary to override the default value if
+ *           storing avatars in a non-default location. Defaults to false
+ *           (auto-detected).
</ins><span class="cx">  *     @type int|bool $width Requested avatar width. The unit is px. This value
</span><del>- *                           is used to build the 'width' attribute for the
- *                           <img> element. If no value is passed, BP uses the
- *                           global avatar width for this avatar type. Default:
- *                           false (auto-detected).
- *     @type int|bool $height Requested avatar height. The unit is px. This value
- *                           is used to build the 'height' attribute for the
- *                           <img> element. If no value is passed, BP uses the
- *                           global avatar height for this avatar type. Default:
- *                           false (auto-detected).
</del><ins>+ *           is used to build the 'width' attribute for the <img> element. If
+ *           no value is passed, BP uses the global avatar width for this
+ *           avatar type. Default: false (auto-detected).
+ *     @type int|bool $height Requested avatar height. The unit is px. This
+ *           value is used to build the 'height' attribute for the <img>
+ *           element. If no value is passed, BP uses the global avatar height
+ *           for this avatar type. Default: false (auto-detected).
</ins><span class="cx">  *     @type string $class The CSS class for the <img> element. Note that BP
</span><del>- *                         uses the 'avatar' class fairly extensively in its
- *                         default styling, so if you plan to pass a custom
- *                         value, consider appending it to 'avatar' (eg
- *                         'avatar foo') rather than replacing it altogether.
- *                         Default: 'avatar'.
</del><ins>+ *           uses the 'avatar' class fairly extensively in its default styling,
+ *           so if you plan to pass a custom value, consider appending it to
+ *           'avatar' (eg 'avatar foo') rather than replacing it altogether.
+ *           Default: 'avatar'.
</ins><span class="cx">  *     @type string|bool $css_id The CSS id for the <img> element.
</span><del>- *                               Default: false.
</del><ins>+ *           Default: false.
</ins><span class="cx">  *     @type string $title The title attribute for the <img> element.
</span><del>- *                         Default: false.
</del><ins>+ *           Default: false.
</ins><span class="cx">  *     @type string $alt The alt attribute for the <img> element. In BP, this
</span><del>- *                       value is generally passed by the wrapper functions,
- *                       where the data necessary for concatenating the string
- *                       is at hand; see {@link bp_get_activity_avatar()} for an
- *                       example. Default: ''.
</del><ins>+ *           value is generally passed by the wrapper functions, where the data
+ *           necessary for concatenating the string is at hand; see
+ *           {@link bp_get_activity_avatar()} for an example. Default: ''.
</ins><span class="cx">  *     @type string|bool $email An email to use in Gravatar queries. Unless
</span><del>- *                              otherwise configured, BP uses Gravatar as a
- *                              fallback for avatars that are not provided
- *                              locally. Gravatar's API requires using a hash of
- *                              the user's email address; this argument
- *                              provides it. If not provided, the function
- *                              will infer it: for users, by getting the user's
- *                              email from the database, for groups/blogs, by
- *                              concatenating "{$item_id}-{$object}@{bp_get_root_domain()}".
- *                              The user query adds overhead, so it's
- *                              recommended that wrapper functions provide a
- *                              value for 'email' when querying user IDs.
- *                              Default: false.
</del><ins>+ *           otherwise configured, BP uses Gravatar as a fallback for avatars
+ *           that are not provided locally. Gravatar's API requires using a hash
+ *           of the user's email address; this argument provides it. If not
+ *           provided, the function will infer it: for users, by getting the
+ *           user's email from the database, for groups/blogs, by concatenating
+ *           "{$item_id}-{$object}@{bp_get_root_domain()}". The user query adds
+ *           overhead, so it's recommended that wrapper functions provide a
+ *           value for 'email' when querying user IDs. Default: false.
</ins><span class="cx">  *     @type bool $no_grav Whether to disable the default Gravatar fallback.
</span><del>- *                         By default, BP will fall back on Gravatar when it
- *                         cannot find a local avatar. In some cases, this may
- *                         be undesirable, in which case 'no_grav' should be
- *                         set to true. To disable Gravatar fallbacks globally,
- *                         see the 'bp_core_fetch_avatar_no_grav' filter.
- *                         Default: false.
</del><ins>+ *           By default, BP will fall back on Gravatar when it cannot find a
+ *           local avatar. In some cases, this may be undesirable, in which
+ *           case 'no_grav' should be set to true. To disable Gravatar
+ *           fallbacks globally, see the 'bp_core_fetch_avatar_no_grav' filter.
+ *           Default: false.
</ins><span class="cx">  *     @type bool $html Whether to return an <img> HTML element, vs a raw URL
</span><del>- *                      to an avatar. If false, <img>-specific arguments (like
- *                      'css_id') will be ignored. Default: true.
</del><ins>+ *           to an avatar. If false, <img>-specific arguments (like 'css_id')
+ *           will be ignored. Default: true.
</ins><span class="cx">  * }
</span><del>- * @return string Formatted HTML <img> element, or raw avatar URL based on $html arg
</del><ins>+ * @return string Formatted HTML <img> element, or raw avatar URL based on $html arg.
</ins><span class="cx">  */
</span><span class="cx"> function bp_core_fetch_avatar( $args = '' ) {
</span><span class="cx"> 
</span></span></pre>
</div>
</div>

</body>
</html>