wp-admin/widgets.php

   1 <?php
   2 /**
   3  * Widgets administration panel.
   4  *
   5  * @package WordPress
   6  * @subpackage Administration
   7  */
   8
   9 /** WordPress Administration Bootstrap */
  10 require_once( dirname( __FILE__ ) . '/admin.php' );
  11
  12 /** WordPress Administration Widgets API */
  13 require_once(ABSPATH . 'wp-admin/includes/widgets.php');
  14
  15 if ( ! current_user_can('edit_theme_options') )
  16         wp_die( __( 'Cheatin&#8217; uh?' ));
  17
  18 $widgets_access = get_user_setting( 'widgets_access' );
  19 if ( isset($_GET['widgets-access']) ) {
  20         $widgets_access = 'on' == $_GET['widgets-access'] ? 'on' : 'off';
  21         set_user_setting( 'widgets_access', $widgets_access );
  22 }
  23
  24 function wp_widgets_access_body_class($classes) {
  25         return "$classes widgets_access ";
  26 }
  27
  28 if ( 'on' == $widgets_access ) {
  29         add_filter( 'admin_body_class', 'wp_widgets_access_body_class' );
  30 } else {
  31         wp_enqueue_script('admin-widgets');
  32
  33         if ( wp_is_mobile() )
  34                 wp_enqueue_script( 'jquery-touch-punch' );
  35 }
  36
  37 /**
  38  * Fires early before the Widgets administration screen loads,
  39  * after scripts are enqueued.
  40  *
  41  * @since 2.2.0
  42  */
  43 do_action( 'sidebar_admin_setup' );
  44
  45 $title = __( 'Widgets' );
  46 $parent_file = 'themes.php';
  47
  48 get_current_screen()->add_help_tab( array(
  49 'id'            => 'overview',
  50 'title'         => __('Overview'),
  51 'content'       =>
  52         '<p>' . __('Widgets are independent sections of content that can be placed into any widgetized area provided by your theme (commonly called sidebars). To populate your sidebars/widget areas with individual widgets, drag and drop the title bars into the desired area. By default, only the first widget area is expanded. To populate additional widget areas, click on their title bars to expand them.') . '</p>
  53         <p>' . __('The Available Widgets section contains all the widgets you can choose from. Once you drag a widget into a sidebar, it will open to allow you to configure its settings. When you are happy with the widget settings, click the Save button and the widget will go live on your site. If you click Delete, it will remove the widget.') . '</p>'
  54 ) );
  55 get_current_screen()->add_help_tab( array(
  56 'id'            => 'removing-reusing',
  57 'title'         => __('Removing and Reusing'),
  58 'content'       =>
  59         '<p>' . __('If you want to remove the widget but save its setting for possible future use, just drag it into the Inactive Widgets area. You can add them back anytime from there. This is especially helpful when you switch to a theme with fewer or different widget areas.') . '</p>
  60         <p>' . __('Widgets may be used multiple times. You can give each widget a title, to display on your site, but it&#8217;s not required.') . '</p>
  61         <p>' . __('Enabling Accessibility Mode, via Screen Options, allows you to use Add and Edit buttons instead of using drag and drop.') . '</p>'
  62 ) );
  63 get_current_screen()->add_help_tab( array(
  64 'id'            => 'missing-widgets',
  65 'title'         => __('Missing Widgets'),
  66 'content'       =>
  67         '<p>' . __('Many themes show some sidebar widgets by default until you edit your sidebars, but they are not automatically displayed in your sidebar management tool. After you make your first widget change, you can re-add the default widgets by adding them from the Available Widgets area.') . '</p>' .
  68                 '<p>' . __('When changing themes, there is often some variation in the number and setup of widget areas/sidebars and sometimes these conflicts make the transition a bit less smooth. If you changed themes and seem to be missing widgets, scroll down on this screen to the Inactive Widgets area, where all of your widgets and their settings will have been saved.') . '</p>'
  69 ) );
  70
  71 get_current_screen()->set_help_sidebar(
  72         '<p><strong>' . __('For more information:') . '</strong></p>' .
  73         '<p>' . __('<a href="http://codex.wordpress.org/Appearance_Widgets_Screen" target="_blank">Documentation on Widgets</a>') . '</p>' .
  74         '<p>' . __('<a href="https://wordpress.org/support/" target="_blank">Support Forums</a>') . '</p>'
  75 );
  76
  77 if ( ! current_theme_supports( 'widgets' ) ) {
  78         wp_die( __( 'The theme you are currently using isn&#8217;t widget-aware, meaning that it has no sidebars that you are able to change. For information on making your theme widget-aware, please <a href="http://codex.wordpress.org/Widgetizing_Themes">follow these instructions</a>.' ) );
  79 }
  80
  81 // These are the widgets grouped by sidebar
  82 $sidebars_widgets = wp_get_sidebars_widgets();
  83
  84 if ( empty( $sidebars_widgets ) )
  85         $sidebars_widgets = wp_get_widget_defaults();
  86
  87 foreach ( $sidebars_widgets as $sidebar_id => $widgets ) {
  88         if ( 'wp_inactive_widgets' == $sidebar_id )
  89                 continue;
  90
  91         if ( !isset( $wp_registered_sidebars[ $sidebar_id ] ) ) {
  92                 if ( ! empty( $widgets ) ) { // register the inactive_widgets area as sidebar
  93                         register_sidebar(array(
  94                                 'name' => __( 'Inactive Sidebar (not used)' ),
  95                                 'id' => $sidebar_id,
  96                                 'class' => 'inactive-sidebar orphan-sidebar',
  97                                 'description' => __( 'This sidebar is no longer available and does not show anywhere on your site. Remove each of the widgets below to fully remove this inactive sidebar.' ),
  98                                 'before_widget' => '',
  99                                 'after_widget' => '',
 100                                 'before_title' => '',
 101                                 'after_title' => '',
 102                         ));
 103                 } else {
 104                         unset( $sidebars_widgets[ $sidebar_id ] );
 105                 }
 106         }
 107 }
 108
 109 // register the inactive_widgets area as sidebar
 110 register_sidebar(array(
 111         'name' => __('Inactive Widgets'),
 112         'id' => 'wp_inactive_widgets',
 113         'class' => 'inactive-sidebar',
 114         'description' => __( 'Drag widgets here to remove them from the sidebar but keep their settings.' ),
 115         'before_widget' => '',
 116         'after_widget' => '',
 117         'before_title' => '',
 118         'after_title' => '',
 119 ));
 120
 121 retrieve_widgets();
 122
 123 // We're saving a widget without js
 124 if ( isset($_POST['savewidget']) || isset($_POST['removewidget']) ) {
 125         $widget_id = $_POST['widget-id'];
 126         check_admin_referer("save-delete-widget-$widget_id");
 127
 128         $number = isset($_POST['multi_number']) ? (int) $_POST['multi_number'] : '';
 129         if ( $number ) {
 130                 foreach ( $_POST as $key => $val ) {
 131                         if ( is_array($val) && preg_match('/__i__|%i%/', key($val)) ) {
 132                                 $_POST[$key] = array( $number => array_shift($val) );
 133                                 break;
 134                         }
 135                 }
 136         }
 137
 138         $sidebar_id = $_POST['sidebar'];
 139         $position = isset($_POST[$sidebar_id . '_position']) ? (int) $_POST[$sidebar_id . '_position'] - 1 : 0;
 140
 141         $id_base = $_POST['id_base'];
 142         $sidebar = isset($sidebars_widgets[$sidebar_id]) ? $sidebars_widgets[$sidebar_id] : array();
 143
 144         // Delete.
 145         if ( isset($_POST['removewidget']) && $_POST['removewidget'] ) {
 146
 147                 if ( !in_array($widget_id, $sidebar, true) ) {
 148                         wp_redirect( admin_url('widgets.php?error=0') );
 149                         exit;
 150                 }
 151
 152                 $sidebar = array_diff( $sidebar, array($widget_id) );
 153                 $_POST = array('sidebar' => $sidebar_id, 'widget-' . $id_base => array(), 'the-widget-id' => $widget_id, 'delete_widget' => '1');
 154         }
 155
 156         $_POST['widget-id'] = $sidebar;
 157
 158         foreach ( (array) $wp_registered_widget_updates as $name => $control ) {
 159                 if ( $name != $id_base || !is_callable($control['callback']) )
 160                         continue;
 161
 162                 ob_start();
 163                         call_user_func_array( $control['callback'], $control['params'] );
 164                 ob_end_clean();
 165
 166                 break;
 167         }
 168
 169         $sidebars_widgets[$sidebar_id] = $sidebar;
 170
 171         // Remove old position.
 172         if ( !isset($_POST['delete_widget']) ) {
 173                 foreach ( $sidebars_widgets as $key => $sb ) {
 174                         if ( is_array($sb) )
 175                                 $sidebars_widgets[$key] = array_diff( $sb, array($widget_id) );
 176                 }
 177                 array_splice( $sidebars_widgets[$sidebar_id], $position, 0, $widget_id );
 178         }
 179
 180         wp_set_sidebars_widgets($sidebars_widgets);
 181         wp_redirect( admin_url('widgets.php?message=0') );
 182         exit;
 183 }
 184
 185 // Output the widget form without js
 186 if ( isset($_GET['editwidget']) && $_GET['editwidget'] ) {
 187         $widget_id = $_GET['editwidget'];
 188
 189         if ( isset($_GET['addnew']) ) {
 190                 // Default to the first sidebar
 191                 $keys = array_keys( $wp_registered_sidebars );
 192                 $sidebar = array_shift( $keys );
 193
 194                 if ( isset($_GET['base']) && isset($_GET['num']) ) { // multi-widget
 195                         // Copy minimal info from an existing instance of this widget to a new instance
 196                         foreach ( $wp_registered_widget_controls as $control ) {
 197                                 if ( $_GET['base'] === $control['id_base'] ) {
 198                                         $control_callback = $control['callback'];
 199                                         $multi_number = (int) $_GET['num'];
 200                                         $control['params'][0]['number'] = -1;
 201                                         $widget_id = $control['id'] = $control['id_base'] . '-' . $multi_number;
 202                                         $wp_registered_widget_controls[$control['id']] = $control;
 203                                         break;
 204                                 }
 205                         }
 206                 }
 207         }
 208
 209         if ( isset($wp_registered_widget_controls[$widget_id]) && !isset($control) ) {
 210                 $control = $wp_registered_widget_controls[$widget_id];
 211                 $control_callback = $control['callback'];
 212         } elseif ( !isset($wp_registered_widget_controls[$widget_id]) && isset($wp_registered_widgets[$widget_id]) ) {
 213                 $name = esc_html( strip_tags($wp_registered_widgets[$widget_id]['name']) );
 214         }
 215
 216         if ( !isset($name) )
 217                 $name = esc_html( strip_tags($control['name']) );
 218
 219         if ( !isset($sidebar) )
 220                 $sidebar = isset($_GET['sidebar']) ? $_GET['sidebar'] : 'wp_inactive_widgets';
 221
 222         if ( !isset($multi_number) )
 223                 $multi_number = isset($control['params'][0]['number']) ? $control['params'][0]['number'] : '';
 224
 225         $id_base = isset($control['id_base']) ? $control['id_base'] : $control['id'];
 226
 227         // Show the widget form.
 228         $width = ' style="width:' . max($control['width'], 350) . 'px"';
 229         $key = isset($_GET['key']) ? (int) $_GET['key'] : 0;
 230
 231         require_once( ABSPATH . 'wp-admin/admin-header.php' ); ?>
 232         <div class="wrap">
 233         <h2><?php echo esc_html( $title ); ?></h2>
 234         <div class="editwidget"<?php echo $width; ?>>
 235         <h3><?php printf( __( 'Widget %s' ), $name ); ?></h3>
 236
 237         <form action="widgets.php" method="post">
 238         <div class="widget-inside">
 239 <?php
 240         if ( is_callable( $control_callback ) )
 241                 call_user_func_array( $control_callback, $control['params'] );
 242         else
 243                 echo '<p>' . __('There are no options for this widget.') . "</p>\n"; ?>
 244         </div>
 245
 246         <p class="describe"><?php _e('Select both the sidebar for this widget and the position of the widget in that sidebar.'); ?></p>
 247         <div class="widget-position">
 248         <table class="widefat"><thead><tr><th><?php _e('Sidebar'); ?></th><th><?php _e('Position'); ?></th></tr></thead><tbody>
 249 <?php
 250         foreach ( $wp_registered_sidebars as $sbname => $sbvalue ) {
 251                 echo "\t\t<tr><td><label><input type='radio' name='sidebar' value='" . esc_attr($sbname) . "'" . checked( $sbname, $sidebar, false ) . " /> $sbvalue[name]</label></td><td>";
 252                 if ( 'wp_inactive_widgets' == $sbname || 'orphaned_widgets' == substr( $sbname, 0, 16 ) ) {
 253                         echo '&nbsp;';
 254                 } else {
 255                         if ( !isset($sidebars_widgets[$sbname]) || !is_array($sidebars_widgets[$sbname]) ) {
 256                                 $j = 1;
 257                                 $sidebars_widgets[$sbname] = array();
 258                         } else {
 259                                 $j = count($sidebars_widgets[$sbname]);
 260                                 if ( isset($_GET['addnew']) || !in_array($widget_id, $sidebars_widgets[$sbname], true) )
 261                                         $j++;
 262                         }
 263                         $selected = '';
 264                         echo "\t\t<select name='{$sbname}_position'>\n";
 265                         echo "\t\t<option value=''>" . __('&mdash; Select &mdash;') . "</option>\n";
 266                         for ( $i = 1; $i <= $j; $i++ ) {
 267                                 if ( in_array($widget_id, $sidebars_widgets[$sbname], true) )
 268                                         $selected = selected( $i, $key + 1, false );
 269                                 echo "\t\t<option value='$i'$selected> $i </option>\n";
 270                         }
 271                         echo "\t\t</select>\n";
 272                 }
 273                 echo "</td></tr>\n";
 274         } ?>
 275         </tbody></table>
 276         </div>
 277
 278         <div class="widget-control-actions">
 279 <?php
 280         if ( isset($_GET['addnew']) ) { ?>
 281         <a href="widgets.php" class="button alignleft"><?php _e('Cancel'); ?></a>
 282 <?php
 283         } else {
 284                 submit_button( __( 'Delete' ), 'button alignleft', 'removewidget', false );
 285         }
 286         submit_button( __( 'Save Widget' ), 'button-primary alignright', 'savewidget', false ); ?>
 287         <input type="hidden" name="widget-id" class="widget-id" value="<?php echo esc_attr($widget_id); ?>" />
 288         <input type="hidden" name="id_base" class="id_base" value="<?php echo esc_attr($id_base); ?>" />
 289         <input type="hidden" name="multi_number" class="multi_number" value="<?php echo esc_attr($multi_number); ?>" />
 290 <?php   wp_nonce_field("save-delete-widget-$widget_id"); ?>
 291         <br class="clear" />
 292         </div>
 293         </form>
 294         </div>
 295         </div>
 296 <?php
 297         require_once( ABSPATH . 'wp-admin/admin-footer.php' );
 298         exit;
 299 }
 300
 301 $messages = array(
 302         __('Changes saved.')
 303 );
 304
 305 $errors = array(
 306         __('Error while saving.'),
 307         __('Error in displaying the widget settings form.')
 308 );
 309
 310 require_once( ABSPATH . 'wp-admin/admin-header.php' ); ?>
 311
 312 <div class="wrap">
 313 <h2><?php echo esc_html( $title ); ?></h2>
 314
 315 <?php if ( isset($_GET['message']) && isset($messages[$_GET['message']]) ) { ?>
 316 <div id="message" class="updated"><p><?php echo $messages[$_GET['message']]; ?></p></div>
 317 <?php } ?>
 318 <?php if ( isset($_GET['error']) && isset($errors[$_GET['error']]) ) { ?>
 319 <div id="message" class="error"><p><?php echo $errors[$_GET['error']]; ?></p></div>
 320 <?php } ?>
 321
 322 <?php
 323 /**
 324  * Fires before the Widgets administration page content loads.
 325  *
 326  * @since 3.0.0
 327  */
 328 do_action( 'widgets_admin_page' ); ?>
 329
 330 <div class="widget-liquid-left">
 331 <div id="widgets-left">
 332         <div id="available-widgets" class="widgets-holder-wrap">
 333                 <div class="sidebar-name">
 334                         <div class="sidebar-name-arrow"><br /></div>
 335                         <h3><?php _e('Available Widgets'); ?> <span id="removing-widget"><?php _ex('Deactivate', 'removing-widget'); ?> <span></span></span></h3>
 336                 </div>
 337                 <div class="widget-holder">
 338                         <div class="sidebar-description">
 339                                 <p class="description"><?php _e('To activate a widget drag it to a sidebar or click on it. To deactivate a widget and delete its settings, drag it back.'); ?></p>
 340                         </div>
 341                         <div id="widget-list">
 342                                 <?php wp_list_widgets(); ?>
 343                         </div>
 344                         <br class='clear' />
 345                 </div>
 346                 <br class="clear" />
 347         </div>
 348
 349 <?php
 350
 351 $theme_sidebars = array();
 352 foreach ( $wp_registered_sidebars as $sidebar => $registered_sidebar ) {
 353         if ( false !== strpos( $registered_sidebar['class'], 'inactive-sidebar' ) || 'orphaned_widgets' == substr( $sidebar, 0, 16 ) ) {
 354                 $wrap_class = 'widgets-holder-wrap';
 355                 if ( !empty( $registered_sidebar['class'] ) )
 356                         $wrap_class .= ' ' . $registered_sidebar['class'];
 357
 358                 ?>
 359                 <div class="<?php echo esc_attr( $wrap_class ); ?>">
 360                         <div class="widget-holder inactive">
 361                                 <?php wp_list_widget_controls( $registered_sidebar['id'], $registered_sidebar['name'] ); ?>
 362                                 <div class="clear"></div>
 363                         </div>
 364                 </div>
 365                 <?php
 366
 367         } else {
 368                 $theme_sidebars[$sidebar] = $registered_sidebar;
 369         }
 370 }
 371
 372 ?>
 373 </div>
 374 </div>
 375 <?php
 376
 377 $i = $split = 0;
 378 $single_sidebar_class = '';
 379 $sidebars_count = count( $theme_sidebars );
 380
 381 if ( $sidebars_count > 1 ) {
 382         $split = ceil( $sidebars_count / 2 );
 383 } else {
 384         $single_sidebar_class = ' class="single-sidebar"';
 385 }
 386
 387 ?>
 388 <div class="widget-liquid-right">
 389 <div id="widgets-right"<?php echo $single_sidebar_class; ?>>
 390 <div class="sidebars-column-1">
 391 <?php
 392
 393 foreach ( $theme_sidebars as $sidebar => $registered_sidebar ) {
 394         $wrap_class = 'widgets-holder-wrap';
 395         if ( !empty( $registered_sidebar['class'] ) )
 396                 $wrap_class .= ' sidebar-' . $registered_sidebar['class'];
 397
 398         if ( $i > 0 )
 399                 $wrap_class .= ' closed';
 400
 401         if ( $split && $i == $split ) {
 402                 ?>
 403                 </div><div class="sidebars-column-2">
 404                 <?php
 405         }
 406
 407         ?>
 408         <div class="<?php echo esc_attr( $wrap_class ); ?>">
 409                 <?php wp_list_widget_controls( $sidebar, $registered_sidebar['name'] ); // Show the control forms for each of the widgets in this sidebar ?>
 410         </div>
 411         <?php
 412
 413         $i++;
 414 }
 415
 416 ?>
 417 </div>
 418 </div>
 419 </div>
 420 <form action="" method="post">
 421 <?php wp_nonce_field( 'save-sidebar-widgets', '_wpnonce_widgets', false ); ?>
 422 </form>
 423 <br class="clear" />
 424 </div>
 425
 426 <div class="widgets-chooser">
 427         <ul class="widgets-chooser-sidebars"></ul>
 428         <div class="widgets-chooser-actions">
 429                 <button class="button-secondary"><?php _e( 'Cancel' ); ?></button>
 430                 <button class="button-primary"><?php _e( 'Add Widget' ); ?></button>
 431         </div>
 432 </div>
 433
 434 <?php
 435
 436 /**
 437  * Fires after the available widgets and sidebars have loaded, before the admin footer.
 438  *
 439  * @since 2.2.0
 440  */
 441 do_action( 'sidebar_admin_page' );
 442 require_once( ABSPATH . 'wp-admin/admin-footer.php' );