<!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][13728] trunk/src/bp-core/admin: Improve the BP Site Health debug info panel</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/13728">13728</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/13728","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>2024-02-16 01:33:24 +0000 (Fri, 16 Feb 2024)</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 the BP Site Health debug info panel
- Make sure empty options are displaying their default values
- Add a an help tab for the BP Site Health debug info panel
- Make sure this panel is only generated for the root blog
- Improve the way the global community setting is handled
- Add a debug info about whether the current theme supports BuddyPress
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/9093">#9093</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcoreadminbpcoreadminfunctionsphp">trunk/src/bp-core/admin/bp-core-admin-functions.php</a></li>
<li><a href="#trunksrcbpcoreadminbpcoreadmintoolsphp">trunk/src/bp-core/admin/bp-core-admin-tools.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpcoreadminbpcoreadminfunctionsphp"></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-functions.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-functions.php 2024-02-15 04:06:30 UTC (rev 13727)
+++ trunk/src/bp-core/admin/bp-core-admin-functions.php 2024-02-16 01:33:24 UTC (rev 13728)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -822,6 +822,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $retval = __( 'Your users will distinguish themselves through their profile page. Create relevant profile fields that will show on each users profile.', 'buddypress' ) . '<br /><br />' . __( 'Note: Drag fields from other groups and drop them on the "Signup Fields" tab to include them into your registration form.', 'buddypress' );
</span><span class="cx" style="display: block; padding: 0 10px"> break;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ case 'bp-debug-settings':
+ $retval = __( 'Find all the details about your BuddyPress configuration opening the BuddyPress panel of your Site Health info accordion panels. If you need to ask for support, this information will help the BuddyPress community in giving you the right reply to your issue.', 'buddypress' );
+ break;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> case 'bp-rewrites-overview':
</span><span class="cx" style="display: block; padding: 0 10px"> $retval = __( 'Customize the page titles and URL slugs for the BuddyPress screens on your site.', 'buddypress' ) . '<br /><br />' . __( 'The <strong>title</strong> is the page title displayed above the BuddyPress content. For example, the page title "Members" is shown above the members directory.', 'buddypress' ) . '<br /><br />' . __( 'A <strong>slug</strong> is a portion of the URL itself. For instance, "members" is the members directory slug in the following example URL: <code>https://mysite.org/members</code>. Slugs should only include lowercase letters, numbers, and hyphens.', 'buddypress' );
</span><span class="cx" style="display: block; padding: 0 10px"> break;
</span></span></pre></div>
<a id="trunksrcbpcoreadminbpcoreadmintoolsphp"></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-tools.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-tools.php 2024-02-15 04:06:30 UTC (rev 13727)
+++ trunk/src/bp-core/admin/bp-core-admin-tools.php 2024-02-16 01:33:24 UTC (rev 13728)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -756,8 +756,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_core_admin_debug_information( $debug_info = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_settings_fields;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $active_components = array_intersect_key( bp_core_get_components(), buddypress()->active_components );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ if ( ! bp_is_root_blog() ) {
+ return $debug_info;
+ }
+
+ $active_components = wp_list_pluck( bp_core_get_active_components( array(), 'objects' ), 'name', 'id' );
</ins><span class="cx" style="display: block; padding: 0 10px"> $bp_settings = array();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $skipped_settings = array( '_bp_theme_package_id', '_bp_community_visibility' );
</ins><span class="cx" style="display: block; padding: 0 10px"> $bp_url_parsers = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'rewrites' => __( 'BP Rewrites API', 'buddypress' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'legacy' => __( 'Legacy Parser', 'buddypress' ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -771,13 +777,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $bp_url_parser = __( 'Custom', 'buddypress' );
</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">-
</del><span class="cx" style="display: block; padding: 0 10px"> foreach ( $wp_settings_fields['buddypress'] as $section => $settings ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $prefix = '';
</span><span class="cx" style="display: block; padding: 0 10px"> $component_id = str_replace( 'bp_', '', $section );
</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 ( isset( $active_components[ $component_id ]['title'] ) ) {
- $prefix = $active_components[ $component_id ]['title'] .': ';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( isset( $active_components[ $component_id ] ) ) {
+ $prefix = $active_components[ $component_id ] .': ';
</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"> foreach( $settings as $bp_setting ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -787,17 +792,31 @@
</span><span class="cx" style="display: block; padding: 0 10px"> strpos( $bp_setting['id'], 'disable' ) !== 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 ( ! isset( $bp_setting['id'] ) || '_bp_theme_package_id' === $bp_setting['id'] ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! isset( $bp_setting['id'] ) || in_array( $bp_setting['id'], $skipped_settings, true ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> continue;
</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">- $bp_setting_value = bp_get_option( $bp_setting['id'] );
- if ( '0' === $bp_setting_value || '1' === $bp_setting_value ) {
- if ( ( $reverse && '0' === $bp_setting_value ) || ( ! $reverse && '1' === $bp_setting_value ) ) {
- $bp_setting_value = __( 'Yes', 'buddypress' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $bp_setting_value = bp_get_option( $bp_setting['id'], 0 );
+
+ if ( is_array( $bp_setting_value ) ) {
+ if ( is_numeric( key( $bp_setting_value ) ) ) {
+ $bp_setting_value = implode( ', ', $bp_setting_value );
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $bp_setting_value = __( 'No', 'buddypress' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $setting_array = $bp_setting_value;
+ $bp_setting_value = array();
+ foreach ( $setting_array as $setting_array_key => $setting_array_value ) {
+ $bp_setting_value[ $setting_array_key ] = implode( ', ', $setting_array_value );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } else {
+ $bp_setting_value = (int) $bp_setting_value;
+ if ( 0 === $bp_setting_value || 1 === $bp_setting_value ) {
+ if ( ( $reverse && 0 === $bp_setting_value ) || ( ! $reverse && 1 === $bp_setting_value ) ) {
+ $bp_setting_value = __( 'Yes', 'buddypress' );
+ } else {
+ $bp_setting_value = __( 'No', 'buddypress' );
+ }
+ }
</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"> // Make sure to show the setting is reversed when site info is copied to clipboard.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -813,27 +832,41 @@
</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">+ $theme_settings = array();
+ if ( current_theme_supports( 'buddypress' ) ) {
+ $theme_settings['standalone_bptheme'] = array(
+ 'label' => __( 'BuddyPress standalone theme', 'buddypress' ),
+ 'value' => wp_get_theme()->get( 'Name' ),
+ );
+ } else {
+ $theme_settings['template_pack'] = array(
+ 'label' => __( 'Active template pack', 'buddypress' ),
+ 'value' => bp_get_theme_compat_name() . ' ' . bp_get_theme_compat_version(),
+ );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $debug_info['buddypress'] = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'label' => __( 'BuddyPress', 'buddypress' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'fields' => array_merge(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'version' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'version' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'label' => __( 'Version', 'buddypress' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'value' => bp_get_version(),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'active_components' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'active_components' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'label' => __( 'Active components', 'buddypress' ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'value' => implode( ', ', wp_list_pluck( $active_components, 'title' ) ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'value' => implode( ', ', $active_components ),
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'template_pack' => array(
- 'label' => __( 'Active template pack', 'buddypress' ),
- 'value' => bp_get_theme_compat_name() . ' ' . bp_get_theme_compat_version(),
- ),
- 'url_parser' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'url_parser' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'label' => __( 'URL Parser', 'buddypress' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'value' => $bp_url_parser,
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'global_community_visibility' => array(
+ 'label' => __( 'Community visibility', 'buddypress' ),
+ 'value' => bp_get_community_visibility( 'global' ),
+ ),
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $theme_settings,
</ins><span class="cx" style="display: block; padding: 0 10px"> $bp_settings
</span><span class="cx" style="display: block; padding: 0 10px"> )
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -841,3 +874,61 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $debug_info;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'debug_information', 'bp_core_admin_debug_information' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * Adds a BuddyPress section to the Site Health Info Admin Screen help tabs.
+ *
+ * @since 14.0.0
+ */
+function bp_core_admin_debug_information_add_help_tab() {
+ if ( ! bp_is_root_blog() ) {
+ return;
+ }
+
+ if ( isset( $_REQUEST['tab'] ) && 'debug' === sanitize_key( wp_unslash( $_REQUEST['tab'] ) ) ) {
+ $screen = get_current_screen();
+
+ $screen->add_help_tab(
+ array(
+ 'id' => 'bp-debug-settings',
+ 'title' => esc_html__( 'BuddyPress', 'buddypress' ),
+ 'content' => bp_core_add_contextual_help_content( 'bp-debug-settings' ),
+ )
+ );
+
+ $help_sidebar = $screen->get_help_sidebar();
+ $bp_links = sprintf(
+ '<p><a href="%1$s" class="bp-help-sidebar-links">%2$s</a></p>',
+ esc_url( 'https://buddypress.org/support/' ),
+ esc_html__( 'BuddyPress Support Forums', 'buddypress' )
+ );
+
+ $screen->set_help_sidebar( $help_sidebar . $bp_links );
+ wp_add_inline_script(
+ 'site-health',
+ '( function() {
+ let bpHelpSidebarLinks;
+
+ document.onreadystatechange = function() {
+ if ( document.readyState === "complete" ) {
+ bpHelpSidebarLinks = document.querySelector( \'.bp-help-sidebar-links\' ).closest( \'p\')
+ bpHelpSidebarLinks.style.display = \'none\';
+ }
+ }
+
+ document.querySelectorAll( \'.contextual-help-tabs ul li a\' ).forEach(
+ function( a ) {
+ a.addEventListener( \'click\', function( e ) {
+ if ( \'tab-link-bp-debug-settings\' === e.target.parentElement.getAttribute( \'id\' ) ) {
+ bpHelpSidebarLinks.style.display = \'block\';
+ } else {
+ bpHelpSidebarLinks.style.display = \'none\';
+ }
+ } );
+ }
+ );
+ } )();'
+ );
+ }
+}
+add_action( 'admin_head-site-health.php', 'bp_core_admin_debug_information_add_help_tab' );
</ins></span></pre>
</div>
</div>
</body>
</html>