Skip to:
Content

bbPress.org

Changeset 6176


Ignore:
Timestamp:
12/18/2016 03:47:16 PM (4 years ago)
Author:
johnjamesjacoby
Message:

Tools: Massize clean-up

  • Add missing function documentation blocks
  • Rename _migrate_ function to _upgrade_
  • More typo fixes
  • Make overhead values clickable in list table rows
  • Refactor overhead to work more like components, using keys instead of literal strings

See #2959.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/includes/admin/tools.php

    r6175 r6176  
    111111                                    <div class="bbp-tool-overhead">
    112112
    113                                         <?php echo esc_html( $item['overhead'] ); ?>
     113                                        <?php echo implode( ', ', bbp_get_admin_repair_tool_overhead( $item ) ); ?>
    114114
    115115                                    </div>
    … …  
    448448        'callback'    => '',
    449449        'priority'    => 0,
    450         'overhead'    => esc_html__( 'Low', 'bbpress' ),
     450        'overhead'    => 'low',
    451451        'components'  => array(),
    452452
    … …  
    488488        'callback'    => 'bbp_admin_repair_topic_meta',
    489489        'priority'    => 5,
    490         'overhead'    => esc_html__( 'Low', 'bbpress' ),
     490        'overhead'    => 'low',
    491491        'components'  => array( bbp_get_reply_post_type() )
    492492    ) );
    … …  
    498498        'callback'    => 'bbp_admin_repair_forum_meta',
    499499        'priority'    => 10,
    500         'overhead'    => esc_html__( 'Low', 'bbpress' ),
     500        'overhead'    => 'low',
    501501        'components'  => array( bbp_get_topic_post_type(), bbp_get_reply_post_type() )
    502502    ) );
    … …  
    508508        'callback'    => 'bbp_admin_repair_forum_visibility',
    509509        'priority'    => 15,
    510         'overhead'    => esc_html__( 'Low', 'bbpress' ),
     510        'overhead'    => 'low',
    511511        'components'  => array( bbp_get_forum_post_type() )
    512512    ) );
    … …  
    518518        'callback'    => 'bbp_admin_repair_freshness',
    519519        'priority'    => 20,
    520         'overhead'    => esc_html__( 'High', 'bbpress' ),
     520        'overhead'    => 'high',
    521521        'components'  => array( bbp_get_forum_post_type(), bbp_get_topic_post_type(), bbp_get_reply_post_type() )
    522522    ) );
    … …  
    528528        'callback'    => 'bbp_admin_repair_sticky',
    529529        'priority'    => 25,
    530         'overhead'    => esc_html__( 'Low', 'bbpress' ),
     530        'overhead'    => 'low',
    531531        'components'  => array( bbp_get_topic_post_type() )
    532532    ) );
    … …  
    538538        'callback'    => 'bbp_admin_repair_reply_menu_order',
    539539        'priority'    => 30,
    540         'overhead'    => esc_html__( 'High', 'bbpress' ),
     540        'overhead'    => 'high',
    541541        'components'  => array( bbp_get_reply_post_type() )
    542542    ) );
    … …  
    548548        'callback'    => 'bbp_admin_repair_group_forum_relationship',
    549549        'priority'    => 35,
    550         'overhead'    => esc_html__( 'Low', 'bbpress' ),
     550        'overhead'    => 'low',
    551551        'components'  => array( bbp_get_forum_post_type() )
    552552    ) );
    … …  
    558558        'callback'    => 'bbp_admin_repair_closed_topics',
    559559        'priority'    => 40,
    560         'overhead'    => esc_html__( 'Medium', 'bbpress' ),
     560        'overhead'    => 'medium',
    561561        'components'  => array( bbp_get_topic_post_type() )
    562562    ) );
    … …  
    568568        'callback'    => 'bbp_admin_repair_forum_topic_count',
    569569        'priority'    => 45,
    570         'overhead'    => esc_html__( 'Medium', 'bbpress' ),
     570        'overhead'    => 'medium',
    571571        'components'  => array( bbp_get_forum_post_type(), bbp_get_topic_post_type() )
    572572    ) );
    … …  
    578578        'callback'    => 'bbp_admin_repair_forum_reply_count',
    579579        'priority'    => 50,
    580         'overhead'    => esc_html__( 'High', 'bbpress' ),
     580        'overhead'    => 'high',
    581581        'components'  => array( bbp_get_forum_post_type(), bbp_get_reply_post_type() )
    582582    ) );
    … …  
    588588        'callback'    => 'bbp_admin_repair_topic_reply_count',
    589589        'priority'    => 55,
    590         'overhead'    => esc_html__( 'High', 'bbpress' ),
     590        'overhead'    => 'high',
    591591        'components'  => array( bbp_get_topic_post_type(), bbp_get_reply_post_type() )
    592592    ) );
    … …  
    598598        'callback'    => 'bbp_admin_repair_topic_voice_count',
    599599        'priority'    => 60,
    600         'overhead'    => esc_html__( 'Medium', 'bbpress' ),
     600        'overhead'    => 'medium',
    601601        'components'  => array( bbp_get_topic_post_type(), bbp_get_user_rewrite_id() )
    602602    ) );
    … …  
    608608        'callback'    => 'bbp_admin_repair_topic_hidden_reply_count',
    609609        'priority'    => 65,
    610         'overhead'    => esc_html__( 'High', 'bbpress' ),
     610        'overhead'    => 'high',
    611611        'components'  => array( bbp_get_topic_post_type(), bbp_get_reply_post_type() )
    612612    ) );
    … …  
    618618        'callback'    => 'bbp_admin_repair_user_topic_count',
    619619        'priority'    => 70,
    620         'overhead'    => esc_html__( 'Medium', 'bbpress' ),
     620        'overhead'    => 'medium',
    621621        'components'  => array( bbp_get_topic_post_type(), bbp_get_user_rewrite_id() )
    622622    ) );
    … …  
    628628        'callback'    => 'bbp_admin_repair_user_reply_count',
    629629        'priority'    => 75,
    630         'overhead'    => esc_html__( 'Medium', 'bbpress' ),
     630        'overhead'    => 'medium',
    631631        'components'  => array( bbp_get_reply_post_type(), bbp_get_user_rewrite_id() )
    632632    ) );
    … …  
    638638        'callback'    => 'bbp_admin_repair_user_favorites',
    639639        'priority'    => 80,
    640         'overhead'    => esc_html__( 'Medium', 'bbpress' ),
     640        'overhead'    => 'medium',
    641641        'components'  => array( bbp_get_topic_post_type(), bbp_get_user_rewrite_id() )
    642642    ) );
    … …  
    648648        'callback'    => 'bbp_admin_repair_user_topic_subscriptions',
    649649        'priority'    => 85,
    650         'overhead'    => esc_html__( 'Medium', 'bbpress' ),
     650        'overhead'    => 'medium',
    651651        'components'  => array( bbp_get_topic_post_type(), bbp_get_user_rewrite_id() )
    652652    ) );
    … …  
    658658        'callback'    => 'bbp_admin_repair_user_forum_subscriptions',
    659659        'priority'    => 90,
    660         'overhead'    => esc_html__( 'Medium', 'bbpress' ),
     660        'overhead'    => 'medium',
    661661        'components'  => array( bbp_get_forum_post_type(), bbp_get_user_rewrite_id() )
    662662    ) );
    … …  
    668668        'callback'    => 'bbp_admin_repair_user_roles',
    669669        'priority'    => 95,
    670         'overhead'    => esc_html__( 'Low', 'bbpress' ),
     670        'overhead'    => 'low',
    671671        'components'  => array( bbp_get_user_rewrite_id() )
    672672    ) );
    … …  
    676676        'id'          => 'bbp-user-favorites-move',
    677677        'description' => __( 'Upgrade user favorites', 'bbpress' ),
    678         'callback'    => 'bbp_admin_migrate_user_favorites',
     678        'callback'    => 'bbp_admin_upgrade_user_favorites',
    679679        'priority'    => 100,
    680         'overhead'    => esc_html__( 'High', 'bbpress' ),
     680        'overhead'    => 'high',
    681681        'components'  => array( bbp_get_user_rewrite_id() )
    682682    ) );
    … …  
    686686        'id'          => 'bbp-user-subscriptions-move',
    687687        'description' => __( 'Upgrade user subscriptions', 'bbpress' ),
    688         'callback'    => 'bbp_admin_migrate_user_subscriptions',
     688        'callback'    => 'bbp_admin_upgrade_user_subscriptions',
    689689        'priority'    => 105,
    690         'overhead'    => esc_html__( 'High', 'bbpress' ),
     690        'overhead'    => 'high',
    691691        'components'  => array( bbp_get_user_rewrite_id() )
    692692    ) );
    … …  
    744744}
    745745
     746/**
     747 * Output a select drop-down of components to filter by
     748 *
     749 * @since 2.5.0 bbPress (r5885)
     750 */
    746751function bbp_admin_repair_list_components_filter() {
    747752
     753    // Sanitize component value, if exists
    748754    $selected = ! empty( $_GET['components'] )
    749755        ? sanitize_key( $_GET['components'] )
    750756        : '';
    751757
     758    // Get registered components
    752759    $components = bbp_get_admin_repair_tool_registered_components(); ?>
    753760
    … …  
    766773
    767774    <?php
     775}
     776
     777/**
     778 * Maybe translate a repair tool overhead name
     779 *
     780 * @since 2.6.0 bbPress (r6177)
     781 *
     782 * @param string $overhead
     783 * @return string
     784 */
     785function bbp_admin_repair_tool_translate_overhead( $overhead = '' ) {
     786
     787    // Get the name of the component
     788    switch ( $overhead ) {
     789        case 'low' :
     790            $name = esc_html__( 'Low', 'bbpress' );
     791            break;
     792        case 'medium' :
     793            $name = esc_html__( 'Medium', 'bbpress' );
     794            break;
     795        case 'high' :
     796            $name = esc_html__( 'High', 'bbpress' );
     797            break;
     798        default :
     799            $name = ucwords( $overhead );
     800            break;
     801    }
     802
     803    return $name;
    768804}
    769805
    … …  
    792828            $name = esc_html__( 'Replies', 'bbpress' );
    793829            break;
    794         default;
     830        default :
    795831            $name = ucwords( $component );
    796832            break;
    … …  
    821857    // Overhead filter
    822858    if ( ! empty( $overhead ) ) {
    823         $list = wp_list_filter( $list, array( 'overhead' => ucwords( $overhead ) ) );
     859        $list = wp_list_filter( $list, array( 'overhead' => $overhead ) );
    824860    }
    825861
    … …  
    858894
    859895/**
    860  * Get filter links for components for a specific admir repair tool
     896 * Get filter links for components for a specific admin repair tool
    861897 *
    862898 * @since 2.6.0 bbPress (r5885)
    … …  
    884920    return apply_filters( 'bbp_get_admin_repair_tool_components', $links, $item );
    885921}
    886 //
     922
     923/**
     924 * Output filter links for components for a specific admin repair tool
     925 *
     926 * @since 2.6.0 bbPress (r5885)
     927 *
     928 * @param type array
     929 */
    887930function bbp_admin_repair_tool_overhead_filters( $args = array() ) {
    888931    echo bbp_get_admin_repair_tool_overhead_filters( $args );
    … …  
    890933
    891934/**
    892  * Get filter links for components for a specific admir repair tool
     935 * Get filter links for overhead for a specific admin repair tool
     936 *
     937 * @since 2.6.0 bbPress (r5885)
     938 *
     939 * @param array $item
     940 * @return array
     941 */
     942function bbp_get_admin_repair_tool_overhead( $item = array() ) {
     943
     944    // Get the tools URL
     945    $tools_url = add_query_arg( array( 'page' => 'bbp-repair' ), admin_url( 'tools.php' ) );
     946
     947    // Define links array
     948    $links     = array();
     949    $overheads = array( $item['overhead'] );
     950
     951    // Loop through tool overhead and build links
     952    foreach ( $overheads as $overhead ) {
     953        $args       = array( 'overhead' => $overhead );
     954        $filter_url = add_query_arg( $args, $tools_url );
     955        $name       = bbp_admin_repair_tool_translate_overhead( $overhead );
     956        $links[]    = '<a href="' . esc_url( $filter_url ) . '">' . esc_html( $name ) . '</a>';
     957    }
     958
     959    // Filter & return
     960    return apply_filters( 'bbp_get_admin_repair_tool_overhead', $links, $item );
     961}
     962
     963/**
     964 * Get filter links for components for a specific admin repair tool
    893965 *
    894966 * @since 2.6.0 bbPress (r5885)
    … …  
    9621034
    9631035        // Build the link
    964         $output .= $r['link_before'] . '<a href="' . esc_url( $filter_url ) . '" class="' . esc_attr( $current ) . '">' . $overhead . $overhead_count . '</a>' . $show_sep . $r['link_after'];
     1036        $output .= $r['link_before'] . '<a href="' . esc_url( $filter_url ) . '" class="' . esc_attr( $current ) . '">' . bbp_admin_repair_tool_translate_overhead( $overhead ) . $overhead_count . '</a>' . $show_sep . $r['link_after'];
    9651037    }
    9661038
    … …  
    16831755        // Get users of this site, limited to 1000
    16841756        while ( $users = get_users( array(
    1685                 'role'   => $role,
    1686                 'fields' => 'ID',
    1687                 'number' => 1000,
    1688                 'offset' => $offset
    1689             ) ) ) {
     1757            'role'   => $role,
     1758            'fields' => 'ID',
     1759            'number' => 1000,
     1760            'offset' => $offset
     1761        ) ) ) {
    16901762
    16911763            // Iterate through each user of $role and try to set it
    … …  
    21492221 * @return array An array of the status code and the message
    21502222 */
    2151 function bbp_admin_migrate_user_favorites() {
     2223function bbp_admin_upgrade_user_favorites() {
    21522224
    21532225    // Define variables
    … …  
    22052277 * @return array An array of the status code and the message
    22062278 */
    2207 function bbp_admin_migrate_user_subscriptions() {
     2279function bbp_admin_upgrade_user_subscriptions() {
    22082280
    22092281    // Define variables
Note: See TracChangeset for help on using the changeset viewer.