<!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][9997] trunk/src: Refactor bp_core_new_subnav_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/9997">9997</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/9997","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-05 17:36:58 +0000 (Sun, 05 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_subnav_item().
Use new functions `bp_core_create_subnav_link()`
and `bp_core_register_subnav_screen_function()`
within `bp_core_new_subnav_item()`.
Switch group extension usage to take advantage of new granularity.
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>
<li><a href="#trunksrcbpgroupsclassesclassbpgroupextensionphp">trunk/src/bp-groups/classes/class-bp-group-extension.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-05 16:57:22 UTC (rev 9996)
+++ trunk/src/bp-core/bp-core-buddybar.php 2015-07-05 17:36:58 UTC (rev 9997)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -265,6 +265,54 @@
</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_subnav_item( $args = '' ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // First, add the subnav item link to the bp_options_nav array.
+ $created = bp_core_create_subnav_link( $args );
+
+ // To mimic the existing behavior, if bp_core_create_subnav_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 subnav item.
+ bp_core_register_subnav_screen_function( $args );
+
+}
+
+/**
+ * Add a subnav link to the BuddyPress navigation.
+ *
+ * @param array $args {
+ * Array describing the new subnav item.
+ * @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.
+ * }
+ * @return bool|null Returns false on failure.
+ */
+function bp_core_create_subnav_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"> $r = wp_parse_args( $args, array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -318,12 +366,51 @@
</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"> $bp->bp_options_nav[$r['parent_slug']][$r['slug']] = $subnav_item;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+}
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * Register a screen function, whether or not a related subnav link exists.
+ *
+ * @param array $args {
+ * Array describing the new 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 $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.
+ * }
+ * @return bool|null Returns false on failure.
+ */
+function bp_core_register_subnav_screen_function( $args = '' ) {
+ $r = wp_parse_args( $args, array(
+ 'slug' => false, // URL slug for the screen
+ 'parent_slug' => false, // URL slug of the parent screen
+ 'user_has_access' => true, // Can the user visit this screen?
+ 'no_access_url' => '',
+ 'site_admin_only' => false, // Can only site admins visit this screen?
+ 'screen_function' => false, // The name of the function to run when clicked
+ ) );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The last step is to hook the screen function for the added subnav item. But this only
- * needs to be done if this subnav item is the current view, and the user has access to the
- * subnav item. We figure out whether we're currently viewing this subnav by checking the
- * following two conditions:
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Hook the screen function for the added subnav item. But this only needs to
+ * be done if this subnav item is the current view, and the user has access to the
+ * subnav item. We figure out whether we're currently viewing this subnav by
+ * checking the following two conditions:
</ins><span class="cx" style="display: block; padding: 0 10px"> * (1) Either:
</span><span class="cx" style="display: block; padding: 0 10px"> * (a) the parent slug matches the current_component, or
</span><span class="cx" style="display: block; padding: 0 10px"> * (b) the parent slug matches the current_item
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -344,8 +431,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // If we *do* meet condition (2), then the added subnav item is currently being requested
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ( bp_current_action() && bp_is_current_action( $r['slug'] ) ) || ( bp_is_user() && ! bp_current_action() && ( $r['screen_function'] == $bp->bp_nav[$parent_slug]['screen_function'] ) ) ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $hooked = bp_core_maybe_hook_new_subnav_screen_function( $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 subnav item
+ 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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $hooked = bp_core_maybe_hook_new_subnav_screen_function( $r );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // If redirect args have been returned, perform the redirect now
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $hooked['status'] ) && 'failure' === $hooked['status'] && isset( $hooked['redirect_args'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> bp_core_no_access( $hooked['redirect_args'] );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -366,8 +458,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'status' => '',
</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">+ // Is this accessible by site admins only?
+ $site_admin_restricted = false;
+ if ( ! empty( $subnav_item['site_admin_only'] ) && ! bp_current_user_can( 'bp_moderate' ) ) {
+ $site_admin_restricted = true;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // User has access, so let's try to hook the display callback
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! empty( $subnav_item['user_has_access'] ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! empty( $subnav_item['user_has_access'] ) && ! $site_admin_restricted ) {
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Screen function is invalid
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_callable( $subnav_item['screen_function'] ) ) {
</span></span></pre></div>
<a id="trunksrcbpgroupsclassesclassbpgroupextensionphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-groups/classes/class-bp-group-extension.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-groups/classes/class-bp-group-extension.php 2015-07-05 16:57:22 UTC (rev 9996)
+++ trunk/src/bp-groups/classes/class-bp-group-extension.php 2015-07-05 17:36:58 UTC (rev 9997)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -734,12 +734,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</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 the user can see the nav item, we create it.
</ins><span class="cx" style="display: block; padding: 0 10px"> $user_can_see_nav_item = $this->user_can_see_nav_item();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $user_can_see_nav_item ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $group_permalink = bp_get_group_permalink( groups_get_current_group() );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- bp_core_new_subnav_item( array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ bp_core_create_subnav_link( array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'name' => ! $this->nav_item_name ? $this->name : $this->nav_item_name,
</span><span class="cx" style="display: block; padding: 0 10px"> 'slug' => $this->slug,
</span><span class="cx" style="display: block; padding: 0 10px"> 'parent_slug' => bp_get_current_group_slug(),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -750,7 +751,22 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'user_has_access' => $user_can_see_nav_item,
</span><span class="cx" style="display: block; padding: 0 10px"> 'no_access_url' => $group_permalink,
</span><span class="cx" style="display: block; padding: 0 10px"> ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // If the user can visit the screen, we register it.
+ $user_can_visit = $this->user_can_visit();
+
+ if ( $user_can_visit ) {
+ $group_permalink = bp_get_group_permalink( groups_get_current_group() );
+
+ bp_core_register_subnav_screen_function( array(
+ 'slug' => $this->slug,
+ 'parent_slug' => bp_get_current_group_slug(),
+ 'screen_function' => array( &$this, '_display_hook' ),
+ 'user_has_access' => $user_can_visit,
+ 'no_access_url' => $group_permalink,
+ ) );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // When we are viewing the extension display page, set the title and options title
</span><span class="cx" style="display: block; padding: 0 10px"> if ( bp_is_current_action( $this->slug ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'bp_group_user_has_access', array( $this, 'group_access_protection' ), 10, 2 );
</span></span></pre>
</div>
</div>
</body>
</html>