WordPress.org

Plugin Directory

Changeset 553918


Ignore:
Timestamp:
06/06/12 15:48:52 (23 months ago)
Author:
cnorris23
Message:

Pre-release cleanup

File:
1 edited

Legend:

Unmodified
Added
Removed
  • edit-author-slug/trunk/includes/admin-functions.php

    r553318 r553918  
    2121 * 
    2222 * @param object $user User data object 
    23  * @uses current_user_can() To hide from unauthorized users. 
     23 * @uses ba_eas_can_edit_author_slug() To verify current user can edit the author slug 
     24 * @uses sanitize_title() To sanitize userdata into a new nicename 
     25 * @uses apply_filters() To call the 'ba_eas_show_user_nicename_options_list' hook 
    2426 * @uses esc_html_e() To make sure we're safe to display 
     27 * @uses esc_attr_e() To make sure we're safe to display 
     28 * @uses checked() To check that box 
    2529 */ 
    2630function ba_eas_show_user_nicename( $user ) { 
     
    3337        $nicename = $user->user_nicename; 
    3438 
     39    // Setup options array 
    3540    $options = array(); 
    3641    $options['username'] = sanitize_title( $user->user_login ); 
     
    4853    } 
    4954 
     55    // Allow custom options to be added, and prep for display 
    5056    $options = (array) apply_filters( 'ba_eas_show_user_nicename_options_list', $options ); 
    5157    $options = array_map( 'trim', $options ); 
    5258    $options = array_unique( $options ); 
    5359 
     60    // Set default for checked status 
    5461    $checked = true; 
    5562    ?> 
     
    7178                <label title="<?php esc_attr_e( $item ); ?>"><input type="radio" id="ba_eas_author_slug" name="ba_eas_author_slug" value="<?php esc_attr_e( $item ); ?>"<?php echo $checked_text; ?>> <span><?php esc_attr_e( $item ); ?></span></label><br> 
    7279                <?php } ?> 
    73                 <label title="<?php esc_attr_e( $nicename ); ?>"><input type="radio" id="ba_eas_author_slug_custom_radio" name="ba_eas_author_slug" value="\c\u\s\t\o\m"<?php checked( $checked ); ?>> <span><?php esc_html_e( 'Custom:', 'edit-author-slug' ); ?> </span></label> <input type="text" name="ba_eas_author_slug_custom" id="ba_eas_author_slug_custom" value="<?php ( isset( $user->user_nicename ) ) ? esc_attr_e( $user->user_nicename ) : ''; ?>" class="regular-text" /> 
     80                <label title="<?php esc_attr_e( $nicename ); ?>"><input type="radio" id="ba_eas_author_slug_custom_radio" name="ba_eas_author_slug" value="\c\u\s\t\o\m"<?php checked( $checked ); ?>> <span><?php esc_html_e( 'Custom:', 'edit-author-slug' ); ?> </span></label> <input type="text" name="ba_eas_author_slug_custom" id="ba_eas_author_slug_custom" value="<?php esc_attr_e( $nicename ); ?>" class="regular-text" /> 
    7481                </fieldset> 
    7582            </td> 
     
    9097 * 
    9198 * @global obj $wpdb 
     99 * @uses ba_eas_can_edit_author_slug() To verify current user can edit the author slug 
    92100 * @uses check_admin_referer() To verify the nonce and check referer 
    93  * @uses current_user_can() To prevent unauthorized users from saving. 
    94101 * @uses get_userdata() To get the user data 
    95102 * @uses sanitize_title() Used to sanitize user_nicename 
     103 * @uses remove_action() To remove the 'ba_eas_auto_update_user_nicename_single' and prevent looping 
    96104 * @uses wp_update_user() Update to new user_nicename 
    97105 * @uses wp_cache_delete() To delete the 'userslugs' cache for old nicename 
     
    102110    if ( !ba_eas_can_edit_author_slug() ) 
    103111        return false; 
    104  
    105     global $wpdb; 
    106112 
    107113    // We shouldn't be here if we're not updating 
     
    145151    // Maybe update the author slug? 
    146152    if ( $author_slug != $user->user_nicename ) { 
     153     
     154        // Add the wpdb global only when necessary 
     155        global $wpdb; 
    147156 
    148157        // Do we have an author slug? 
     
    193202 
    194203/** 
    195  * Can the current user edit the author slug? 
    196  * 
    197  * @since 0.8.0 
    198  * 
    199  * @uses is_super_admin() To check if super admin 
    200  * @uses current_user_can() To check for 'edit_users' and 'edit_author_slug' caps 
    201  * @uses apply_filters() To call 'ba_eas_can_edit_author_slug' hook 
    202  * 
    203  * @return bool True if edit privileges. Defaults to false. 
     204 * Determines if an auto-update should occur 
     205 * 
     206 * @since 0.9.0 
     207 * 
     208 * @uses get_option() To get the auto-update option 
     209 * @uses apply_filters() To call 'ba_eas_do_auto_update' hook 
     210 * 
     211 * @return bool True if auto-update enabled 
    204212 */ 
    205213function ba_eas_do_auto_update() { 
    206214 
    207     // Default to false 
    208     $retval = false; 
    209  
    210     $retval = (bool) get_option( '_ba_eas_do_auto_update', '0' ); 
    211  
    212     return apply_filters( 'ba_eas_do_auto_update', $retval ); 
     215    $retval = get_option( '_ba_eas_do_auto_update', '0' ); 
     216     
     217    if ( !is_numeric( $retval ) || 1 !== (int) $retval ) 
     218        $retval = false; 
     219 
     220    return apply_filters( 'ba_eas_do_auto_update', (bool) $retval ); 
    213221} 
    214222 
     
    221229 * @param bool $bulk Bulk upgrade flag. Defaults to false 
    222230 * 
     231 * @uses ba_eas_do_auto_update() Do we auto-update? 
    223232 * @uses get_userdata() To get the user object 
     233 * @uses apply_filters() To call the 'ba_eas_auto_update_user_nicename_structure' hook 
    224234 * @uses get_option() To get the default nicename structure 
    225  * @uses get_option() To get the default nicename structure 
    226  */ 
    227 function ba_eas_auto_update_user_nicename( $user, $bulk = false ) { 
     235 * @uses apply_filters() To call the 'ba_eas_pre_auto_update_user_nicename' hook 
     236 * @uses remove_action() To remove the 'ba_eas_auto_update_user_nicename_single' and prevent looping 
     237 * @uses wp_update_user() Update to new user_nicename 
     238 * @uses wp_cache_delete() To delete the 'userslugs' cache for old nicename 
     239 * 
     240 * @return int $user_id. False on failure 
     241 */ 
     242function ba_eas_auto_update_user_nicename( $user_id, $bulk = false ) { 
    228243    // Bail if there's no id or object 
    229     if ( empty( $user ) ) 
    230         return; 
     244    if ( empty( $user_id ) ) 
     245        return false; 
    231246 
    232247    if ( false === $bulk ) { 
    233248        // Should we auto-update 
    234249        if ( !ba_eas_do_auto_update() ) 
    235             return; 
    236  
    237         // Get WP_User object 
    238         $user = get_userdata( $user ); 
     250            return false; 
    239251    } 
     252 
     253    // Get WP_User object 
     254    $user = get_userdata( $user_id ); 
    240255 
    241256    // Double check we're still good 
    242257    if ( !is_object( $user ) || empty( $user ) ) 
    243         return; 
     258        return false; 
    244259 
    245260    // Setup the user_id 
     
    249264    // No user_id so bail 
    250265    else 
    251         return; 
     266        return false; 
    252267 
    253268    // Get the default nicename structure 
     
    341356 * @param int $user_id User id 
    342357 * 
    343  * @uses ba_eas_auto_update_user_nicename() To get the user object 
     358 * @uses ba_eas_auto_update_user_nicename() To auto-update the nicename 
    344359 */ 
    345360function ba_eas_auto_update_user_nicename_single( $user_id = 0 ) { 
     
    356371 * @param int $user_id User id 
    357372 * 
    358  * @uses ba_eas_auto_update_user_nicename() To get the user object 
    359  */ 
    360 function ba_eas_auto_update_user_nicename_bulk( $user = false ) { 
    361     ba_eas_auto_update_user_nicename( $user, true ); 
     373 * @uses ba_eas_auto_update_user_nicename() To auto-update the nicename 
     374 */ 
     375function ba_eas_auto_update_user_nicename_bulk( $user_id = 0 ) { 
     376    ba_eas_auto_update_user_nicename( $user_id, true ); 
    362377} 
    363378 
     
    371386 * 
    372387 * @param array $defaults Array of current columns/column headings 
     388 * 
    373389 * @uses esc_html__() To sanitize the author slug column title 
     390 * 
    374391 * @return array $defaults Array of current columns/column headings 
    375392 */ 
     
    391408 * @param string $column_name Column name currently being filtered 
    392409 * @param int $user_id User ID 
     410 * 
    393411 * @uses get_userdata() To get the user data 
    394412 * @uses esc_attr() To sanitize the user_nicename 
     413 * 
    395414 * @return string $default Value for column data. Defaults to ''. 
    396415 */ 
     
    605624?> 
    606625 
    607     <input name="_ba_eas_do_auto_update" id="_ba_eas_do_auto_update" value="1"<?php checked( $do_auto_update, '1' ); ?>type="checkbox"> 
     626    <input name="_ba_eas_do_auto_update" id="_ba_eas_do_auto_update" value="1"<?php checked( $do_auto_update, '1' ); ?> type="checkbox"> 
    608627    <label for="_ba_eas_do_auto_update">Automatically update Author Slug when a user updates their profile</label> 
    609628 
     
    649668} 
    650669 
    651 /** 
    652  * Output settings API option 
    653  * 
    654  * @since 0.9.0 
    655  * 
    656  * @uses ba_eas_get_form_option() 
    657  * 
    658  * @param string $option 
    659  * @param string $default 
    660  * @param bool $slug 
    661  */ 
    662 function ba_eas_form_option( $option, $default = '' , $slug = false ) { 
    663     echo ba_eas_get_form_option( $option, $default, $slug ); 
    664 } 
    665  
    666 /** 
    667  * Return settings API option 
    668  * 
    669  * @since 0.9.0 
    670  * 
    671  * @uses get_option() 
    672  * @uses esc_attr() 
    673  * @uses apply_filters() 
    674  * 
    675  * @param string $option 
    676  * @param string $default 
    677  * @param bool $slug 
    678  */ 
    679 function ba_eas_get_form_option( $option, $default = '', $slug = false ) { 
    680  
    681     // Get the option and sanitize it 
    682     $value = get_option( $option, $default ); 
    683  
    684     // Slug? 
    685     if ( true === $slug ) 
    686         $value = esc_attr( apply_filters( 'editable_slug', $value ) ); 
    687  
    688     // Not a slug 
    689     else 
    690         $value = esc_attr( $value ); 
    691  
    692     // Fallback to default 
    693     if ( empty( $value ) ) 
    694         $value = $default; 
    695  
    696     // Allow plugins to further filter the output 
    697     return apply_filters( 'ba_eas_get_form_option', $value, $option ); 
    698 } 
    699  
    700670/** Upgrade *******************************************************************/ 
    701671 
Note: See TracChangeset for help on using the changeset viewer.