Changeset 4281

Timestamp:

10/30/2012 11:43:17 PM (13 years ago)

Author:

johnjamesjacoby

Message:

Code Improvement:

• More politely cast arrays in settings sections and fields.
• Use esc_html() on some admin strings. See #1999.
• Clean up bbp_converter_setting_callback_platform().

Location:

trunk/includes/admin

Files:

• admin.php (modified) (4 diffs)
• settings.php (modified) (5 diffs)

trunk/includes/admin/admin.php

@@ -304 +304 @@
 
         // Bail if no sections available
-        if ( ! $sections = bbp_admin_get_settings_sections() )
+        $sections = bbp_admin_get_settings_sections();
+        if ( empty( $sections ) )
             return false;
 
         // Loop through sections
-        foreach ( $sections as $section_id => $section ) {
+        foreach ( (array) $sections as $section_id => $section ) {
 
             // Only proceed if current user can see this section
@@ -315 +316 @@
 
             // Only add section and fields if section has fields
-            if ( $fields = bbp_admin_get_settings_fields_for_section( $section_id ) ) {
-
-                // Add the section
-                add_settings_section( $section_id, $section['title'], $section['callback'], $section['page'] );
-
-                // Loop through fields for this section
-                foreach ( $fields as $field_id => $field ) {
-
-                    // Add the field
-                    add_settings_field( $field_id, $field['title'], $field['callback'], $section['page'], $section_id, $field['args'] );
-
-                    // Register the setting
-                    register_setting( $section['page'], $field_id, $field['sanitize_callback'] );
-                }
+            $fields = bbp_admin_get_settings_fields_for_section( $section_id );
+            if ( empty( $fields ) )
+                continue;
+
+            // Add the section
+            add_settings_section( $section_id, $section['title'], $section['callback'], $section['page'] );
+
+            // Loop through fields for this section
+            foreach ( (array) $fields as $field_id => $field ) {
+
+                // Add the field
+                add_settings_field( $field_id, $field['title'], $field['callback'], $section['page'], $section_id, $field['args'] );
+
+                // Register the setting
+                register_setting( $section['page'], $field_id, $field['sanitize_callback'] );
             }
         }
@@ -458 +460 @@
         // Add a few links to the existing links array
         return array_merge( $links, array(
-            'settings' => '<a href="' . add_query_arg( array( 'page' => 'bbpress'   ), admin_url( 'options-general.php' ) ) . '">' . __( 'Settings', 'bbpress' ) . '</a>',
-            'about'    => '<a href="' . add_query_arg( array( 'page' => 'bbp-about' ), admin_url( 'index.php'           ) ) . '">' . __( 'About',    'bbpress' ) . '</a>'
+            'settings' => '<a href="' . add_query_arg( array( 'page' => 'bbpress'   ), admin_url( 'options-general.php' ) ) . '">' . esc_html__( 'Settings', 'bbpress' ) . '</a>',
+            'about'    => '<a href="' . add_query_arg( array( 'page' => 'bbp-about' ), admin_url( 'index.php'           ) ) . '">' . esc_html__( 'About',    'bbpress' ) . '</a>'
         ) );
     }
@@ -1212 +1214 @@
      */
     public function register_admin_style () {
-        wp_admin_css_color( 'bbpress', __( 'Green', 'bbpress' ), $this->styles_url . 'admin.css', array( '#222222', '#006600', '#deece1', '#6eb469' ) );
+        wp_admin_css_color( 'bbpress', esc_html_x( 'Green', 'admin color scheme', 'bbpress' ), $this->styles_url . 'admin.css', array( '#222222', '#006600', '#deece1', '#6eb469' ) );
     }
 

trunk/includes/admin/settings.php

@@ -20 +20 @@
  */
 function bbp_admin_get_settings_sections() {
-    return apply_filters( 'bbp_admin_get_settings_sections', array(
+    return (array) apply_filters( 'bbp_admin_get_settings_sections', array(
         'bbp_settings_main' => array(
             'title'    => __( 'Main Settings', 'bbpress' ),
@@ -71 +71 @@
  */
 function bbp_admin_get_settings_fields() {
-    return apply_filters( 'bbp_admin_get_settings_fields', array(
+    return (array) apply_filters( 'bbp_admin_get_settings_fields', array(
 
         /** Main Section ******************************************************/
@@ -347 +347 @@
     $retval = isset( $fields[$section_id] ) ? $fields[$section_id] : false;
 
-    return apply_filters( 'bbp_admin_get_settings_fields_for_section', $retval, $section_id );
+    return (array) apply_filters( 'bbp_admin_get_settings_fields_for_section', $retval, $section_id );
 }
 
@@ -1008 +1008 @@
 
     $platform_options = array();
-
-    if ( $curdir = opendir( bbpress()->admin->admin_dir . 'converters/' ) ) {
-        while ( $file = readdir( $curdir ) ) {
-            if ( ( stristr( $file, '.php' ) ) && ( stristr( $file, 'index' ) === false ) ) {
-                $file = preg_replace( '/.php/', '', $file );
-                $platform_options .= '<option value="' . $file . '">' . $file . '</option>';
-            }
+    $curdir           = opendir( bbpress()->admin->admin_dir . 'converters/' );
+
+    // Bail if no directory was found (how did this happen?)
+    if ( empty( $curdir ) )
+        return;
+
+    // Loop through files in the converters folder and assemble some options
+    while ( $file = readdir( $curdir ) ) {
+        if ( ( stristr( $file, '.php' ) ) && ( stristr( $file, 'index' ) === false ) ) {
+            $file              = preg_replace( '/.php/', '', $file );
+            $platform_options .= '<option value="' . $file . '">' . $file . '</option>';
         }
-        closedir( $curdir );
-    } ?>
+    }
+
+    closedir( $curdir ); ?>
 
     <select name="_bbp_converter_platform" id="_bbp_converter_platform" /><?php echo $platform_options ?></select>
@@ -1338 +1343 @@
 
         // Slug?
-        if ( true === $slug )
+        if ( true === $slug ) {
             $value = esc_attr( apply_filters( 'editable_slug', $value ) );
 
         // Not a slug
-        else
+        } else {
             $value = esc_attr( $value );
+        }
 
         // Fallback to default