<!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][13123] trunk/src: Admin: improve information about WP pages being used as BP directories</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/13123">13123</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/13123","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>imath</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-10-09 18:10:51 +0000 (Sat, 09 Oct 2021)</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'>Admin: improve information about WP pages being used as BP directories
We are now using BuddyPress specific post states to inform a WordPress page is used as the BP Component's directory page. This information is displayed into the WP Admin Pages edit screen, for menu items linking to a BP Directory into the WP Admin Menu screen as well as into the Customizer Menu section.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/8470">#8470</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpactivityclassesclassbpactivitycomponentphp">trunk/src/bp-activity/classes/class-bp-activity-component.php</a></li>
<li><a href="#trunksrcbpblogsclassesclassbpblogscomponentphp">trunk/src/bp-blogs/classes/class-bp-blogs-component.php</a></li>
<li><a href="#trunksrcbpcoreadminbpcoreadminactionsphp">trunk/src/bp-core/admin/bp-core-admin-actions.php</a></li>
<li><a href="#trunksrcbpcoreclassesclassbpcomponentphp">trunk/src/bp-core/classes/class-bp-component.php</a></li>
<li><a href="#trunksrcbpgroupsclassesclassbpgroupscomponentphp">trunk/src/bp-groups/classes/class-bp-groups-component.php</a></li>
<li><a href="#trunksrcbpmembersclassesclassbpmemberscomponentphp">trunk/src/bp-members/classes/class-bp-members-component.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpactivityclassesclassbpactivitycomponentphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-activity/classes/class-bp-activity-component.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-activity/classes/class-bp-activity-component.php 2021-10-09 17:20:55 UTC (rev 13122)
+++ trunk/src/bp-activity/classes/class-bp-activity-component.php 2021-10-09 18:10:51 UTC (rev 13123)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -546,4 +546,23 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> parent::blocks_init( $blocks );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Add the Activity directory state.
+ *
+ * @since 10.0.0
+ *
+ * @param array $states Optional. See BP_Component::admin_directory_states() for description.
+ * @param WP_Post $post Optional. See BP_Component::admin_directory_states() for description.
+ * @return array See BP_Component::admin_directory_states() for description.
+ */
+ public function admin_directory_states( $states = array(), $post = null ) {
+ $bp = buddypress();
+
+ if ( isset( $bp->pages->activity->id ) && (int) $bp->pages->activity->id === (int) $post->ID ) {
+ $states['page_for_activity_directory'] = _x( 'BP Activity Page', 'page label', 'buddypress' );
+ }
+
+ return parent::admin_directory_states( $states, $post );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcbpblogsclassesclassbpblogscomponentphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-blogs/classes/class-bp-blogs-component.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-blogs/classes/class-bp-blogs-component.php 2021-10-09 17:20:55 UTC (rev 13122)
+++ trunk/src/bp-blogs/classes/class-bp-blogs-component.php 2021-10-09 18:10:51 UTC (rev 13123)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -432,4 +432,23 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> parent::blocks_init( $blocks );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Add the Sites directory states.
+ *
+ * @since 10.0.0
+ *
+ * @param array $states Optional. See BP_Component::admin_directory_states() for description.
+ * @param WP_Post $post Optional. See BP_Component::admin_directory_states() for description.
+ * @return array See BP_Component::admin_directory_states() for description.
+ */
+ public function admin_directory_states( $states = array(), $post = null ) {
+ $bp = buddypress();
+
+ if ( isset( $bp->pages->blogs->id ) && (int) $bp->pages->blogs->id === (int) $post->ID ) {
+ $states['page_for_sites_directory'] = _x( 'BP Sites Page', 'page label', 'buddypress' );
+ }
+
+ return parent::admin_directory_states( $states, $post );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcbpcoreadminbpcoreadminactionsphp"></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/admin/bp-core-admin-actions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/admin/bp-core-admin-actions.php 2021-10-09 17:20:55 UTC (rev 13122)
+++ trunk/src/bp-core/admin/bp-core-admin-actions.php 2021-10-09 18:10:51 UTC (rev 13123)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -59,6 +59,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Add a new separator.
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'bp_admin_menu', 'bp_admin_separator' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+// Add a filter to include BP Components directory pages display states.
+add_filter( 'display_post_states', 'bp_admin_display_directory_states', 10, 2 );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * When a new site is created in a multisite installation, run the activation
</span><span class="cx" style="display: block; padding: 0 10px"> * routine on that site.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -234,3 +237,33 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bp_register_admin_settings' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * Dedicated filter to inform about BP components directory page states.
+ *
+ * @since 10.0.0
+ *
+ * @param string[] $post_states An array of post display states.
+ * @param WP_Post $post The current post object.
+ */
+function bp_admin_display_directory_states( $post_states = array(), $post = null ) {
+ /**
+ * Filter here to add BP Directory pages.
+ *
+ * Used internaly by BP_Component->admin_directory_states(). Please use the dynamic
+ * filter in BP_Component->admin_directory_states() to edit the directory state
+ * according to the component's ID.
+ *
+ * @since 10.0.0
+ *
+ * @param array $value An empty array.
+ * @param WP_Post $post The current post object.
+ */
+ $directory_page_states = apply_filters( 'bp_admin_display_directory_states', array(), $post );
+
+ if ( $directory_page_states ) {
+ $post_states = array_merge( $post_states, $directory_page_states );
+ }
+
+ return $post_states;
+}
</ins></span></pre></div>
<a id="trunksrcbpcoreclassesclassbpcomponentphp"></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/classes/class-bp-component.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/classes/class-bp-component.php 2021-10-09 17:20:55 UTC (rev 13122)
+++ trunk/src/bp-core/classes/class-bp-component.php 2021-10-09 18:10:51 UTC (rev 13123)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -509,6 +509,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'bp_blocks_init', array( $this, 'blocks_init' ), 10 );
</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">+ // Set directory page states.
+ add_filter( 'bp_admin_display_directory_states', array( $this, 'admin_directory_states' ), 10, 2 );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Fires at the end of the setup_actions method inside BP_Component.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -987,5 +990,31 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bp_' . $this->id . '_blocks_init' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Add component's directory states.
+ *
+ * @since 10.0.0
+ *
+ * @param string[] $states An array of post display states.
+ * @param WP_Post $post The current post object.
+ * @return array The component's directory states.
+ */
+ public function admin_directory_states( $states = array(), $post = null ) {
+ if ( $this->has_directory ) {
+ /**
+ * Filter here to edit the component's directory states.
+ *
+ * This is a dynamic hook that is based on the component string ID.
+ *
+ * @since 10.0.0
+ *
+ * @param string[] $states An array of post display states.
+ */
+ return apply_filters( 'bp_' . $this->id . '_admin_directory_states', $states );
+ }
+
+ return $states;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> endif; // BP_Component.
</span></span></pre></div>
<a id="trunksrcbpgroupsclassesclassbpgroupscomponentphp"></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-groups-component.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-groups/classes/class-bp-groups-component.php 2021-10-09 17:20:55 UTC (rev 13122)
+++ trunk/src/bp-groups/classes/class-bp-groups-component.php 2021-10-09 18:10:51 UTC (rev 13123)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1134,4 +1134,23 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Add the Groups directory states.
+ *
+ * @since 10.0.0
+ *
+ * @param array $states Optional. See BP_Component::admin_directory_states() for description.
+ * @param WP_Post $post Optional. See BP_Component::admin_directory_states() for description.
+ * @return array See BP_Component::admin_directory_states() for description.
+ */
+ public function admin_directory_states( $states = array(), $post = null ) {
+ $bp = buddypress();
+
+ if ( isset( $bp->pages->groups->id ) && (int) $bp->pages->groups->id === (int) $post->ID ) {
+ $states['page_for_groups_directory'] = _x( 'BP Groups Page', 'page label', 'buddypress' );
+ }
+
+ return parent::admin_directory_states( $states, $post );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcbpmembersclassesclassbpmemberscomponentphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-members/classes/class-bp-members-component.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-members/classes/class-bp-members-component.php 2021-10-09 17:20:55 UTC (rev 13122)
+++ trunk/src/bp-members/classes/class-bp-members-component.php 2021-10-09 18:10:51 UTC (rev 13123)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -937,4 +937,33 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Add the Members directory states.
+ *
+ * @since 10.0.0
+ *
+ * @param array $states Optional. See BP_Component::admin_directory_states() for description.
+ * @param WP_Post $post Optional. See BP_Component::admin_directory_states() for description.
+ * @return array See BP_Component::admin_directory_states() for description.
+ */
+ public function admin_directory_states( $states = array(), $post = null ) {
+ $bp = buddypress();
+
+ if ( isset( $bp->pages->members->id ) && (int) $bp->pages->members->id === (int) $post->ID ) {
+ $states['page_for_members_directory'] = _x( 'BP Members Page', 'page label', 'buddypress' );
+ }
+
+ if ( bp_get_signup_allowed() || bp_get_members_invitations_allowed() ) {
+ if ( isset( $bp->pages->register->id ) && (int) $bp->pages->register->id === (int) $post->ID ) {
+ $states['page_for_bp_registration'] = _x( 'BP Registration Page', 'page label', 'buddypress' );
+ }
+
+ if ( isset( $bp->pages->activate->id ) && (int) $bp->pages->activate->id === (int) $post->ID ) {
+ $states['page_for_bp_activation'] = _x( 'BP Activation Page', 'page label', 'buddypress' );
+ }
+ }
+
+ return parent::admin_directory_states( $states, $post );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>