widgets.php 11 KB

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