Changeset 16061 for trunk/wp-admin/includes/template.php

Timestamp:

10/28/2010 09:56:43 PM (14 years ago)

Author:

markjaquith

Message:

Expand submit_button() capabilities. Replace all (or almost all) manual HTML instances in WP. props sbressler. see #15064

File:

• trunk/wp-admin/includes/template.php (modified) (9 diffs)

trunk/wp-admin/includes/template.php

@@ -496 +496 @@
     $r .= "\n\t\t<td class='left'><label class='screen-reader-text' for='meta[{$entry['meta_id']}][key]'>" . __( 'Key' ) . "</label><input name='meta[{$entry['meta_id']}][key]' id='meta[{$entry['meta_id']}][key]' tabindex='6' type='text' size='20' value='{$entry['meta_key']}' />";
 
-    $r .= "\n\t\t<div class='submit'><input name='deletemeta[{$entry['meta_id']}]' type='submit' ";
-    $r .= "class='delete:the-list:meta-{$entry['meta_id']}::_ajax_nonce=$delete_nonce deletemeta' tabindex='6' value='". esc_attr__( 'Delete' ) ."' />";
-    $r .= "\n\t\t<input name='updatemeta' type='submit' tabindex='6' value='". esc_attr__( 'Update' ) ."' class='add:the-list:meta-{$entry['meta_id']}::_ajax_nonce-add-meta=$update_nonce updatemeta' /></div>";
+    $r .= "\n\t\t<div class='submit'>";
+    $r .= get_submit_button( __( 'Delete' ), "delete:the-list:meta-{$entry['meta_id']}::_ajax_nonce=$delete_nonce deletemeta", "deletemeta[{$entry['meta_id']}]", false, array( 'tabindex' => '6' ) );
+    $r .= "\n\t\t";
+    $r .= get_submit_button( __( 'Update' ), "add:the-list:meta-{$entry['meta_id']}::_ajax_nonce-add-meta=$update_nonce updatemeta" , 'updatemeta', false, array( 'tabindex' => '6' ) );
+    $r .= "</div>";
     $r .= wp_nonce_field( 'change-meta', '_ajax_nonce', false, false );
     $r .= "</td>";
@@ -558 +560 @@
 
 <tr><td colspan="2" class="submit">
-<input type="submit" id="addmetasub" name="addmeta" class="add:the-list:newmeta" tabindex="9" value="<?php esc_attr_e( 'Add Custom Field' ) ?>" />
+<?php submit_button( __( 'Add Custom Field' ), 'add:the-list:newmeta', 'addmeta', false, array( 'id' => 'addmetasub', 'tabindex' => '9' ) ); ?>
 <?php wp_nonce_field( 'add-meta', '_ajax_nonce-add-meta', false ); ?>
 </td></tr>
@@ -844 +846 @@
 <input type="hidden" name="max_file_size" value="<?php echo $bytes; ?>" />
 </p>
-<?php submit_button( __('Upload file and import'), 'secondary' ); ?>
+<?php submit_button( __('Upload file and import'), 'button' ); ?>
 </form>
 <?php
@@ -1358 +1360 @@
         <div class="find-box-buttons">
             <input id="find-posts-close" type="button" class="button alignleft" value="<?php esc_attr_e('Close'); ?>" />
-            <input id="find-posts-submit" type="submit" class="button-primary alignright" value="<?php esc_attr_e('Select'); ?>" />
+            <?php submit_button( __( 'Select' ), 'button-primary alignright', 'find-posts-submit', false ); ?>
         </div>
     </div>
@@ -1890 +1892 @@
     if ( !empty($per_page_label) )
         $return .= "<input type='text' class='screen-per-page' name='wp_screen_options[value]' id='$option' maxlength='3' value='$per_page' /> <label for='$option'>$per_page_label</label>\n";
-    $return .= "<input type='submit' class='button' value='" . esc_attr__('Apply') . "' />";
+    $return .= get_submit_button( __( 'Apply' ), 'button', '', false );
     $return .= "<input type='hidden' name='wp_screen_options[option]' value='" . esc_attr($option) . "' />";
     $return .= "</div>\n";
@@ -2087 +2089 @@
 
 /**
- * Echos a paragraph-wrapped submit button, with provided text and appropriate class
+ * Echos a submit button, with provided text and appropriate class
  *
  * @since 3.1.0
@@ -2093 +2095 @@
  * @param string $text The text of the button (defaults to 'Save Changes')
  * @param string $type The type of button. One of: primary, secondary, delete
- * @param string $name The HTML name of the submit button. Defaults to "submit"
- */
-function submit_button( $text = NULL, $type = 'primary', $name = 'submit' ) {
-    echo get_submit_button( $text, $type, $name );
-}
-
-/**
- * Returns a paragraph-wrapped submit button, with provided text and appropriate class
+ * @param string $name The HTML name of the submit button. Defaults to "submit". If no id attribute
+ *               is given in $other_attributes below, $name will be used as the button's id.
+ * @param bool $wrap True if the output button should be wrapped in a paragraph tag,
+ *             false otherwise. Defaults to true
+ * @param array|string $other_attributes Other attributes that should be output with the button,
+ *                     mapping attributes to their values, such as array( 'tabindex' => '1' ).
+ *                     These attributes will be ouput as attribute="value", such as tabindex="1".
+ *                     Defaults to no other attributes. Other attributes can also be provided as a
+ *                     string such as 'tabindex="1"', though the array format is typically cleaner.
+ */
+function submit_button( $text = NULL, $type = 'primary', $name = 'submit', $wrap = true, $other_attributes = NULL ) {
+    echo get_submit_button( $text, $type, $name, $wrap, $other_attributes );
+}
+
+/**
+ * Returns a submit button, with provided text and appropriate class
  *
  * @since 3.1.0
@@ -2106 +2116 @@
  * @param string $text The text of the button (defaults to 'Save Changes')
  * @param string $type The type of button. One of: primary, secondary, delete
- * @param string $name The HTML name of the submit button. Defaults to "submit"
- */
-function get_submit_button( $text = NULL, $type = 'primary', $name = 'submit' ) {
+ * @param string $name The HTML name of the submit button. Defaults to "submit". If no id attribute
+ *               is given in $other_attributes below, $name will be used as the button's id.
+ * @param bool $wrap True if the output button should be wrapped in a paragraph tag,
+ *             false otherwise. Defaults to true
+ * @param array|string $other_attributes Other attributes that should be output with the button,
+ *                     mapping attributes to their values, such as array( 'tabindex' => '1' ).
+ *                     These attributes will be ouput as attribute="value", such as tabindex="1".
+ *                     Defaults to no other attributes. Other attributes can also be provided as a
+ *                     string such as 'tabindex="1"', though the array format is typically cleaner.
+ */
+function get_submit_button( $text = NULL, $type = 'primary', $name = 'submit', $wrap = true, $other_attributes = NULL ) {
     switch ( $type ) :
         case 'primary' :
@@ -2121 +2139 @@
     endswitch;
     $text = ( NULL == $text ) ? __( 'Save Changes' ) : $text;
-    return '<p class="submit"><input type="submit" name="' . esc_attr( $name ) . '" class="' . esc_attr( $class ) . '" value="' . esc_attr( $text ) . '" /></p>';
-}
-
+    
+    $attributes = '';
+    if ( is_array( $other_attributes ) ) {
+        foreach ( $other_attributes as $attribute => $value ) {
+            $attributes .= $attribute . '="' . esc_attr( $value ) . '" '; // Trailing space is important
+        }
+    } else if ( !empty( $other_attributes ) ) { // Attributes provided as a string
+        $attributes = $other_attributes;
+    }
+    
+    // Default the id attribute to $name unless an id was specifically provided in $other_attributes
+    $id = 'id="' . esc_attr( $name ) . '" ';
+    if ( is_array( $other_attributes ) && array_key_exists( 'id', $other_attributes ) ) {
+        $id = 'id="' . esc_attr( $other_attributes['id'] ) . '" ';
+    }
+    
+    $button = '<input type="submit" name="' . esc_attr( $name ) . '" id="' . $id . '" class="' . esc_attr( $class );
+    $button .= '" value="' . esc_attr( $text ) . '" ' . $attributes . ' />';
+    
+    if ( $wrap ) {
+        $button = '<p class="submit">' . $button . '</p>';
+    }
+    
+    return $button;
+}
+