<!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][10003] trunk/src/bp-core/bp-core-buddybar.php: Refactor bp_core_new_nav_item().</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/10003">10003</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/10003","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>dcavins</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-07-10 02:54:03 +0000 (Fri, 10 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'>Refactor bp_core_new_nav_item().
Use new functions `bp_core_create_nav_link()` and
`bp_core_register_nav_screen_function()` within
`bp_core_new_nav_item()`. Also introduces two new
action hooks: `bp_core_create_nav_link` and
`bp_core_register_nav_screen_function`.
See <a href="http://buddypress.trac.wordpress.org/ticket/6503">#6503</a>.</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-09 00:28:55 UTC (rev 10002)
+++ trunk/src/bp-core/bp-core-buddybar.php 2015-07-10 02:54:03 UTC (rev 10003)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -32,6 +32,71 @@
</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="cx" style="display: block; padding: 0 10px"> function bp_core_new_nav_item( $args = '' ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $defaults = array(
+ 'name' => false, // Display name for the nav item
+ 'slug' => false, // URL slug for the nav item
+ 'item_css_id' => false, // The CSS ID to apply to the HTML of the nav item
+ 'show_for_displayed_user' => true, // When viewing another user does this nav item show up?
+ 'site_admin_only' => false, // Can only site admins see this nav item?
+ 'position' => 99, // Index of where this nav item should be positioned
+ 'screen_function' => false, // The name of the function to run when clicked
+ 'default_subnav_slug' => false // The slug of the default subnav item to select when clicked
+ );
+
+ $r = wp_parse_args( $args, $defaults );
+
+ // First, add the nav item link to the bp_nav array.
+ $created = bp_core_create_nav_link( $r );
+
+ // To mimic the existing behavior, if bp_core_create_nav_link()
+ // returns false, we make an early exit and don't attempt to register
+ // the screen function.
+ if ( false === $created ) {
+ return false;
+ }
+
+ // Then, hook the screen function for the added nav item.
+ bp_core_register_nav_screen_function( $r );
+
+ /**
+ * Fires after adding an item to the main BuddyPress navigation array.
+ * Note that, when possible, the more specific action hooks
+ * `bp_core_create_nav_link` or `bp_core_register_nav_screen_function`
+ * should be used.
+ *
+ * @since BuddyPress (1.5.0)
+ *
+ * @param array $r Parsed arguments for the nav item.
+ * @param array $args Originally passed in arguments for the nav item.
+ * @param array $defaults Default arguments for a nav item.
+ */
+ do_action( 'bp_core_new_nav_item', $r, $args, $defaults );
+}
+
+/**
+ * Add a link to the main BuddyPress navigation array.
+ *
+ * @since BuddyPress (2.4.0)
+ *
+ * @param array $args {
+ * Array describing the new nav item.
+ * @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.
+ * }
+ * @return bool|null Returns false on failure.
+ */
+function bp_core_create_nav_link( $args = '' ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $bp = buddypress();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $defaults = array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -47,16 +112,25 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $r = wp_parse_args( $args, $defaults );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // If we don't have the required info we need, don't create this subnav item
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // If we don't have the required info we need, don't create this nav item.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $r['name'] ) || empty( $r['slug'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</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">- // If this is for site admins only and the user is not one, don't create the subnav item
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // If this is for site admins only and the user is not one, don't create the nav item.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $r['site_admin_only'] ) && ! bp_current_user_can( 'bp_moderate' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * If this nav item is hidden for the displayed user, and
+ * the logged in user is not the displayed user
+ * looking at their own profile, don't create the nav item.
+ */
+ if ( empty( $r['show_for_displayed_user'] ) && ! bp_user_has_access() ) {
+ return false;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $r['item_css_id'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $r['item_css_id'] = $r['slug'];
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -72,10 +146,73 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'default_subnav_slug' => $r['default_subnav_slug']
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Fires after a link is added to the main BuddyPress navigation array.
+ *
+ * @since BuddyPress (2.4.0)
+ *
+ * @param array $r Parsed arguments for the nav item.
+ * @param array $args Originally passed in arguments for the nav item.
+ * @param array $defaults Default arguments for a nav item.
+ */
+ do_action( 'bp_core_create_nav_link', $r, $args, $defaults );
+}
+
+/**
+ * Register a screen function for an item in the main nav array.
+ *
+ * @since BuddyPress (2.4.0)
+ *
+ * @param array $args {
+ * Array describing the new nav item.
+ * @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.
+ * }
+ * @return bool|null Returns false on failure.
+ */
+function bp_core_register_nav_screen_function( $args = '' ) {
+ $bp = buddypress();
+
+ $defaults = array(
+ 'name' => false, // Display name for the nav item
+ 'slug' => false, // URL slug for the nav item
+ 'item_css_id' => false, // The CSS ID to apply to the HTML of the nav item
+ 'show_for_displayed_user' => true, // When viewing another user does this nav item show up?
+ 'site_admin_only' => false, // Can only site admins see this nav item?
+ 'position' => 99, // Index of where this nav item should be positioned
+ 'screen_function' => false, // The name of the function to run when clicked
+ 'default_subnav_slug' => false // The slug of the default subnav item to select when clicked
+ );
+
+ $r = wp_parse_args( $args, $defaults );
+
+ // If we don't have the required info we need, don't register this screen function.
+ if ( empty( $r['slug'] ) ) {
+ return false;
+ }
+
+ /**
+ * If this is for site admins only and the user is not one,
+ * don't register this screen function.
+ */
+ if ( ! empty( $r['site_admin_only'] ) && ! bp_current_user_can( 'bp_moderate' ) ) {
+ return false;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * If this nav item is hidden for the displayed user, and
</span><span class="cx" style="display: block; padding: 0 10px"> * the logged in user is not the displayed user
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * looking at their own profile, don't create the nav item.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * looking at their own profile, don't don't register this screen function.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $r['show_for_displayed_user'] ) && ! bp_user_has_access() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -96,7 +233,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // The requested URL has explicitly included the default subnav
</span><span class="cx" style="display: block; padding: 0 10px"> // (eg: http://example.com/members/membername/activity/just-me/)
</span><span class="cx" style="display: block; padding: 0 10px"> // The canonical version will not contain this subnav slug.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! empty( $r['default_subnav_slug'] ) && bp_is_current_action( $r['default_subnav_slug'] ) && !bp_action_variable( 0 ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! empty( $r['default_subnav_slug'] ) && bp_is_current_action( $r['default_subnav_slug'] ) && ! bp_action_variable( 0 ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> unset( $bp->canonical_stack['action'] );
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( ! bp_current_action() ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -122,15 +259,16 @@
</span><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"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Fires after adding an item to the main BuddyPress navigation array.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Fires after the screen function for an item in the BuddyPress main
+ * navigation is registered.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since BuddyPress (1.5.0)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since BuddyPress (2.4.0)
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $r Parsed arguments for the nav item.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args Originally passed in arguments for the nav item.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $defaults Default arguments for a nav item.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- do_action( 'bp_core_new_nav_item', $r, $args, $defaults );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ do_action( 'bp_core_register_nav_screen_function', $r, $args, $defaults );
</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"> /**
</span></span></pre>
</div>
</div>
</body>
</html>