<!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][9987] trunk/src/bp-core/bp-core-buddybar.php: Improve formatting of inline documentation in bp-core-buddybar.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/9987">9987</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/9987","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-07-02 19:08:07 +0000 (Thu, 02 Jul 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'>Improve formatting of inline documentation in bp-core-buddybar.php.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcorebpcorebuddybarphp">trunk/src/bp-core/bp-core-buddybar.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpcorebpcorebuddybarphp"></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-buddybar.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/bp-core-buddybar.php 2015-07-02 13:25:25 UTC (rev 9986)
+++ trunk/src/bp-core/bp-core-buddybar.php 2015-07-02 19:08:07 UTC (rev 9987)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -16,22 +16,18 @@
</span><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 describing the new nav item.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type string $name Display name for the nav item.
- * @type string $slug Unique URL slug for the nav item.
- * @type bool|string $item_css_id Optional. 'id' attribute for the nav
- * item. Default: the value of $slug.
- * @type bool $show_for_displayed_user Optional. Whether the nav item
- * should be visible when viewing a member profile other than your
- * own. Default: true.
- * @type bool $site_admin_only Optional. Whether the nav item should be
- * visible only to site admins (those with the 'bp_moderate' cap).
- * Default: false.
- * @type int $position Optional. Numerical index specifying where the item
- * should appear in the nav array. Default: 99.
- * @type callable $screen_function The callback function that will run
- * when the nav item is clicked.
- * @type bool|string $default_subnav_slug Optional. The slug of the default
- * subnav item to select when the nav item is clicked.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $name Display name for the nav item.
+ * @type string $slug Unique URL slug for the nav item.
+ * @type bool|string $item_css_id Optional. 'id' attribute for the nav item. Default: the value of `$slug`.
+ * @type bool $show_for_displayed_user Optional. Whether the nav item should be visible when viewing a
+ * member profile other than your own. Default: true.
+ * @type bool $site_admin_only Optional. Whether the nav item should be visible only to site admins
+ * (those with the 'bp_moderate' cap). Default: false.
+ * @type int $position Optional. Numerical index specifying where the item should appear in
+ * the nav array. Default: 99.
+ * @type callable $screen_function The callback function that will run when the nav item is clicked.
+ * @type bool|string $default_subnav_slug Optional. The slug of the default subnav item to select when the nav
+ * item is clicked.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool|null Returns false on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -137,11 +133,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Modify the default subnav item that loads when a top level nav item is clicked.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type string $parent_slug The slug of the nav item whose default is
- * being changed.
- * @type callable $screen_function The new default callback function that
- * will run when the nav item is clicked.
- * @type string $subnav_slug The slug of the new default subnav item.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $parent_slug The slug of the nav item whose default is being changed.
+ * @type callable $screen_function The new default callback function that will run when the nav item is clicked.
+ * @type string $subnav_slug The slug of the new default subnav item.
</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"> function bp_core_new_nav_default( $args = '' ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -244,29 +238,25 @@
</span><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 describing the new subnav item.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type string $name Display name for the subnav item.
- * @type string $slug Unique URL slug for the subnav item.
- * @type string $parent_slug Slug of the top-level nav item under which the
- * new subnav item should be added.
- * @type string $parent_url URL of the parent nav item.
- * @type bool|string $item_css_id Optional. 'id' attribute for the nav
- * item. Default: the value of $slug.
- * @type bool $user_has_access Optional. True if the logged-in user has
- * access to the subnav item, otherwise false. Can be set dynamically
- * when registering the subnav; eg, use bp_is_my_profile() to restrict
- * access to profile owners only. Default: true.
- * @type bool $site_admin_only Optional. Whether the nav item should be
- * visible only to site admins (those with the 'bp_moderate' cap).
- * Default: false.
- * @type int $position Optional. Numerical index specifying where the item
- * should appear in the subnav array. Default: 90.
- * @type callable $screen_function The callback function that will run
- * when the nav item is clicked.
- * @type string $link Optional. The URL that the subnav item should point
- * to. Defaults to a value generated from the $parent_url + $slug.
- * @type bool $show_in_admin_bar Optional. Whether the nav item should be
- * added into the group's "Edit" Admin Bar menu for group admins.
- * Default: false.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $name Display name for the subnav item.
+ * @type string $slug Unique URL slug for the subnav item.
+ * @type string $parent_slug Slug of the top-level nav item under which the new subnav item should
+ * be added.
+ * @type string $parent_url URL of the parent nav item.
+ * @type bool|string $item_css_id Optional. 'id' attribute for the nav item. Default: the value of `$slug`.
+ * @type bool $user_has_access Optional. True if the logged-in user has access to the subnav item,
+ * otherwise false. Can be set dynamically when registering the subnav;
+ * eg, use `bp_is_my_profile()` to restrict access to profile owners only.
+ * Default: true.
+ * @type bool $site_admin_only Optional. Whether the nav item should be visible only to site admins
+ * (those with the 'bp_moderate' cap). Default: false.
+ * @type int $position Optional. Numerical index specifying where the item should appear in the
+ * subnav array. Default: 90.
+ * @type callable $screen_function The callback function that will run when the nav item is clicked.
+ * @type string $link Optional. The URL that the subnav item should point to. Defaults to a value
+ * generated from the `$parent_url` + `$slug`.
+ * @type bool $show_in_admin_bar Optional. Whether the nav item should be added into the group's "Edit"
+ * Admin Bar menu for group admins. Default: false.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool|null Returns false on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -363,8 +353,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since BuddyPress (2.1.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 $subnav_item The subnav array added to bp_options_nav in
- * bp_core_new_subnav_item().
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $subnav_item The subnav array added to bp_options_nav in `bp_core_new_subnav_item()`.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return array
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_core_maybe_hook_new_subnav_screen_function( $subnav_item ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -489,10 +478,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since BuddyPress (1.5.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 string $nav_item The slug of the top-level nav item whose subnav
- * items you're checking. Default: the current component slug.
- * @return bool $has_subnav True if the nav item is found and has subnav
- * items; false otherwise.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $nav_item The slug of the top-level nav item whose subnav items you're checking.
+ * Default: the current component slug.
+ * @return bool $has_subnav True if the nav item is found and has subnav items; false otherwise.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_nav_item_has_subnav( $nav_item = '' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $bp = buddypress();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -508,8 +496,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since BuddyPress (1.5.0)
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool $has_subnav Whether or not there is any subnav items.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $nav_item The slug of the top-level nav item whose subnav
- * items you're checking.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $nav_item The slug of the top-level nav item whose subnav items you're checking.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_nav_item_has_subnav', $has_subnav, $nav_item );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -547,7 +534,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Remove a subnav item from the navigation array.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $parent_id The slug of the parent navigation item.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $slug The slug of the subnav item to be removed.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $slug The slug of the subnav item to be removed.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_core_remove_subnav_item( $parent_id, $slug ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $bp = buddypress();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -591,8 +578,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @uses get_user_option()
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $context Context of this preference check. 'admin' or 'front'.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $user Optional. ID of the user to check. Default: 0 (which falls
- * back to the logged-in user's ID).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $user Optional. ID of the user to check. Default: 0 (which falls back to the logged-in user's ID).
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool True if the toolbar should be showing for this user.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_get_admin_bar_pref( $context, $user = 0 ) {
</span></span></pre>
</div>
</div>
</body>
</html>