]> scripts.mit.edu Git - autoinstalls/wordpress.git/blobdiff - wp-admin/includes/widgets.php
WordPress 4.3
[autoinstalls/wordpress.git] / wp-admin / includes / widgets.php
index 47dfec524064188035c55640526ecf762e96c3b3..36cf6449a8cc0ca76303d3276af9a1b57b6308f1 100644 (file)
@@ -7,20 +7,18 @@
  */
 
 /**
- * Display list of the available widgets, either all or matching search.
+ * Display list of the available widgets.
  *
- * The search parameter are search terms separated by spaces.
+ * @since 2.5.0
  *
- * @since unknown
- *
- * @param string $show Optional, default is all. What to display, can be 'all', 'unused', or 'used'.
- * @param string $_search Optional. Search for widgets. Should be unsanitized.
+ * @global array $wp_registered_widgets
+ * @global array $wp_registered_widget_controls
  */
 function wp_list_widgets() {
-       global $wp_registered_widgets, $sidebars_widgets, $wp_registered_widget_controls;
+       global $wp_registered_widgets, $wp_registered_widget_controls;
 
        $sort = $wp_registered_widgets;
-       usort( $sort, create_function( '$a, $b', 'return strnatcasecmp( $a["name"], $b["name"] );' ) );
+       usort( $sort, '_sort_name_callback' );
        $done = array();
 
        foreach ( $sort as $widget ) {
@@ -51,35 +49,64 @@ function wp_list_widgets() {
        }
 }
 
+/**
+ * Callback to sort array by a 'name' key.
+ *
+ * @since 3.1.0
+ * @access private
+ *
+ * @return int
+ */
+function _sort_name_callback( $a, $b ) {
+       return strnatcasecmp( $a['name'], $b['name'] );
+}
+
 /**
  * Show the widgets and their settings for a sidebar.
- * Used in the the admin widget config screen.
+ * Used in the admin widget config screen.
  *
- * @since unknown
+ * @since 2.5.0
  *
  * @param string $sidebar id slug of the sidebar
+ * @param string optional $sidebar_name Include the HTML for the sidebar name
  */
-function wp_list_widget_controls( $sidebar ) {
+function wp_list_widget_controls( $sidebar, $sidebar_name = '' ) {
        add_filter( 'dynamic_sidebar_params', 'wp_list_widget_controls_dynamic_sidebar' );
 
-       echo "<div id='$sidebar' class='widgets-sortables'>\n";
-
        $description = wp_sidebar_description( $sidebar );
 
-       if ( !empty( $description ) ) {
-               echo "<div class='sidebar-description'>\n";
-               echo "\t<p class='description'>$description</p>"; 
-               echo "</div>\n";
+       echo '<div id="' . esc_attr( $sidebar ) . '" class="widgets-sortables">';
+
+       if ( $sidebar_name ) {
+               ?>
+               <div class="sidebar-name">
+                       <div class="sidebar-name-arrow"><br /></div>
+                       <h3><?php echo esc_html( $sidebar_name ); ?> <span class="spinner"></span></h3>
+               </div>
+               <?php
+       }
+
+       echo '<div class="sidebar-description">';
+
+       if ( ! empty( $description ) ) {
+               echo '<p class="description">' . $description . '</p>';
        }
 
+       echo '</div>';
+
        dynamic_sidebar( $sidebar );
-       echo "</div>\n";
+
+       echo '</div>';
 }
 
 /**
  * {@internal Missing Short Description}}
  *
- * @since unknown
+ * @since 2.5.0
+ *
+ * @global array $wp_registered_widgets
+ *
+ * @staticvar int $i
  *
  * @param array $params
  * @return array
@@ -93,7 +120,7 @@ function wp_list_widget_controls_dynamic_sidebar( $params ) {
        $id = isset($params[0]['_temp_id']) ? $params[0]['_temp_id'] : $widget_id;
        $hidden = isset($params[0]['_hide']) ? ' style="display:none;"' : '';
 
-       $params[0]['before_widget'] = "<div id='widget-${i}_$id' class='widget'$hidden>";
+       $params[0]['before_widget'] = "<div id='widget-{$i}_{$id}' class='widget'$hidden>";
        $params[0]['after_widget'] = "</div>";
        $params[0]['before_title'] = "%BEG_OF_TITLE%"; // deprecated
        $params[0]['after_title'] = "%END_OF_TITLE%"; // deprecated
@@ -105,7 +132,14 @@ function wp_list_widget_controls_dynamic_sidebar( $params ) {
        return $params;
 }
 
-function next_widget_id_number($id_base) {
+/**
+ *
+ * @global array $wp_registered_widgets
+ *
+ * @param string $id_base
+ * @return int
+ */
+function next_widget_id_number( $id_base ) {
        global $wp_registered_widgets;
        $number = 1;
 
@@ -123,7 +157,11 @@ function next_widget_id_number($id_base) {
  *
  * Called from dynamic_sidebar().
  *
- * @since unknown
+ * @since 2.5.0
+ *
+ * @global array $wp_registered_widgets
+ * @global array $wp_registered_widget_controls
+ * @global array $sidebars_widgets
  *
  * @param array $sidebar_args
  * @return array
@@ -155,11 +193,14 @@ function wp_widget_control( $sidebar_args ) {
                $query_arg['key'] = $key;
        }
 
-       // We aren't showing a widget control, we're outputing a template for a mult-widget control
+       /*
+        * We aren't showing a widget control, we're outputting a template
+        * for a multi-widget control.
+        */
        if ( isset($sidebar_args['_display']) && 'template' == $sidebar_args['_display'] && $widget_number ) {
                // number == -1 implies a template where id numbers are replaced by a generic '__i__'
                $control['params'][0]['number'] = -1;
-               // with id_base widget id's are constructed like {$id_base}-{$id_number}
+               // With id_base widget id's are constructed like {$id_base}-{$id_number}.
                if ( isset($control['id_base']) )
                        $id_format = $control['id_base'] . '-__i__';
        }
@@ -174,13 +215,17 @@ function wp_widget_control( $sidebar_args ) {
        <div class="widget-top">
        <div class="widget-title-action">
                <a class="widget-action hide-if-no-js" href="#available-widgets"></a>
-               <a class="widget-control-edit hide-if-js" href="<?php echo esc_url( add_query_arg( $query_arg ) ); ?>"><span class="edit"><?php _e('Edit'); ?></span><span class="add"><?php _e('Add'); ?></span></a>
+               <a class="widget-control-edit hide-if-js" href="<?php echo esc_url( add_query_arg( $query_arg ) ); ?>">
+                       <span class="edit"><?php _ex( 'Edit', 'widget' ); ?></span>
+                       <span class="add"><?php _ex( 'Add', 'widget' ); ?></span>
+                       <span class="screen-reader-text"><?php echo $widget_title; ?></span>
+               </a>
        </div>
        <div class="widget-title"><h4><?php echo $widget_title ?><span class="in-widget-title"></span></h4></div>
        </div>
 
        <div class="widget-inside">
-       <form action="" method="post">
+       <form method="post">
        <div class="widget-content">
 <?php
        if ( isset($control['callback']) )
@@ -202,8 +247,8 @@ function wp_widget_control( $sidebar_args ) {
                <a class="widget-control-close" href="#close"><?php _e('Close'); ?></a>
                </div>
                <div class="alignright<?php if ( 'noform' === $has_form ) echo ' widget-control-noform'; ?>">
-               <img src="images/wpspin_light.gif" class="ajax-feedback " title="" alt="" />
-               <input type="submit" name="savewidget" class="button-primary widget-control-save" value="<?php esc_attr_e('Save'); ?>" />
+                       <?php submit_button( __( 'Save' ), 'button-primary widget-control-save right', 'savewidget', false, array( 'id' => 'widget-' . esc_attr( $id_format ) . '-savewidget' ) ); ?>
+                       <span class="spinner"></span>
                </div>
                <br class="clear" />
        </div>
@@ -215,6 +260,6 @@ function wp_widget_control( $sidebar_args ) {
        </div>
 <?php
        echo $sidebar_args['after_widget'];
+
        return $sidebar_args;
 }
-