widgets.php 9.8 KB

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