Changeset 13586

Timestamp:

09/28/2023 02:18:35 AM (3 years ago)

Author:

dcavins

Message:

Add help tab content for URL settings screen.

Props imath.

Fixes #8958.

File:

• trunk/src/bp-core/admin/bp-core-admin-functions.php (modified) (7 diffs)

trunk/src/bp-core/admin/bp-core-admin-functions.php

@@ -671 +671 @@
 function bp_core_add_contextual_help( $screen = '' ) {
 
-        $screen = get_current_screen();
+        $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' )
+        );
 
         switch ( $screen->id ) {
@@ -686 +691 @@
                         );
 
+                        $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' )
+                        );
+
                         // Help panel - sidebar links.
                         $screen->set_help_sidebar(
-                                '<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>'
+                                '<p><strong>' . esc_html__( 'For more information:', 'buddypress' ) . '</strong></p>' .
+                                '<p>' . $manage_components . '</p>' .
+                                '<p>' . $bp_forum . '</p>'
+                        );
+                        break;
+
+                // 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;
@@ -700 +729 @@
                                 array(
                                         'id'      => 'bp-settings-overview',
-                                        'title'   => __( 'Overview', 'buddypress' ),
+                                        'title'   => esc_html__( 'Overview', 'buddypress' ),
                                         'content' => bp_core_add_contextual_help_content( 'bp-settings-overview' ),
                                 )
                         );
 
+                        $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' )
+                        );
+
                         // Help panel - sidebar links.
                         $screen->set_help_sidebar(
-                                '<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>'
+                                '<p><strong>' . esc_html__( 'For more information:', 'buddypress' ) . '</strong></p>' .
+                                '<p>' . $manage_settings . '</p>' .
+                                '<p>' . $bp_forum . '</p>'
                         );
 
@@ -725 +760 @@
                         );
 
+                        $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' )
+                        );
+
                         // Help panel - sidebar links.
                         $screen->set_help_sidebar(
-                                '<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>'
+                                '<p><strong>' . esc_html__( 'For more information:', 'buddypress' ) . '</strong></p>' .
+                                '<p>' . $manage_profile_fields . '</p>' .
+                                '<p>' . $bp_forum . '</p>'
                         );
 
@@ -736 +777 @@
 }
 add_action( 'load-settings_page_bp-components', 'bp_core_add_contextual_help' );
+add_action( 'load-settings_page_bp-rewrites', 'bp_core_add_contextual_help' );
 add_action( 'load-settings_page_bp-settings', 'bp_core_add_contextual_help' );
 add_action( 'load-users_page_bp-profile-setup', 'bp_core_add_contextual_help' );
@@ -762 +804 @@
                         break;
 
+                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;
+
                 default:
                         $retval = false;
@@ -769 +815 @@
         // Wrap text in a paragraph tag.
         if ( ! empty( $retval ) ) {
-                $retval = '<p>' . $retval . '</p>';
+                $allowed_tags = array(
+                        'br'     => true,
+                        'code'   => true,
+                        'strong' => true,
+                );
+
+                $retval = '<p>' . wp_kses( $retval, $allowed_tags ) . '</p>';
         }