home *** CD-ROM | disk | FTP | other *** search
/ HTML Examples / WP.iso / wordpress / wp-admin / includes / widgets.php < prev   
Encoding:
PHP Script  |  2017-09-27  |  9.8 KB  |  291 lines
  1. <?php
  2. /**
  3.  * WordPress Widgets Administration API
  4.  *
  5.  * @package WordPress
  6.  * @subpackage Administration
  7.  */
  8.  
  9. /**
  10.  * Display list of the available widgets.
  11.  *
  12.  * @since 2.5.0
  13.  *
  14.  * @global array $wp_registered_widgets
  15.  * @global array $wp_registered_widget_controls
  16.  */
  17. function wp_list_widgets() {
  18.     global $wp_registered_widgets, $wp_registered_widget_controls;
  19.  
  20.     $sort = $wp_registered_widgets;
  21.     usort( $sort, '_sort_name_callback' );
  22.     $done = array();
  23.  
  24.     foreach ( $sort as $widget ) {
  25.         if ( in_array( $widget['callback'], $done, true ) ) // We already showed this multi-widget
  26.             continue;
  27.  
  28.         $sidebar = is_active_widget( $widget['callback'], $widget['id'], false, false );
  29.         $done[] = $widget['callback'];
  30.  
  31.         if ( ! isset( $widget['params'][0] ) )
  32.             $widget['params'][0] = array();
  33.  
  34.         $args = array( 'widget_id' => $widget['id'], 'widget_name' => $widget['name'], '_display' => 'template' );
  35.  
  36.         if ( isset($wp_registered_widget_controls[$widget['id']]['id_base']) && isset($widget['params'][0]['number']) ) {
  37.             $id_base = $wp_registered_widget_controls[$widget['id']]['id_base'];
  38.             $args['_temp_id'] = "$id_base-__i__";
  39.             $args['_multi_num'] = next_widget_id_number($id_base);
  40.             $args['_add'] = 'multi';
  41.         } else {
  42.             $args['_add'] = 'single';
  43.             if ( $sidebar )
  44.                 $args['_hide'] = '1';
  45.         }
  46.  
  47.         $args = wp_list_widget_controls_dynamic_sidebar( array( 0 => $args, 1 => $widget['params'][0] ) );
  48.         call_user_func_array( 'wp_widget_control', $args );
  49.     }
  50. }
  51.  
  52. /**
  53.  * Callback to sort array by a 'name' key.
  54.  *
  55.  * @since 3.1.0
  56.  * @access private
  57.  *
  58.  * @return int
  59.  */
  60. function _sort_name_callback( $a, $b ) {
  61.     return strnatcasecmp( $a['name'], $b['name'] );
  62. }
  63.  
  64. /**
  65.  * Show the widgets and their settings for a sidebar.
  66.  * Used in the admin widget config screen.
  67.  *
  68.  * @since 2.5.0
  69.  *
  70.  * @param string $sidebar      Sidebar ID.
  71.  * @param string $sidebar_name Optional. Sidebar name. Default empty.
  72.  */
  73. function wp_list_widget_controls( $sidebar, $sidebar_name = '' ) {
  74.     add_filter( 'dynamic_sidebar_params', 'wp_list_widget_controls_dynamic_sidebar' );
  75.  
  76.     $description = wp_sidebar_description( $sidebar );
  77.  
  78.     echo '<div id="' . esc_attr( $sidebar ) . '" class="widgets-sortables">';
  79.  
  80.     if ( $sidebar_name ) {
  81.         ?>
  82.         <div class="sidebar-name">
  83.             <button type="button" class="handlediv hide-if-no-js" aria-expanded="true">
  84.                 <span class="screen-reader-text"><?php echo esc_html( $sidebar_name ); ?></span>
  85.                 <span class="toggle-indicator" aria-hidden="true"></span>
  86.             </button>
  87.             <h2><?php echo esc_html( $sidebar_name ); ?> <span class="spinner"></span></h2>
  88.         </div>
  89.         <?php
  90.     }
  91.  
  92.     if ( ! empty( $description ) ) {
  93.         ?>
  94.         <div class="sidebar-description">
  95.             <p class="description"><?php echo $description; ?></p>
  96.         </div>
  97.         <?php
  98.     }
  99.  
  100.     dynamic_sidebar( $sidebar );
  101.  
  102.     echo '</div>';
  103. }
  104.  
  105. /**
  106.  * Retrieves the widget control arguments.
  107.  *
  108.  * @since 2.5.0
  109.  *
  110.  * @global array $wp_registered_widgets
  111.  *
  112.  * @staticvar int $i
  113.  *
  114.  * @param array $params
  115.  * @return array
  116.  */
  117. function wp_list_widget_controls_dynamic_sidebar( $params ) {
  118.     global $wp_registered_widgets;
  119.     static $i = 0;
  120.     $i++;
  121.  
  122.     $widget_id = $params[0]['widget_id'];
  123.     $id = isset($params[0]['_temp_id']) ? $params[0]['_temp_id'] : $widget_id;
  124.     $hidden = isset($params[0]['_hide']) ? ' style="display:none;"' : '';
  125.  
  126.     $params[0]['before_widget'] = "<div id='widget-{$i}_{$id}' class='widget'$hidden>";
  127.     $params[0]['after_widget'] = "</div>";
  128.     $params[0]['before_title'] = "%BEG_OF_TITLE%"; // deprecated
  129.     $params[0]['after_title'] = "%END_OF_TITLE%"; // deprecated
  130.     if ( is_callable( $wp_registered_widgets[$widget_id]['callback'] ) ) {
  131.         $wp_registered_widgets[$widget_id]['_callback'] = $wp_registered_widgets[$widget_id]['callback'];
  132.         $wp_registered_widgets[$widget_id]['callback'] = 'wp_widget_control';
  133.     }
  134.  
  135.     return $params;
  136. }
  137.  
  138. /**
  139.  *
  140.  * @global array $wp_registered_widgets
  141.  *
  142.  * @param string $id_base
  143.  * @return int
  144.  */
  145. function next_widget_id_number( $id_base ) {
  146.     global $wp_registered_widgets;
  147.     $number = 1;
  148.  
  149.     foreach ( $wp_registered_widgets as $widget_id => $widget ) {
  150.         if ( preg_match( '/' . $id_base . '-([0-9]+)$/', $widget_id, $matches ) )
  151.             $number = max($number, $matches[1]);
  152.     }
  153.     $number++;
  154.  
  155.     return $number;
  156. }
  157.  
  158. /**
  159.  * Meta widget used to display the control form for a widget.
  160.  *
  161.  * Called from dynamic_sidebar().
  162.  *
  163.  * @since 2.5.0
  164.  *
  165.  * @global array $wp_registered_widgets
  166.  * @global array $wp_registered_widget_controls
  167.  * @global array $sidebars_widgets
  168.  *
  169.  * @param array $sidebar_args
  170.  * @return array
  171.  */
  172. function wp_widget_control( $sidebar_args ) {
  173.     global $wp_registered_widgets, $wp_registered_widget_controls, $sidebars_widgets;
  174.  
  175.     $widget_id = $sidebar_args['widget_id'];
  176.     $sidebar_id = isset($sidebar_args['id']) ? $sidebar_args['id'] : false;
  177.     $key = $sidebar_id ? array_search( $widget_id, $sidebars_widgets[$sidebar_id] ) : '-1'; // position of widget in sidebar
  178.     $control = isset($wp_registered_widget_controls[$widget_id]) ? $wp_registered_widget_controls[$widget_id] : array();
  179.     $widget = $wp_registered_widgets[$widget_id];
  180.  
  181.     $id_format = $widget['id'];
  182.     $widget_number = isset($control['params'][0]['number']) ? $control['params'][0]['number'] : '';
  183.     $id_base = isset($control['id_base']) ? $control['id_base'] : $widget_id;
  184.     $multi_number = isset($sidebar_args['_multi_num']) ? $sidebar_args['_multi_num'] : '';
  185.     $add_new = isset($sidebar_args['_add']) ? $sidebar_args['_add'] : '';
  186.  
  187.     $before_form = isset( $sidebar_args['before_form'] ) ? $sidebar_args['before_form'] : '<form method="post">';
  188.     $after_form = isset( $sidebar_args['after_form'] ) ? $sidebar_args['after_form'] : '</form>';
  189.     $before_widget_content = isset( $sidebar_args['before_widget_content'] ) ? $sidebar_args['before_widget_content'] : '<div class="widget-content">';
  190.     $after_widget_content = isset( $sidebar_args['after_widget_content'] ) ? $sidebar_args['after_widget_content'] : '</div>';
  191.  
  192.     $query_arg = array( 'editwidget' => $widget['id'] );
  193.     if ( $add_new ) {
  194.         $query_arg['addnew'] = 1;
  195.         if ( $multi_number ) {
  196.             $query_arg['num'] = $multi_number;
  197.             $query_arg['base'] = $id_base;
  198.         }
  199.     } else {
  200.         $query_arg['sidebar'] = $sidebar_id;
  201.         $query_arg['key'] = $key;
  202.     }
  203.  
  204.     /*
  205.      * We aren't showing a widget control, we're outputting a template
  206.      * for a multi-widget control.
  207.      */
  208.     if ( isset($sidebar_args['_display']) && 'template' == $sidebar_args['_display'] && $widget_number ) {
  209.         // number == -1 implies a template where id numbers are replaced by a generic '__i__'
  210.         $control['params'][0]['number'] = -1;
  211.         // With id_base widget id's are constructed like {$id_base}-{$id_number}.
  212.         if ( isset($control['id_base']) )
  213.             $id_format = $control['id_base'] . '-__i__';
  214.     }
  215.  
  216.     $wp_registered_widgets[$widget_id]['callback'] = $wp_registered_widgets[$widget_id]['_callback'];
  217.     unset($wp_registered_widgets[$widget_id]['_callback']);
  218.  
  219.     $widget_title = esc_html( strip_tags( $sidebar_args['widget_name'] ) );
  220.     $has_form = 'noform';
  221.  
  222.     echo $sidebar_args['before_widget']; ?>
  223.     <div class="widget-top">
  224.     <div class="widget-title-action">
  225.         <button type="button" class="widget-action hide-if-no-js" aria-expanded="false">
  226.             <span class="screen-reader-text"><?php printf( __( 'Edit widget: %s' ), $widget_title ); ?></span>
  227.             <span class="toggle-indicator" aria-hidden="true"></span>
  228.         </button>
  229.         <a class="widget-control-edit hide-if-js" href="<?php echo esc_url( add_query_arg( $query_arg ) ); ?>">
  230.             <span class="edit"><?php _ex( 'Edit', 'widget' ); ?></span>
  231.             <span class="add"><?php _ex( 'Add', 'widget' ); ?></span>
  232.             <span class="screen-reader-text"><?php echo $widget_title; ?></span>
  233.         </a>
  234.     </div>
  235.     <div class="widget-title"><h3><?php echo $widget_title; ?><span class="in-widget-title"></span></h3></div>
  236.     </div>
  237.  
  238.     <div class="widget-inside">
  239.     <?php echo $before_form; ?>
  240.     <?php echo $before_widget_content; ?>
  241.     <?php
  242.     if ( isset( $control['callback'] ) ) {
  243.         $has_form = call_user_func_array( $control['callback'], $control['params'] );
  244.     } else {
  245.         echo "\t\t<p>" . __('There are no options for this widget.') . "</p>\n";
  246.     }
  247.     ?>
  248.     <?php echo $after_widget_content; ?>
  249.     <input type="hidden" name="widget-id" class="widget-id" value="<?php echo esc_attr($id_format); ?>" />
  250.     <input type="hidden" name="id_base" class="id_base" value="<?php echo esc_attr($id_base); ?>" />
  251.     <input type="hidden" name="widget-width" class="widget-width" value="<?php if (isset( $control['width'] )) echo esc_attr($control['width']); ?>" />
  252.     <input type="hidden" name="widget-height" class="widget-height" value="<?php if (isset( $control['height'] )) echo esc_attr($control['height']); ?>" />
  253.     <input type="hidden" name="widget_number" class="widget_number" value="<?php echo esc_attr($widget_number); ?>" />
  254.     <input type="hidden" name="multi_number" class="multi_number" value="<?php echo esc_attr($multi_number); ?>" />
  255.     <input type="hidden" name="add_new" class="add_new" value="<?php echo esc_attr($add_new); ?>" />
  256.  
  257.     <div class="widget-control-actions">
  258.         <div class="alignleft">
  259.             <button type="button" class="button-link button-link-delete widget-control-remove"><?php _e( 'Delete' ); ?></button>
  260.             <span class="widget-control-close-wrapper">
  261.                 |
  262.                 <button type="button" class="button-link widget-control-close"><?php _e( 'Done' ); ?></button>
  263.             </span>
  264.         </div>
  265.         <div class="alignright<?php if ( 'noform' === $has_form ) echo ' widget-control-noform'; ?>">
  266.             <?php submit_button( __( 'Save' ), 'primary widget-control-save right', 'savewidget', false, array( 'id' => 'widget-' . esc_attr( $id_format ) . '-savewidget' ) ); ?>
  267.             <span class="spinner"></span>
  268.         </div>
  269.         <br class="clear" />
  270.     </div>
  271.     <?php echo $after_form; ?>
  272.     </div>
  273.  
  274.     <div class="widget-description">
  275. <?php echo ( $widget_description = wp_widget_description($widget_id) ) ? "$widget_description\n" : "$widget_title\n"; ?>
  276.     </div>
  277. <?php
  278.     echo $sidebar_args['after_widget'];
  279.  
  280.     return $sidebar_args;
  281. }
  282.  
  283. /**
  284.  *
  285.  * @param string $classes
  286.  * @return string
  287.  */
  288. function wp_widgets_access_body_class($classes) {
  289.     return "$classes widgets_access ";
  290. }
  291.