<!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][13586] trunk/src/bp-core/admin/bp-core-admin-functions.php: Add help tab content for URL settings screen.</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/13586">13586</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/13586","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>2023-09-28 02:18:35 +0000 (Thu, 28 Sep 2023)</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'>Add help tab content for URL settings screen.
Props imath.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/8958">#8958</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcoreadminbpcoreadminfunctionsphp">trunk/src/bp-core/admin/bp-core-admin-functions.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 2023-09-20 23:53:08 UTC (rev 13585)
+++ trunk/src/bp-core/admin/bp-core-admin-functions.php 2023-09-28 02:18:35 UTC (rev 13586)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -670,7 +670,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_core_add_contextual_help( $screen = '' ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $screen = get_current_screen();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $screen = get_current_screen();
+ $bp_forum = sprintf(
+ '<a href="%1$s">%2$s</a>',
+ esc_url( 'https://buddypress.org/support/' ),
+ esc_html__( 'Support Forums', 'buddypress' )
+ );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> switch ( $screen->id ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -685,14 +690,38 @@
</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">+ $manage_components = sprintf(
+ '<a href="%1$s">%2$s</a>',
+ esc_url( 'https://codex.buddypress.org/getting-started/configure-components/' ),
+ esc_html__( 'Managing Components', 'buddypress' )
+ );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Help panel - sidebar links.
</span><span class="cx" style="display: block; padding: 0 10px"> $screen->set_help_sidebar(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '<p><strong>' . __( 'For more information:', 'buddypress' ) . '</strong></p>' .
- '<p>' . __( '<a href="https://codex.buddypress.org/getting-started/configure-components/">Managing Components</a>', 'buddypress' ) . '</p>' .
- '<p>' . __( '<a href="https://buddypress.org/support/">Support Forums</a>', 'buddypress' ) . '</p>'
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '<p><strong>' . esc_html__( 'For more information:', 'buddypress' ) . '</strong></p>' .
+ '<p>' . $manage_components . '</p>' .
+ '<p>' . $bp_forum . '</p>'
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</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">+ // Component page.
+ case 'settings_page_bp-rewrites':
+ // Help tabs.
+ $screen->add_help_tab(
+ array(
+ 'id' => 'bp-rewrites-overview',
+ 'title' => esc_html__( 'Overview', 'buddypress' ),
+ 'content' => bp_core_add_contextual_help_content( 'bp-rewrites-overview' ),
+ )
+ );
+
+ // Help panel - sidebar links.
+ $screen->set_help_sidebar(
+ '<p><strong>' . esc_html__( 'For more information:', 'buddypress' ) . '</strong></p>' .
+ '<p>' . $bp_forum . '</p>'
+ );
+ break;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Settings page.
</span><span class="cx" style="display: block; padding: 0 10px"> case 'settings_page_bp-settings':
</span><span class="cx" style="display: block; padding: 0 10px"> // Help tabs.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -699,16 +728,22 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $screen->add_help_tab(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'id' => 'bp-settings-overview',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'title' => __( 'Overview', 'buddypress' ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'title' => esc_html__( 'Overview', 'buddypress' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'content' => bp_core_add_contextual_help_content( 'bp-settings-overview' ),
</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">+ $manage_settings = sprintf(
+ '<a href="%1$s">%2$s</a>',
+ esc_url( 'https://codex.buddypress.org/getting-started/configure-components/#settings-buddypress-settings' ),
+ esc_html__( 'Managing Settings', 'buddypress' )
+ );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Help panel - sidebar links.
</span><span class="cx" style="display: block; padding: 0 10px"> $screen->set_help_sidebar(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '<p><strong>' . __( 'For more information:', 'buddypress' ) . '</strong></p>' .
- '<p>' . __( '<a href="https://codex.buddypress.org/getting-started/configure-components/#settings-buddypress-settings">Managing Settings</a>', 'buddypress' ) . '</p>' .
- '<p>' . __( '<a href="https://buddypress.org/support/">Support Forums</a>', 'buddypress' ) . '</p>'
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '<p><strong>' . esc_html__( 'For more information:', 'buddypress' ) . '</strong></p>' .
+ '<p>' . $manage_settings . '</p>' .
+ '<p>' . $bp_forum . '</p>'
</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"> break;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -724,11 +759,17 @@
</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">+ $manage_profile_fields = sprintf(
+ '<a href="%1$s">%2$s</a>',
+ esc_url( 'https://codex.buddypress.org/administrator-guide/extended-profiles/' ),
+ esc_html__( 'Managing Profile Fields', 'buddypress' )
+ );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Help panel - sidebar links.
</span><span class="cx" style="display: block; padding: 0 10px"> $screen->set_help_sidebar(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '<p><strong>' . __( 'For more information:', 'buddypress' ) . '</strong></p>' .
- '<p>' . __( '<a href="https://codex.buddypress.org/administrator-guide/extended-profiles/">Managing Profile Fields</a>', 'buddypress' ) . '</p>' .
- '<p>' . __( '<a href="https://buddypress.org/support/">Support Forums</a>', 'buddypress' ) . '</p>'
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '<p><strong>' . esc_html__( 'For more information:', 'buddypress' ) . '</strong></p>' .
+ '<p>' . $manage_profile_fields . '</p>' .
+ '<p>' . $bp_forum . '</p>'
</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"> break;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -735,6 +776,7 @@
</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"> add_action( 'load-settings_page_bp-components', 'bp_core_add_contextual_help' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+add_action( 'load-settings_page_bp-rewrites', 'bp_core_add_contextual_help' );
</ins><span class="cx" style="display: block; padding: 0 10px"> add_action( 'load-settings_page_bp-settings', 'bp_core_add_contextual_help' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'load-users_page_bp-profile-setup', 'bp_core_add_contextual_help' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -761,6 +803,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-rewrites-overview':
+ $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' );
+ break;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> default:
</span><span class="cx" style="display: block; padding: 0 10px"> $retval = false;
</span><span class="cx" style="display: block; padding: 0 10px"> break;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -768,7 +814,13 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Wrap text in a paragraph tag.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $retval ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $retval = '<p>' . $retval . '</p>';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $allowed_tags = array(
+ 'br' => true,
+ 'code' => true,
+ 'strong' => true,
+ );
+
+ $retval = '<p>' . wp_kses( $retval, $allowed_tags ) . '</p>';
</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"> return $retval;
</span></span></pre>
</div>
</div>
</body>
</html>