[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /**
   4   * bbPress Admin Tools Help
   5   *
   6   * @package bbPress
   7   * @subpackage Administration
   8   */
   9  
  10  // Exit if accessed directly
  11  defined( 'ABSPATH' ) || exit;
  12  
  13  /**
  14   * Contextual help for Repair Forums tools page
  15   *
  16   * @since 2.6.0 bbPress (r5314)
  17   */
  18  function bbp_admin_tools_repair_help() {
  19  
  20      $current_screen = get_current_screen();
  21  
  22      // Bail if current screen could not be found
  23      if ( empty( $current_screen ) ) {
  24          return;
  25      }
  26  
  27      // Repair Forums
  28      $current_screen->add_help_tab( array(
  29          'id'      => 'repair_forums',
  30          'title'   => __( 'Repair Forums', 'bbpress' ),
  31          'content' => '<p>' . __( 'There is more detailed information available on the bbPress and BuddyPress codex for the following:', 'bbpress' ) . '</p>' .
  32                       '<p>' .
  33                          '<ul>' .
  34                              '<li>' . __( 'BuddyPress Group Forums: <a href="https://codex.buddypress.org/getting-started/installing-group-and-sitewide-forums/">Installing Group and Sitewide Forums</a> and <a href="https://codex.buddypress.org/getting-started/guides/migrating-from-old-forums-to-bbpress-2/">Migrating from old forums to bbPress 2.2+</a>.', 'bbpress' ) . '</li>' .
  35                              '<li>' . __( 'bbPress roles: <a href="https://codex.bbpress.org/bbpress-user-roles-and-capabilities/" target="_blank">bbPress User Roles and Capabilities</a>',                                                                                                                                                                        'bbpress' ) . '</li>' .
  36                          '</ul>' .
  37                      '</p>' .
  38                      '<p>' . __( 'Also see <a href="https://codex.bbpress.org/repair-forums/">bbPress: Repair Forums</a>.', 'bbpress' ) . '</p>'
  39      ) );
  40  
  41      // Help Sidebar
  42      $current_screen->set_help_sidebar(
  43          '<p><strong>' . __( 'For more information:', 'bbpress' ) . '</strong></p>' .
  44          '<p>' . __( '<a href="https://codex.bbpress.org" target="_blank">bbPress Documentation</a>',    'bbpress' ) . '</p>' .
  45          '<p>' . __( '<a href="https://bbpress.org/forums/" target="_blank">bbPress Support Forums</a>', 'bbpress' ) . '</p>'
  46      );
  47  }
  48  
  49  /**
  50   * Contextual help for Reset Forums tools page
  51   *
  52   * @since 2.6.0 bbPress (r5314)
  53   */
  54  function bbp_admin_tools_reset_help() {
  55  
  56      $current_screen = get_current_screen();
  57  
  58      // Bail if current screen could not be found
  59      if ( empty( $current_screen ) ) {
  60          return;
  61      }
  62  
  63      // Reset Forums
  64      $current_screen->add_help_tab( array(
  65          'id'      => 'reset_forums',
  66          'title'   => __( 'Reset Forums', 'bbpress' ),
  67          'content' => '<p>' . __( 'Also see <a href="https://codex.bbpress.org/reset-forums/">bbPress: Reset Forums</a>.', 'bbpress' ) . '</p>'
  68      ) );
  69  
  70      // Help Sidebar
  71      $current_screen->set_help_sidebar(
  72          '<p><strong>' . __( 'For more information:', 'bbpress' ) . '</strong></p>' .
  73          '<p>' . __( '<a href="https://codex.bbpress.org" target="_blank">bbPress Documentation</a>',    'bbpress' ) . '</p>' .
  74          '<p>' . __( '<a href="https://bbpress.org/forums/" target="_blank">bbPress Support Forums</a>', 'bbpress' ) . '</p>'
  75      );
  76  }
  77  
  78  /**
  79   * Contextual help for Import Forums tools page
  80   *
  81   * @since 2.6.0 bbPress (r5314)
  82   */
  83  function bbp_admin_tools_converter_help() {
  84  
  85      $current_screen = get_current_screen();
  86  
  87      // Bail if current screen could not be found
  88      if ( empty( $current_screen ) ) {
  89          return;
  90      }
  91  
  92      // Overview
  93      $current_screen->add_help_tab( array(
  94          'id'      => 'overview',
  95          'title'   => __( 'Overview', 'bbpress' ),
  96          'content' => '<p>' . __( 'This screen provides access to all of the bbPress Import Forums settings and resources.',                                      'bbpress' ) . '</p>' .
  97                       '<p>' . __( 'Please see the additional help tabs for more information on each individual section.',                                         'bbpress' ) . '</p>' .
  98                       '<p>' . __( 'Also see the main article on the bbPress codex <a href="https://codex.bbpress.org/import-forums/">bbPress: Import Forums</a>.', 'bbpress' ) . '</p>'
  99      ) );
 100  
 101      // Database Settings
 102      $current_screen->add_help_tab( array(
 103          'id'      => 'database_settings',
 104          'title'   => __( 'Database Settings', 'bbpress' ),
 105          'content' => '<p>' . __( 'In the Database Settings you have a number of options:', 'bbpress' ) . '</p>' .
 106                       '<p>' .
 107                          '<ul>' .
 108                              '<li>' . __( 'The settings in this section refer to the database connection strings used by your old forum software. The best way to determine the exact settings you need is to copy them from your legacy forums configuration file or contact your web hosting provider.', 'bbpress' ) . '</li>' .
 109                          '</ul>' .
 110                      '</p>'
 111      ) );
 112  
 113      // Importer Options
 114      $current_screen->add_help_tab( array(
 115          'id'      => 'importer_options',
 116          'title'   => __( 'Importer Options', 'bbpress' ),
 117          'content' => '<p>' . __( 'In the Options you have a number of options:', 'bbpress' ) . '</p>' .
 118                       '<p>' .
 119                          '<ul>' .
 120                              '<li>' . __( 'Depending on your MySQL configuration you can tweak the "Rows Limit" and "Delay Time" that may help to improve the overall time it takes to perform a complete forum import.', 'bbpress' ) . '</li>' .
 121                              '<li>' . __( '"Convert Users" will import your legacy forum members as WordPress Users.',                                                                                                    'bbpress' ) . '</li>' .
 122                              '<li>' . __( '"Start Over" will start the importer fresh, if your import failed for any reason leaving this setting unchecked the importer will begin from where it left off.',              'bbpress' ) . '</li>' .
 123                              '<li>' . __( '"Purge Previous Import" will remove data imported from a failed import without removing your existing forum data.',                                                            'bbpress' ) . '</li>' .
 124                          '</ul>' .
 125                      '</p>'
 126      ) );
 127  
 128      // Help Sidebar
 129      $current_screen->set_help_sidebar(
 130          '<p><strong>' . __( 'For more information:', 'bbpress' ) . '</strong></p>' .
 131          '<p>' . __( '<a href="https://codex.bbpress.org" target="_blank">bbPress Documentation</a>',    'bbpress' ) . '</p>' .
 132          '<p>' . __( '<a href="https://bbpress.org/forums/" target="_blank">bbPress Support Forums</a>', 'bbpress' ) . '</p>'
 133      );
 134  }