home *** CD-ROM | disk | FTP | other *** search
/ HTML Examples / WP.iso / wordpress / wp-includes / class-wp-customize-widgets.php < prev    next >
Encoding:
PHP Script  |  2017-10-15  |  64.2 KB  |  2,030 lines
  1. <?php
  2. /**
  3.  * WordPress Customize Widgets classes
  4.  *
  5.  * @package WordPress
  6.  * @subpackage Customize
  7.  * @since 3.9.0
  8.  */
  9.  
  10. /**
  11.  * Customize Widgets class.
  12.  *
  13.  * Implements widget management in the Customizer.
  14.  *
  15.  * @since 3.9.0
  16.  *
  17.  * @see WP_Customize_Manager
  18.  */
  19. final class WP_Customize_Widgets {
  20.  
  21.     /**
  22.      * WP_Customize_Manager instance.
  23.      *
  24.      * @since 3.9.0
  25.      * @var WP_Customize_Manager
  26.      */
  27.     public $manager;
  28.  
  29.     /**
  30.      * All id_bases for widgets defined in core.
  31.      *
  32.      * @since 3.9.0
  33.      * @var array
  34.      */
  35.     protected $core_widget_id_bases = array(
  36.         'archives',
  37.         'calendar',
  38.         'categories',
  39.         'custom_html',
  40.         'links',
  41.         'media_audio',
  42.         'media_image',
  43.         'media_video',
  44.         'meta',
  45.         'nav_menu',
  46.         'pages',
  47.         'recent-comments',
  48.         'recent-posts',
  49.         'rss',
  50.         'search',
  51.         'tag_cloud',
  52.         'text',
  53.     );
  54.  
  55.     /**
  56.      * @since 3.9.0
  57.      * @var array
  58.      */
  59.     protected $rendered_sidebars = array();
  60.  
  61.     /**
  62.      * @since 3.9.0
  63.      * @var array
  64.      */
  65.     protected $rendered_widgets = array();
  66.  
  67.     /**
  68.      * @since 3.9.0
  69.      * @var array
  70.      */
  71.     protected $old_sidebars_widgets = array();
  72.  
  73.     /**
  74.      * Mapping of widget ID base to whether it supports selective refresh.
  75.      *
  76.      * @since 4.5.0
  77.      * @var array
  78.      */
  79.     protected $selective_refreshable_widgets;
  80.  
  81.     /**
  82.      * Mapping of setting type to setting ID pattern.
  83.      *
  84.      * @since 4.2.0
  85.      * @var array
  86.      */
  87.     protected $setting_id_patterns = array(
  88.         'widget_instance' => '/^widget_(?P<id_base>.+?)(?:\[(?P<widget_number>\d+)\])?$/',
  89.         'sidebar_widgets' => '/^sidebars_widgets\[(?P<sidebar_id>.+?)\]$/',
  90.     );
  91.  
  92.     /**
  93.      * Initial loader.
  94.      *
  95.      * @since 3.9.0
  96.      *
  97.      * @param WP_Customize_Manager $manager Customize manager bootstrap instance.
  98.      */
  99.     public function __construct( $manager ) {
  100.         $this->manager = $manager;
  101.  
  102.         // See https://github.com/xwp/wp-customize-snapshots/blob/962586659688a5b1fd9ae93618b7ce2d4e7a421c/php/class-customize-snapshot-manager.php#L420-L449
  103.         add_filter( 'customize_dynamic_setting_args',          array( $this, 'filter_customize_dynamic_setting_args' ), 10, 2 );
  104.         add_action( 'widgets_init',                            array( $this, 'register_settings' ), 95 );
  105.         add_action( 'customize_register',                      array( $this, 'schedule_customize_register' ), 1 );
  106.  
  107.         // Skip remaining hooks when the user can't manage widgets anyway.
  108.         if ( ! current_user_can( 'edit_theme_options' ) ) {
  109.             return;
  110.         }
  111.  
  112.         add_action( 'wp_loaded',                               array( $this, 'override_sidebars_widgets_for_theme_switch' ) );
  113.         add_action( 'customize_controls_init',                 array( $this, 'customize_controls_init' ) );
  114.         add_action( 'customize_controls_enqueue_scripts',      array( $this, 'enqueue_scripts' ) );
  115.         add_action( 'customize_controls_print_styles',         array( $this, 'print_styles' ) );
  116.         add_action( 'customize_controls_print_scripts',        array( $this, 'print_scripts' ) );
  117.         add_action( 'customize_controls_print_footer_scripts', array( $this, 'print_footer_scripts' ) );
  118.         add_action( 'customize_controls_print_footer_scripts', array( $this, 'output_widget_control_templates' ) );
  119.         add_action( 'customize_preview_init',                  array( $this, 'customize_preview_init' ) );
  120.         add_filter( 'customize_refresh_nonces',                array( $this, 'refresh_nonces' ) );
  121.  
  122.         add_action( 'dynamic_sidebar',                         array( $this, 'tally_rendered_widgets' ) );
  123.         add_filter( 'is_active_sidebar',                       array( $this, 'tally_sidebars_via_is_active_sidebar_calls' ), 10, 2 );
  124.         add_filter( 'dynamic_sidebar_has_widgets',             array( $this, 'tally_sidebars_via_dynamic_sidebar_calls' ), 10, 2 );
  125.  
  126.         // Selective Refresh.
  127.         add_filter( 'customize_dynamic_partial_args',          array( $this, 'customize_dynamic_partial_args' ), 10, 2 );
  128.         add_action( 'customize_preview_init',                  array( $this, 'selective_refresh_init' ) );
  129.     }
  130.  
  131.     /**
  132.      * List whether each registered widget can be use selective refresh.
  133.      *
  134.      * If the theme does not support the customize-selective-refresh-widgets feature,
  135.      * then this will always return an empty array.
  136.      *
  137.      * @since 4.5.0
  138.      *
  139.      * @global WP_Widget_Factory $wp_widget_factory
  140.      *
  141.      * @return array Mapping of id_base to support. If theme doesn't support
  142.      *               selective refresh, an empty array is returned.
  143.      */
  144.     public function get_selective_refreshable_widgets() {
  145.         global $wp_widget_factory;
  146.         if ( ! current_theme_supports( 'customize-selective-refresh-widgets' ) ) {
  147.             return array();
  148.         }
  149.         if ( ! isset( $this->selective_refreshable_widgets ) ) {
  150.             $this->selective_refreshable_widgets = array();
  151.             foreach ( $wp_widget_factory->widgets as $wp_widget ) {
  152.                 $this->selective_refreshable_widgets[ $wp_widget->id_base ] = ! empty( $wp_widget->widget_options['customize_selective_refresh'] );
  153.             }
  154.         }
  155.         return $this->selective_refreshable_widgets;
  156.     }
  157.  
  158.     /**
  159.      * Determines if a widget supports selective refresh.
  160.      *
  161.      * @since 4.5.0
  162.      *
  163.      * @param string $id_base Widget ID Base.
  164.      * @return bool Whether the widget can be selective refreshed.
  165.      */
  166.     public function is_widget_selective_refreshable( $id_base ) {
  167.         $selective_refreshable_widgets = $this->get_selective_refreshable_widgets();
  168.         return ! empty( $selective_refreshable_widgets[ $id_base ] );
  169.     }
  170.  
  171.     /**
  172.      * Retrieves the widget setting type given a setting ID.
  173.      *
  174.      * @since 4.2.0
  175.      *
  176.      * @staticvar array $cache
  177.      *
  178.      * @param string $setting_id Setting ID.
  179.      * @return string|void Setting type.
  180.      */
  181.     protected function get_setting_type( $setting_id ) {
  182.         static $cache = array();
  183.         if ( isset( $cache[ $setting_id ] ) ) {
  184.             return $cache[ $setting_id ];
  185.         }
  186.         foreach ( $this->setting_id_patterns as $type => $pattern ) {
  187.             if ( preg_match( $pattern, $setting_id ) ) {
  188.                 $cache[ $setting_id ] = $type;
  189.                 return $type;
  190.             }
  191.         }
  192.     }
  193.  
  194.     /**
  195.      * Inspects the incoming customized data for any widget settings, and dynamically adds
  196.      * them up-front so widgets will be initialized properly.
  197.      *
  198.      * @since 4.2.0
  199.      */
  200.     public function register_settings() {
  201.         $widget_setting_ids = array();
  202.         $incoming_setting_ids = array_keys( $this->manager->unsanitized_post_values() );
  203.         foreach ( $incoming_setting_ids as $setting_id ) {
  204.             if ( ! is_null( $this->get_setting_type( $setting_id ) ) ) {
  205.                 $widget_setting_ids[] = $setting_id;
  206.             }
  207.         }
  208.         if ( $this->manager->doing_ajax( 'update-widget' ) && isset( $_REQUEST['widget-id'] ) ) {
  209.             $widget_setting_ids[] = $this->get_setting_id( wp_unslash( $_REQUEST['widget-id'] ) );
  210.         }
  211.  
  212.         $settings = $this->manager->add_dynamic_settings( array_unique( $widget_setting_ids ) );
  213.  
  214.         if ( $this->manager->settings_previewed() ) {
  215.             foreach ( $settings as $setting ) {
  216.                 $setting->preview();
  217.             }
  218.         }
  219.     }
  220.  
  221.     /**
  222.      * Determines the arguments for a dynamically-created setting.
  223.      *
  224.      * @since 4.2.0
  225.      *
  226.      * @param false|array $args       The arguments to the WP_Customize_Setting constructor.
  227.      * @param string      $setting_id ID for dynamic setting, usually coming from `$_POST['customized']`.
  228.      * @return false|array Setting arguments, false otherwise.
  229.      */
  230.     public function filter_customize_dynamic_setting_args( $args, $setting_id ) {
  231.         if ( $this->get_setting_type( $setting_id ) ) {
  232.             $args = $this->get_setting_args( $setting_id );
  233.         }
  234.         return $args;
  235.     }
  236.  
  237.     /**
  238.      * Retrieves an unslashed post value or return a default.
  239.      *
  240.      * @since 3.9.0
  241.      *
  242.      * @param string $name    Post value.
  243.      * @param mixed  $default Default post value.
  244.      * @return mixed Unslashed post value or default value.
  245.      */
  246.     protected function get_post_value( $name, $default = null ) {
  247.         if ( ! isset( $_POST[ $name ] ) ) {
  248.             return $default;
  249.         }
  250.  
  251.         return wp_unslash( $_POST[ $name ] );
  252.     }
  253.  
  254.     /**
  255.      * Override sidebars_widgets for theme switch.
  256.      *
  257.      * When switching a theme via the Customizer, supply any previously-configured
  258.      * sidebars_widgets from the target theme as the initial sidebars_widgets
  259.      * setting. Also store the old theme's existing settings so that they can
  260.      * be passed along for storing in the sidebars_widgets theme_mod when the
  261.      * theme gets switched.
  262.      *
  263.      * @since 3.9.0
  264.      *
  265.      * @global array $sidebars_widgets
  266.      * @global array $_wp_sidebars_widgets
  267.      */
  268.     public function override_sidebars_widgets_for_theme_switch() {
  269.         global $sidebars_widgets;
  270.  
  271.         if ( $this->manager->doing_ajax() || $this->manager->is_theme_active() ) {
  272.             return;
  273.         }
  274.  
  275.         $this->old_sidebars_widgets = wp_get_sidebars_widgets();
  276.         add_filter( 'customize_value_old_sidebars_widgets_data', array( $this, 'filter_customize_value_old_sidebars_widgets_data' ) );
  277.         $this->manager->set_post_value( 'old_sidebars_widgets_data', $this->old_sidebars_widgets ); // Override any value cached in changeset.
  278.  
  279.         // retrieve_widgets() looks at the global $sidebars_widgets
  280.         $sidebars_widgets = $this->old_sidebars_widgets;
  281.         $sidebars_widgets = retrieve_widgets( 'customize' );
  282.         add_filter( 'option_sidebars_widgets', array( $this, 'filter_option_sidebars_widgets_for_theme_switch' ), 1 );
  283.         // reset global cache var used by wp_get_sidebars_widgets()
  284.         unset( $GLOBALS['_wp_sidebars_widgets'] );
  285.     }
  286.  
  287.     /**
  288.      * Filters old_sidebars_widgets_data Customizer setting.
  289.      *
  290.      * When switching themes, filter the Customizer setting old_sidebars_widgets_data
  291.      * to supply initial $sidebars_widgets before they were overridden by retrieve_widgets().
  292.      * The value for old_sidebars_widgets_data gets set in the old theme's sidebars_widgets
  293.      * theme_mod.
  294.      *
  295.      * @since 3.9.0
  296.      *
  297.      * @see WP_Customize_Widgets::handle_theme_switch()
  298.      *
  299.      * @param array $old_sidebars_widgets
  300.      * @return array
  301.      */
  302.     public function filter_customize_value_old_sidebars_widgets_data( $old_sidebars_widgets ) {
  303.         return $this->old_sidebars_widgets;
  304.     }
  305.  
  306.     /**
  307.      * Filters sidebars_widgets option for theme switch.
  308.      *
  309.      * When switching themes, the retrieve_widgets() function is run when the Customizer initializes,
  310.      * and then the new sidebars_widgets here get supplied as the default value for the sidebars_widgets
  311.      * option.
  312.      *
  313.      * @since 3.9.0
  314.      *
  315.      * @see WP_Customize_Widgets::handle_theme_switch()
  316.      * @global array $sidebars_widgets
  317.      *
  318.      * @param array $sidebars_widgets
  319.      * @return array
  320.      */
  321.     public function filter_option_sidebars_widgets_for_theme_switch( $sidebars_widgets ) {
  322.         $sidebars_widgets = $GLOBALS['sidebars_widgets'];
  323.         $sidebars_widgets['array_version'] = 3;
  324.         return $sidebars_widgets;
  325.     }
  326.  
  327.     /**
  328.      * Ensures all widgets get loaded into the Customizer.
  329.      *
  330.      * Note: these actions are also fired in wp_ajax_update_widget().
  331.      *
  332.      * @since 3.9.0
  333.      */
  334.     public function customize_controls_init() {
  335.         /** This action is documented in wp-admin/includes/ajax-actions.php */
  336.         do_action( 'load-widgets.php' );
  337.  
  338.         /** This action is documented in wp-admin/includes/ajax-actions.php */
  339.         do_action( 'widgets.php' );
  340.  
  341.         /** This action is documented in wp-admin/widgets.php */
  342.         do_action( 'sidebar_admin_setup' );
  343.     }
  344.  
  345.     /**
  346.      * Ensures widgets are available for all types of previews.
  347.      *
  348.      * When in preview, hook to {@see 'customize_register'} for settings after WordPress is loaded
  349.      * so that all filters have been initialized (e.g. Widget Visibility).
  350.      *
  351.      * @since 3.9.0
  352.      */
  353.     public function schedule_customize_register() {
  354.         if ( is_admin() ) {
  355.             $this->customize_register();
  356.         } else {
  357.             add_action( 'wp', array( $this, 'customize_register' ) );
  358.         }
  359.     }
  360.  
  361.     /**
  362.      * Registers Customizer settings and controls for all sidebars and widgets.
  363.      *
  364.      * @since 3.9.0
  365.      *
  366.      * @global array $wp_registered_widgets
  367.      * @global array $wp_registered_widget_controls
  368.      * @global array $wp_registered_sidebars
  369.      */
  370.     public function customize_register() {
  371.         global $wp_registered_widgets, $wp_registered_widget_controls, $wp_registered_sidebars;
  372.  
  373.         add_filter( 'sidebars_widgets', array( $this, 'preview_sidebars_widgets' ), 1 );
  374.  
  375.         $sidebars_widgets = array_merge(
  376.             array( 'wp_inactive_widgets' => array() ),
  377.             array_fill_keys( array_keys( $wp_registered_sidebars ), array() ),
  378.             wp_get_sidebars_widgets()
  379.         );
  380.  
  381.         $new_setting_ids = array();
  382.  
  383.         /*
  384.          * Register a setting for all widgets, including those which are active,
  385.          * inactive, and orphaned since a widget may get suppressed from a sidebar
  386.          * via a plugin (like Widget Visibility).
  387.          */
  388.         foreach ( array_keys( $wp_registered_widgets ) as $widget_id ) {
  389.             $setting_id   = $this->get_setting_id( $widget_id );
  390.             $setting_args = $this->get_setting_args( $setting_id );
  391.             if ( ! $this->manager->get_setting( $setting_id ) ) {
  392.                 $this->manager->add_setting( $setting_id, $setting_args );
  393.             }
  394.             $new_setting_ids[] = $setting_id;
  395.         }
  396.  
  397.         /*
  398.          * Add a setting which will be supplied for the theme's sidebars_widgets
  399.          * theme_mod when the theme is switched.
  400.          */
  401.         if ( ! $this->manager->is_theme_active() ) {
  402.             $setting_id = 'old_sidebars_widgets_data';
  403.             $setting_args = $this->get_setting_args( $setting_id, array(
  404.                 'type' => 'global_variable',
  405.                 'dirty' => true,
  406.             ) );
  407.             $this->manager->add_setting( $setting_id, $setting_args );
  408.         }
  409.  
  410.         $this->manager->add_panel( 'widgets', array(
  411.             'type'            => 'widgets',
  412.             'title'           => __( 'Widgets' ),
  413.             'description'     => __( 'Widgets are independent sections of content that can be placed into widgetized areas provided by your theme (commonly called sidebars).' ),
  414.             'priority'        => 110,
  415.             'active_callback' => array( $this, 'is_panel_active' ),
  416.             'auto_expand_sole_section' => true,
  417.         ) );
  418.  
  419.         foreach ( $sidebars_widgets as $sidebar_id => $sidebar_widget_ids ) {
  420.             if ( empty( $sidebar_widget_ids ) ) {
  421.                 $sidebar_widget_ids = array();
  422.             }
  423.  
  424.             $is_registered_sidebar = is_registered_sidebar( $sidebar_id );
  425.             $is_inactive_widgets   = ( 'wp_inactive_widgets' === $sidebar_id );
  426.             $is_active_sidebar     = ( $is_registered_sidebar && ! $is_inactive_widgets );
  427.  
  428.             // Add setting for managing the sidebar's widgets.
  429.             if ( $is_registered_sidebar || $is_inactive_widgets ) {
  430.                 $setting_id   = sprintf( 'sidebars_widgets[%s]', $sidebar_id );
  431.                 $setting_args = $this->get_setting_args( $setting_id );
  432.                 if ( ! $this->manager->get_setting( $setting_id ) ) {
  433.                     if ( ! $this->manager->is_theme_active() ) {
  434.                         $setting_args['dirty'] = true;
  435.                     }
  436.                     $this->manager->add_setting( $setting_id, $setting_args );
  437.                 }
  438.                 $new_setting_ids[] = $setting_id;
  439.  
  440.                 // Add section to contain controls.
  441.                 $section_id = sprintf( 'sidebar-widgets-%s', $sidebar_id );
  442.                 if ( $is_active_sidebar ) {
  443.  
  444.                     $section_args = array(
  445.                         'title' => $wp_registered_sidebars[ $sidebar_id ]['name'],
  446.                         'description' => $wp_registered_sidebars[ $sidebar_id ]['description'],
  447.                         'priority' => array_search( $sidebar_id, array_keys( $wp_registered_sidebars ) ),
  448.                         'panel' => 'widgets',
  449.                         'sidebar_id' => $sidebar_id,
  450.                     );
  451.  
  452.                     /**
  453.                      * Filters Customizer widget section arguments for a given sidebar.
  454.                      *
  455.                      * @since 3.9.0
  456.                      *
  457.                      * @param array      $section_args Array of Customizer widget section arguments.
  458.                      * @param string     $section_id   Customizer section ID.
  459.                      * @param int|string $sidebar_id   Sidebar ID.
  460.                      */
  461.                     $section_args = apply_filters( 'customizer_widgets_section_args', $section_args, $section_id, $sidebar_id );
  462.  
  463.                     $section = new WP_Customize_Sidebar_Section( $this->manager, $section_id, $section_args );
  464.                     $this->manager->add_section( $section );
  465.  
  466.                     $control = new WP_Widget_Area_Customize_Control( $this->manager, $setting_id, array(
  467.                         'section'    => $section_id,
  468.                         'sidebar_id' => $sidebar_id,
  469.                         'priority'   => count( $sidebar_widget_ids ), // place 'Add Widget' and 'Reorder' buttons at end.
  470.                     ) );
  471.                     $new_setting_ids[] = $setting_id;
  472.  
  473.                     $this->manager->add_control( $control );
  474.                 }
  475.             }
  476.  
  477.             // Add a control for each active widget (located in a sidebar).
  478.             foreach ( $sidebar_widget_ids as $i => $widget_id ) {
  479.  
  480.                 // Skip widgets that may have gone away due to a plugin being deactivated.
  481.                 if ( ! $is_active_sidebar || ! isset( $wp_registered_widgets[$widget_id] ) ) {
  482.                     continue;
  483.                 }
  484.  
  485.                 $registered_widget = $wp_registered_widgets[$widget_id];
  486.                 $setting_id        = $this->get_setting_id( $widget_id );
  487.                 $id_base           = $wp_registered_widget_controls[$widget_id]['id_base'];
  488.  
  489.                 $control = new WP_Widget_Form_Customize_Control( $this->manager, $setting_id, array(
  490.                     'label'          => $registered_widget['name'],
  491.                     'section'        => $section_id,
  492.                     'sidebar_id'     => $sidebar_id,
  493.                     'widget_id'      => $widget_id,
  494.                     'widget_id_base' => $id_base,
  495.                     'priority'       => $i,
  496.                     'width'          => $wp_registered_widget_controls[$widget_id]['width'],
  497.                     'height'         => $wp_registered_widget_controls[$widget_id]['height'],
  498.                     'is_wide'        => $this->is_wide_widget( $widget_id ),
  499.                 ) );
  500.                 $this->manager->add_control( $control );
  501.             }
  502.         }
  503.  
  504.         if ( $this->manager->settings_previewed() ) {
  505.             foreach ( $new_setting_ids as $new_setting_id ) {
  506.                 $this->manager->get_setting( $new_setting_id )->preview();
  507.             }
  508.         }
  509.     }
  510.  
  511.     /**
  512.      * Determines whether the widgets panel is active, based on whether there are sidebars registered.
  513.      *
  514.      * @since 4.4.0
  515.      *
  516.      * @see WP_Customize_Panel::$active_callback
  517.      *
  518.      * @global array $wp_registered_sidebars
  519.      * @return bool Active.
  520.      */
  521.     public function is_panel_active() {
  522.         global $wp_registered_sidebars;
  523.         return ! empty( $wp_registered_sidebars );
  524.     }
  525.  
  526.     /**
  527.      * Converts a widget_id into its corresponding Customizer setting ID (option name).
  528.      *
  529.      * @since 3.9.0
  530.      *
  531.      * @param string $widget_id Widget ID.
  532.      * @return string Maybe-parsed widget ID.
  533.      */
  534.     public function get_setting_id( $widget_id ) {
  535.         $parsed_widget_id = $this->parse_widget_id( $widget_id );
  536.         $setting_id       = sprintf( 'widget_%s', $parsed_widget_id['id_base'] );
  537.  
  538.         if ( ! is_null( $parsed_widget_id['number'] ) ) {
  539.             $setting_id .= sprintf( '[%d]', $parsed_widget_id['number'] );
  540.         }
  541.         return $setting_id;
  542.     }
  543.  
  544.     /**
  545.      * Determines whether the widget is considered "wide".
  546.      *
  547.      * Core widgets which may have controls wider than 250, but can still be shown
  548.      * in the narrow Customizer panel. The RSS and Text widgets in Core, for example,
  549.      * have widths of 400 and yet they still render fine in the Customizer panel.
  550.      *
  551.      * This method will return all Core widgets as being not wide, but this can be
  552.      * overridden with the {@see 'is_wide_widget_in_customizer'} filter.
  553.      *
  554.      * @since 3.9.0
  555.      *
  556.      * @global $wp_registered_widget_controls
  557.      *
  558.      * @param string $widget_id Widget ID.
  559.      * @return bool Whether or not the widget is a "wide" widget.
  560.      */
  561.     public function is_wide_widget( $widget_id ) {
  562.         global $wp_registered_widget_controls;
  563.  
  564.         $parsed_widget_id = $this->parse_widget_id( $widget_id );
  565.         $width            = $wp_registered_widget_controls[$widget_id]['width'];
  566.         $is_core          = in_array( $parsed_widget_id['id_base'], $this->core_widget_id_bases );
  567.         $is_wide          = ( $width > 250 && ! $is_core );
  568.  
  569.         /**
  570.          * Filters whether the given widget is considered "wide".
  571.          *
  572.          * @since 3.9.0
  573.          *
  574.          * @param bool   $is_wide   Whether the widget is wide, Default false.
  575.          * @param string $widget_id Widget ID.
  576.          */
  577.         return apply_filters( 'is_wide_widget_in_customizer', $is_wide, $widget_id );
  578.     }
  579.  
  580.     /**
  581.      * Converts a widget ID into its id_base and number components.
  582.      *
  583.      * @since 3.9.0
  584.      *
  585.      * @param string $widget_id Widget ID.
  586.      * @return array Array containing a widget's id_base and number components.
  587.      */
  588.     public function parse_widget_id( $widget_id ) {
  589.         $parsed = array(
  590.             'number' => null,
  591.             'id_base' => null,
  592.         );
  593.  
  594.         if ( preg_match( '/^(.+)-(\d+)$/', $widget_id, $matches ) ) {
  595.             $parsed['id_base'] = $matches[1];
  596.             $parsed['number']  = intval( $matches[2] );
  597.         } else {
  598.             // likely an old single widget
  599.             $parsed['id_base'] = $widget_id;
  600.         }
  601.         return $parsed;
  602.     }
  603.  
  604.     /**
  605.      * Converts a widget setting ID (option path) to its id_base and number components.
  606.      *
  607.      * @since 3.9.0
  608.      *
  609.      * @param string $setting_id Widget setting ID.
  610.      * @return WP_Error|array Array containing a widget's id_base and number components,
  611.      *                        or a WP_Error object.
  612.      */
  613.     public function parse_widget_setting_id( $setting_id ) {
  614.         if ( ! preg_match( '/^(widget_(.+?))(?:\[(\d+)\])?$/', $setting_id, $matches ) ) {
  615.             return new WP_Error( 'widget_setting_invalid_id' );
  616.         }
  617.  
  618.         $id_base = $matches[2];
  619.         $number  = isset( $matches[3] ) ? intval( $matches[3] ) : null;
  620.  
  621.         return compact( 'id_base', 'number' );
  622.     }
  623.  
  624.     /**
  625.      * Calls admin_print_styles-widgets.php and admin_print_styles hooks to
  626.      * allow custom styles from plugins.
  627.      *
  628.      * @since 3.9.0
  629.      */
  630.     public function print_styles() {
  631.         /** This action is documented in wp-admin/admin-header.php */
  632.         do_action( 'admin_print_styles-widgets.php' );
  633.  
  634.         /** This action is documented in wp-admin/admin-header.php */
  635.         do_action( 'admin_print_styles' );
  636.     }
  637.  
  638.     /**
  639.      * Calls admin_print_scripts-widgets.php and admin_print_scripts hooks to
  640.      * allow custom scripts from plugins.
  641.      *
  642.      * @since 3.9.0
  643.      */
  644.     public function print_scripts() {
  645.         /** This action is documented in wp-admin/admin-header.php */
  646.         do_action( 'admin_print_scripts-widgets.php' );
  647.  
  648.         /** This action is documented in wp-admin/admin-header.php */
  649.         do_action( 'admin_print_scripts' );
  650.     }
  651.  
  652.     /**
  653.      * Enqueues scripts and styles for Customizer panel and export data to JavaScript.
  654.      *
  655.      * @since 3.9.0
  656.      *
  657.      * @global WP_Scripts $wp_scripts
  658.      * @global array $wp_registered_sidebars
  659.      * @global array $wp_registered_widgets
  660.      */
  661.     public function enqueue_scripts() {
  662.         global $wp_scripts, $wp_registered_sidebars, $wp_registered_widgets;
  663.  
  664.         wp_enqueue_style( 'customize-widgets' );
  665.         wp_enqueue_script( 'customize-widgets' );
  666.  
  667.         /** This action is documented in wp-admin/admin-header.php */
  668.         do_action( 'admin_enqueue_scripts', 'widgets.php' );
  669.  
  670.         /*
  671.          * Export available widgets with control_tpl removed from model
  672.          * since plugins need templates to be in the DOM.
  673.          */
  674.         $available_widgets = array();
  675.  
  676.         foreach ( $this->get_available_widgets() as $available_widget ) {
  677.             unset( $available_widget['control_tpl'] );
  678.             $available_widgets[] = $available_widget;
  679.         }
  680.  
  681.         $widget_reorder_nav_tpl = sprintf(
  682.             '<div class="widget-reorder-nav"><span class="move-widget" tabindex="0">%1$s</span><span class="move-widget-down" tabindex="0">%2$s</span><span class="move-widget-up" tabindex="0">%3$s</span></div>',
  683.             __( 'Move to another area…' ),
  684.             __( 'Move down' ),
  685.             __( 'Move up' )
  686.         );
  687.  
  688.         $move_widget_area_tpl = str_replace(
  689.             array( '{description}', '{btn}' ),
  690.             array(
  691.                 __( 'Select an area to move this widget into:' ),
  692.                 _x( 'Move', 'Move widget' ),
  693.             ),
  694.             '<div class="move-widget-area">
  695.                 <p class="description">{description}</p>
  696.                 <ul class="widget-area-select">
  697.                     <% _.each( sidebars, function ( sidebar ){ %>
  698.                         <li class="" data-id="<%- sidebar.id %>" title="<%- sidebar.description %>" tabindex="0"><%- sidebar.name %></li>
  699.                     <% }); %>
  700.                 </ul>
  701.                 <div class="move-widget-actions">
  702.                     <button class="move-widget-btn button" type="button">{btn}</button>
  703.                 </div>
  704.             </div>'
  705.         );
  706.  
  707.         /*
  708.          * Gather all strings in PHP that may be needed by JS on the client.
  709.          * Once JS i18n is implemented (in #20491), this can be removed.
  710.          */
  711.         $some_non_rendered_areas_messages = array();
  712.         $some_non_rendered_areas_messages[1] = html_entity_decode(
  713.             __( 'Your theme has 1 other widget area, but this particular page doesn’t display it.' ),
  714.             ENT_QUOTES,
  715.             get_bloginfo( 'charset' )
  716.         );
  717.         $registered_sidebar_count = count( $wp_registered_sidebars );
  718.         for ( $non_rendered_count = 2; $non_rendered_count < $registered_sidebar_count; $non_rendered_count++ ) {
  719.             $some_non_rendered_areas_messages[ $non_rendered_count ] = html_entity_decode( sprintf(
  720.                 /* translators: %s: the number of other widget areas registered but not rendered */
  721.                 _n(
  722.                     'Your theme has %s other widget area, but this particular page doesn’t display it.',
  723.                     'Your theme has %s other widget areas, but this particular page doesn’t display them.',
  724.                     $non_rendered_count
  725.                 ),
  726.                 number_format_i18n( $non_rendered_count )
  727.             ), ENT_QUOTES, get_bloginfo( 'charset' ) );
  728.         }
  729.  
  730.         if ( 1 === $registered_sidebar_count ) {
  731.             $no_areas_shown_message = html_entity_decode( sprintf(
  732.                 __( 'Your theme has 1 widget area, but this particular page doesn’t display it.' )
  733.             ), ENT_QUOTES, get_bloginfo( 'charset' ) );
  734.         } else {
  735.             $no_areas_shown_message = html_entity_decode( sprintf(
  736.                 /* translators: %s: the total number of widget areas registered */
  737.                 _n(
  738.                     'Your theme has %s widget area, but this particular page doesn’t display it.',
  739.                     'Your theme has %s widget areas, but this particular page doesn’t display them.',
  740.                     $registered_sidebar_count
  741.                 ),
  742.                 number_format_i18n( $registered_sidebar_count )
  743.             ), ENT_QUOTES, get_bloginfo( 'charset' ) );
  744.         }
  745.  
  746.         $settings = array(
  747.             'registeredSidebars'   => array_values( $wp_registered_sidebars ),
  748.             'registeredWidgets'    => $wp_registered_widgets,
  749.             'availableWidgets'     => $available_widgets, // @todo Merge this with registered_widgets
  750.             'l10n' => array(
  751.                 'saveBtnLabel'     => __( 'Apply' ),
  752.                 'saveBtnTooltip'   => __( 'Save and preview changes before publishing them.' ),
  753.                 'removeBtnLabel'   => __( 'Remove' ),
  754.                 'removeBtnTooltip' => __( 'Trash widget by moving it to the inactive widgets sidebar.' ),
  755.                 'error'            => __( 'An error has occurred. Please reload the page and try again.' ),
  756.                 'widgetMovedUp'    => __( 'Widget moved up' ),
  757.                 'widgetMovedDown'  => __( 'Widget moved down' ),
  758.                 'navigatePreview'  => __( 'You can navigate to other pages on your site while using the Customizer to view and edit the widgets displayed on those pages.' ),
  759.                 'someAreasShown'   => $some_non_rendered_areas_messages,
  760.                 'noAreasShown'     => $no_areas_shown_message,
  761.                 'reorderModeOn'    => __( 'Reorder mode enabled' ),
  762.                 'reorderModeOff'   => __( 'Reorder mode closed' ),
  763.                 'reorderLabelOn'   => esc_attr__( 'Reorder widgets' ),
  764.                 /* translators: %d: the number of widgets found */
  765.                 'widgetsFound'     => __( 'Number of widgets found: %d' ),
  766.                 'noWidgetsFound'   => __( 'No widgets found.' ),
  767.             ),
  768.             'tpl' => array(
  769.                 'widgetReorderNav' => $widget_reorder_nav_tpl,
  770.                 'moveWidgetArea'   => $move_widget_area_tpl,
  771.             ),
  772.             'selectiveRefreshableWidgets' => $this->get_selective_refreshable_widgets(),
  773.         );
  774.  
  775.         foreach ( $settings['registeredWidgets'] as &$registered_widget ) {
  776.             unset( $registered_widget['callback'] ); // may not be JSON-serializeable
  777.         }
  778.  
  779.         $wp_scripts->add_data(
  780.             'customize-widgets',
  781.             'data',
  782.             sprintf( 'var _wpCustomizeWidgetsSettings = %s;', wp_json_encode( $settings ) )
  783.         );
  784.     }
  785.  
  786.     /**
  787.      * Renders the widget form control templates into the DOM.
  788.      *
  789.      * @since 3.9.0
  790.      */
  791.     public function output_widget_control_templates() {
  792.         ?>
  793.         <div id="widgets-left"><!-- compatibility with JS which looks for widget templates here -->
  794.         <div id="available-widgets">
  795.             <div class="customize-section-title">
  796.                 <button class="customize-section-back" tabindex="-1">
  797.                     <span class="screen-reader-text"><?php _e( 'Back' ); ?></span>
  798.                 </button>
  799.                 <h3>
  800.                     <span class="customize-action"><?php
  801.                         /* translators: ▸ is the unicode right-pointing triangle, and %s is the section title in the Customizer */
  802.                         echo sprintf( __( 'Customizing ▸ %s' ), esc_html( $this->manager->get_panel( 'widgets' )->title ) );
  803.                     ?></span>
  804.                     <?php _e( 'Add a Widget' ); ?>
  805.                 </h3>
  806.             </div>
  807.             <div id="available-widgets-filter">
  808.                 <label class="screen-reader-text" for="widgets-search"><?php _e( 'Search Widgets' ); ?></label>
  809.                 <input type="text" id="widgets-search" placeholder="<?php esc_attr_e( 'Search widgets…' ) ?>" aria-describedby="widgets-search-desc" />
  810.                 <div class="search-icon" aria-hidden="true"></div>
  811.                 <button type="button" class="clear-results"><span class="screen-reader-text"><?php _e( 'Clear Results' ); ?></span></button>
  812.                 <p class="screen-reader-text" id="widgets-search-desc"><?php _e( 'The search results will be updated as you type.' ); ?></p>
  813.             </div>
  814.             <div id="available-widgets-list">
  815.             <?php foreach ( $this->get_available_widgets() as $available_widget ): ?>
  816.                 <div id="widget-tpl-<?php echo esc_attr( $available_widget['id'] ) ?>" data-widget-id="<?php echo esc_attr( $available_widget['id'] ) ?>" class="widget-tpl <?php echo esc_attr( $available_widget['id'] ) ?>" tabindex="0">
  817.                     <?php echo $available_widget['control_tpl']; ?>
  818.                 </div>
  819.             <?php endforeach; ?>
  820.             <p class="no-widgets-found-message"><?php _e( 'No widgets found.' ); ?></p>
  821.             </div><!-- #available-widgets-list -->
  822.         </div><!-- #available-widgets -->
  823.         </div><!-- #widgets-left -->
  824.         <?php
  825.     }
  826.  
  827.     /**
  828.      * Calls admin_print_footer_scripts and admin_print_scripts hooks to
  829.      * allow custom scripts from plugins.
  830.      *
  831.      * @since 3.9.0
  832.      */
  833.     public function print_footer_scripts() {
  834.         /** This action is documented in wp-admin/admin-footer.php */
  835.         do_action( 'admin_print_footer_scripts-widgets.php' );
  836.  
  837.         /** This action is documented in wp-admin/admin-footer.php */
  838.         do_action( 'admin_print_footer_scripts' );
  839.  
  840.         /** This action is documented in wp-admin/admin-footer.php */
  841.         do_action( 'admin_footer-widgets.php' );
  842.     }
  843.  
  844.     /**
  845.      * Retrieves common arguments to supply when constructing a Customizer setting.
  846.      *
  847.      * @since 3.9.0
  848.      *
  849.      * @param string $id        Widget setting ID.
  850.      * @param array  $overrides Array of setting overrides.
  851.      * @return array Possibly modified setting arguments.
  852.      */
  853.     public function get_setting_args( $id, $overrides = array() ) {
  854.         $args = array(
  855.             'type'       => 'option',
  856.             'capability' => 'edit_theme_options',
  857.             'default'    => array(),
  858.         );
  859.  
  860.         if ( preg_match( $this->setting_id_patterns['sidebar_widgets'], $id, $matches ) ) {
  861.             $args['sanitize_callback'] = array( $this, 'sanitize_sidebar_widgets' );
  862.             $args['sanitize_js_callback'] = array( $this, 'sanitize_sidebar_widgets_js_instance' );
  863.             $args['transport'] = current_theme_supports( 'customize-selective-refresh-widgets' ) ? 'postMessage' : 'refresh';
  864.         } elseif ( preg_match( $this->setting_id_patterns['widget_instance'], $id, $matches ) ) {
  865.             $args['sanitize_callback'] = array( $this, 'sanitize_widget_instance' );
  866.             $args['sanitize_js_callback'] = array( $this, 'sanitize_widget_js_instance' );
  867.             $args['transport'] = $this->is_widget_selective_refreshable( $matches['id_base'] ) ? 'postMessage' : 'refresh';
  868.         }
  869.  
  870.         $args = array_merge( $args, $overrides );
  871.  
  872.         /**
  873.          * Filters the common arguments supplied when constructing a Customizer setting.
  874.          *
  875.          * @since 3.9.0
  876.          *
  877.          * @see WP_Customize_Setting
  878.          *
  879.          * @param array  $args Array of Customizer setting arguments.
  880.          * @param string $id   Widget setting ID.
  881.          */
  882.         return apply_filters( 'widget_customizer_setting_args', $args, $id );
  883.     }
  884.  
  885.     /**
  886.      * Ensures sidebar widget arrays only ever contain widget IDS.
  887.      *
  888.      * Used as the 'sanitize_callback' for each $sidebars_widgets setting.
  889.      *
  890.      * @since 3.9.0
  891.      *
  892.      * @param array $widget_ids Array of widget IDs.
  893.      * @return array Array of sanitized widget IDs.
  894.      */
  895.     public function sanitize_sidebar_widgets( $widget_ids ) {
  896.         $widget_ids = array_map( 'strval', (array) $widget_ids );
  897.         $sanitized_widget_ids = array();
  898.         foreach ( $widget_ids as $widget_id ) {
  899.             $sanitized_widget_ids[] = preg_replace( '/[^a-z0-9_\-]/', '', $widget_id );
  900.         }
  901.         return $sanitized_widget_ids;
  902.     }
  903.  
  904.     /**
  905.      * Builds up an index of all available widgets for use in Backbone models.
  906.      *
  907.      * @since 3.9.0
  908.      *
  909.      * @global array $wp_registered_widgets
  910.      * @global array $wp_registered_widget_controls
  911.      * @staticvar array $available_widgets
  912.      *
  913.      * @see wp_list_widgets()
  914.      *
  915.      * @return array List of available widgets.
  916.      */
  917.     public function get_available_widgets() {
  918.         static $available_widgets = array();
  919.         if ( ! empty( $available_widgets ) ) {
  920.             return $available_widgets;
  921.         }
  922.  
  923.         global $wp_registered_widgets, $wp_registered_widget_controls;
  924.         require_once ABSPATH . '/wp-admin/includes/widgets.php'; // for next_widget_id_number()
  925.  
  926.         $sort = $wp_registered_widgets;
  927.         usort( $sort, array( $this, '_sort_name_callback' ) );
  928.         $done = array();
  929.  
  930.         foreach ( $sort as $widget ) {
  931.             if ( in_array( $widget['callback'], $done, true ) ) { // We already showed this multi-widget
  932.                 continue;
  933.             }
  934.  
  935.             $sidebar = is_active_widget( $widget['callback'], $widget['id'], false, false );
  936.             $done[]  = $widget['callback'];
  937.  
  938.             if ( ! isset( $widget['params'][0] ) ) {
  939.                 $widget['params'][0] = array();
  940.             }
  941.  
  942.             $available_widget = $widget;
  943.             unset( $available_widget['callback'] ); // not serializable to JSON
  944.  
  945.             $args = array(
  946.                 'widget_id'   => $widget['id'],
  947.                 'widget_name' => $widget['name'],
  948.                 '_display'    => 'template',
  949.             );
  950.  
  951.             $is_disabled     = false;
  952.             $is_multi_widget = ( isset( $wp_registered_widget_controls[$widget['id']]['id_base'] ) && isset( $widget['params'][0]['number'] ) );
  953.             if ( $is_multi_widget ) {
  954.                 $id_base            = $wp_registered_widget_controls[$widget['id']]['id_base'];
  955.                 $args['_temp_id']   = "$id_base-__i__";
  956.                 $args['_multi_num'] = next_widget_id_number( $id_base );
  957.                 $args['_add']       = 'multi';
  958.             } else {
  959.                 $args['_add'] = 'single';
  960.  
  961.                 if ( $sidebar && 'wp_inactive_widgets' !== $sidebar ) {
  962.                     $is_disabled = true;
  963.                 }
  964.                 $id_base = $widget['id'];
  965.             }
  966.  
  967.             $list_widget_controls_args = wp_list_widget_controls_dynamic_sidebar( array( 0 => $args, 1 => $widget['params'][0] ) );
  968.             $control_tpl = $this->get_widget_control( $list_widget_controls_args );
  969.  
  970.             // The properties here are mapped to the Backbone Widget model.
  971.             $available_widget = array_merge( $available_widget, array(
  972.                 'temp_id'      => isset( $args['_temp_id'] ) ? $args['_temp_id'] : null,
  973.                 'is_multi'     => $is_multi_widget,
  974.                 'control_tpl'  => $control_tpl,
  975.                 'multi_number' => ( $args['_add'] === 'multi' ) ? $args['_multi_num'] : false,
  976.                 'is_disabled'  => $is_disabled,
  977.                 'id_base'      => $id_base,
  978.                 'transport'    => $this->is_widget_selective_refreshable( $id_base ) ? 'postMessage' : 'refresh',
  979.                 'width'        => $wp_registered_widget_controls[$widget['id']]['width'],
  980.                 'height'       => $wp_registered_widget_controls[$widget['id']]['height'],
  981.                 'is_wide'      => $this->is_wide_widget( $widget['id'] ),
  982.             ) );
  983.  
  984.             $available_widgets[] = $available_widget;
  985.         }
  986.  
  987.         return $available_widgets;
  988.     }
  989.  
  990.     /**
  991.      * Naturally orders available widgets by name.
  992.      *
  993.      * @since 3.9.0
  994.      *
  995.      * @param array $widget_a The first widget to compare.
  996.      * @param array $widget_b The second widget to compare.
  997.      * @return int Reorder position for the current widget comparison.
  998.      */
  999.     protected function _sort_name_callback( $widget_a, $widget_b ) {
  1000.         return strnatcasecmp( $widget_a['name'], $widget_b['name'] );
  1001.     }
  1002.  
  1003.     /**
  1004.      * Retrieves the widget control markup.
  1005.      *
  1006.      * @since 3.9.0
  1007.      *
  1008.      * @param array $args Widget control arguments.
  1009.      * @return string Widget control form HTML markup.
  1010.      */
  1011.     public function get_widget_control( $args ) {
  1012.         $args[0]['before_form'] = '<div class="form">';
  1013.         $args[0]['after_form'] = '</div><!-- .form -->';
  1014.         $args[0]['before_widget_content'] = '<div class="widget-content">';
  1015.         $args[0]['after_widget_content'] = '</div><!-- .widget-content -->';
  1016.         ob_start();
  1017.         call_user_func_array( 'wp_widget_control', $args );
  1018.         $control_tpl = ob_get_clean();
  1019.         return $control_tpl;
  1020.     }
  1021.  
  1022.     /**
  1023.      * Retrieves the widget control markup parts.
  1024.      *
  1025.      * @since 4.4.0
  1026.      *
  1027.      * @param array $args Widget control arguments.
  1028.      * @return array {
  1029.      *     @type string $control Markup for widget control wrapping form.
  1030.      *     @type string $content The contents of the widget form itself.
  1031.      * }
  1032.      */
  1033.     public function get_widget_control_parts( $args ) {
  1034.         $args[0]['before_widget_content'] = '<div class="widget-content">';
  1035.         $args[0]['after_widget_content'] = '</div><!-- .widget-content -->';
  1036.         $control_markup = $this->get_widget_control( $args );
  1037.  
  1038.         $content_start_pos = strpos( $control_markup, $args[0]['before_widget_content'] );
  1039.         $content_end_pos = strrpos( $control_markup, $args[0]['after_widget_content'] );
  1040.  
  1041.         $control = substr( $control_markup, 0, $content_start_pos + strlen( $args[0]['before_widget_content'] ) );
  1042.         $control .= substr( $control_markup, $content_end_pos );
  1043.         $content = trim( substr(
  1044.             $control_markup,
  1045.             $content_start_pos + strlen( $args[0]['before_widget_content'] ),
  1046.             $content_end_pos - $content_start_pos - strlen( $args[0]['before_widget_content'] )
  1047.         ) );
  1048.  
  1049.         return compact( 'control', 'content' );
  1050.     }
  1051.  
  1052.     /**
  1053.      * Adds hooks for the Customizer preview.
  1054.      *
  1055.      * @since 3.9.0
  1056.      */
  1057.     public function customize_preview_init() {
  1058.         add_action( 'wp_enqueue_scripts', array( $this, 'customize_preview_enqueue' ) );
  1059.         add_action( 'wp_print_styles',    array( $this, 'print_preview_css' ), 1 );
  1060.         add_action( 'wp_footer',          array( $this, 'export_preview_data' ), 20 );
  1061.     }
  1062.  
  1063.     /**
  1064.      * Refreshes the nonce for widget updates.
  1065.      *
  1066.      * @since 4.2.0
  1067.      *
  1068.      * @param  array $nonces Array of nonces.
  1069.      * @return array $nonces Array of nonces.
  1070.      */
  1071.     public function refresh_nonces( $nonces ) {
  1072.         $nonces['update-widget'] = wp_create_nonce( 'update-widget' );
  1073.         return $nonces;
  1074.     }
  1075.  
  1076.     /**
  1077.      * When previewing, ensures the proper previewing widgets are used.
  1078.      *
  1079.      * Because wp_get_sidebars_widgets() gets called early at {@see 'init' } (via
  1080.      * wp_convert_widget_settings()) and can set global variable `$_wp_sidebars_widgets`
  1081.      * to the value of `get_option( 'sidebars_widgets' )` before the Customizer preview
  1082.      * filter is added, it has to be reset after the filter has been added.
  1083.      *
  1084.      * @since 3.9.0
  1085.      *
  1086.      * @param array $sidebars_widgets List of widgets for the current sidebar.
  1087.      * @return array
  1088.      */
  1089.     public function preview_sidebars_widgets( $sidebars_widgets ) {
  1090.         $sidebars_widgets = get_option( 'sidebars_widgets', array() );
  1091.  
  1092.         unset( $sidebars_widgets['array_version'] );
  1093.         return $sidebars_widgets;
  1094.     }
  1095.  
  1096.     /**
  1097.      * Enqueues scripts for the Customizer preview.
  1098.      *
  1099.      * @since 3.9.0
  1100.      */
  1101.     public function customize_preview_enqueue() {
  1102.         wp_enqueue_script( 'customize-preview-widgets' );
  1103.     }
  1104.  
  1105.     /**
  1106.      * Inserts default style for highlighted widget at early point so theme
  1107.      * stylesheet can override.
  1108.      *
  1109.      * @since 3.9.0
  1110.      */
  1111.     public function print_preview_css() {
  1112.         ?>
  1113.         <style>
  1114.         .widget-customizer-highlighted-widget {
  1115.             outline: none;
  1116.             -webkit-box-shadow: 0 0 2px rgba(30,140,190,0.8);
  1117.             box-shadow: 0 0 2px rgba(30,140,190,0.8);
  1118.             position: relative;
  1119.             z-index: 1;
  1120.         }
  1121.         </style>
  1122.         <?php
  1123.     }
  1124.  
  1125.     /**
  1126.      * Communicates the sidebars that appeared on the page at the very end of the page,
  1127.      * and at the very end of the wp_footer,
  1128.      *
  1129.      * @since 3.9.0
  1130.      *
  1131.      * @global array $wp_registered_sidebars
  1132.      * @global array $wp_registered_widgets
  1133.      */
  1134.     public function export_preview_data() {
  1135.         global $wp_registered_sidebars, $wp_registered_widgets;
  1136.  
  1137.         $switched_locale = switch_to_locale( get_user_locale() );
  1138.         $l10n = array(
  1139.             'widgetTooltip'  => __( 'Shift-click to edit this widget.' ),
  1140.         );
  1141.         if ( $switched_locale ) {
  1142.             restore_previous_locale();
  1143.         }
  1144.  
  1145.         // Prepare Customizer settings to pass to JavaScript.
  1146.         $settings = array(
  1147.             'renderedSidebars'   => array_fill_keys( array_unique( $this->rendered_sidebars ), true ),
  1148.             'renderedWidgets'    => array_fill_keys( array_keys( $this->rendered_widgets ), true ),
  1149.             'registeredSidebars' => array_values( $wp_registered_sidebars ),
  1150.             'registeredWidgets'  => $wp_registered_widgets,
  1151.             'l10n'               => $l10n,
  1152.             'selectiveRefreshableWidgets' => $this->get_selective_refreshable_widgets(),
  1153.         );
  1154.         foreach ( $settings['registeredWidgets'] as &$registered_widget ) {
  1155.             unset( $registered_widget['callback'] ); // may not be JSON-serializeable
  1156.         }
  1157.  
  1158.         ?>
  1159.         <script type="text/javascript">
  1160.             var _wpWidgetCustomizerPreviewSettings = <?php echo wp_json_encode( $settings ); ?>;
  1161.         </script>
  1162.         <?php
  1163.     }
  1164.  
  1165.     /**
  1166.      * Tracks the widgets that were rendered.
  1167.      *
  1168.      * @since 3.9.0
  1169.      *
  1170.      * @param array $widget Rendered widget to tally.
  1171.      */
  1172.     public function tally_rendered_widgets( $widget ) {
  1173.         $this->rendered_widgets[ $widget['id'] ] = true;
  1174.     }
  1175.  
  1176.     /**
  1177.      * Determine if a widget is rendered on the page.
  1178.      *
  1179.      * @since 4.0.0
  1180.      *
  1181.      * @param string $widget_id Widget ID to check.
  1182.      * @return bool Whether the widget is rendered.
  1183.      */
  1184.     public function is_widget_rendered( $widget_id ) {
  1185.         return in_array( $widget_id, $this->rendered_widgets );
  1186.     }
  1187.  
  1188.     /**
  1189.      * Determines if a sidebar is rendered on the page.
  1190.      *
  1191.      * @since 4.0.0
  1192.      *
  1193.      * @param string $sidebar_id Sidebar ID to check.
  1194.      * @return bool Whether the sidebar is rendered.
  1195.      */
  1196.     public function is_sidebar_rendered( $sidebar_id ) {
  1197.         return in_array( $sidebar_id, $this->rendered_sidebars );
  1198.     }
  1199.  
  1200.     /**
  1201.      * Tallies the sidebars rendered via is_active_sidebar().
  1202.      *
  1203.      * Keep track of the times that is_active_sidebar() is called in the template,
  1204.      * and assume that this means that the sidebar would be rendered on the template
  1205.      * if there were widgets populating it.
  1206.      *
  1207.      * @since 3.9.0
  1208.      *
  1209.      * @param bool   $is_active  Whether the sidebar is active.
  1210.      * @param string $sidebar_id Sidebar ID.
  1211.      * @return bool Whether the sidebar is active.
  1212.      */
  1213.     public function tally_sidebars_via_is_active_sidebar_calls( $is_active, $sidebar_id ) {
  1214.         if ( is_registered_sidebar( $sidebar_id ) ) {
  1215.             $this->rendered_sidebars[] = $sidebar_id;
  1216.         }
  1217.         /*
  1218.          * We may need to force this to true, and also force-true the value
  1219.          * for 'dynamic_sidebar_has_widgets' if we want to ensure that there
  1220.          * is an area to drop widgets into, if the sidebar is empty.
  1221.          */
  1222.         return $is_active;
  1223.     }
  1224.  
  1225.     /**
  1226.      * Tallies the sidebars rendered via dynamic_sidebar().
  1227.      *
  1228.      * Keep track of the times that dynamic_sidebar() is called in the template,
  1229.      * and assume this means the sidebar would be rendered on the template if
  1230.      * there were widgets populating it.
  1231.      *
  1232.      * @since 3.9.0
  1233.      *
  1234.      * @param bool   $has_widgets Whether the current sidebar has widgets.
  1235.      * @param string $sidebar_id  Sidebar ID.
  1236.      * @return bool Whether the current sidebar has widgets.
  1237.      */
  1238.     public function tally_sidebars_via_dynamic_sidebar_calls( $has_widgets, $sidebar_id ) {
  1239.         if ( is_registered_sidebar( $sidebar_id ) ) {
  1240.             $this->rendered_sidebars[] = $sidebar_id;
  1241.         }
  1242.  
  1243.         /*
  1244.          * We may need to force this to true, and also force-true the value
  1245.          * for 'is_active_sidebar' if we want to ensure there is an area to
  1246.          * drop widgets into, if the sidebar is empty.
  1247.          */
  1248.         return $has_widgets;
  1249.     }
  1250.  
  1251.     /**
  1252.      * Retrieves MAC for a serialized widget instance string.
  1253.      *
  1254.      * Allows values posted back from JS to be rejected if any tampering of the
  1255.      * data has occurred.
  1256.      *
  1257.      * @since 3.9.0
  1258.      *
  1259.      * @param string $serialized_instance Widget instance.
  1260.      * @return string MAC for serialized widget instance.
  1261.      */
  1262.     protected function get_instance_hash_key( $serialized_instance ) {
  1263.         return wp_hash( $serialized_instance );
  1264.     }
  1265.  
  1266.     /**
  1267.      * Sanitizes a widget instance.
  1268.      *
  1269.      * Unserialize the JS-instance for storing in the options. It's important that this filter
  1270.      * only get applied to an instance *once*.
  1271.      *
  1272.      * @since 3.9.0
  1273.      *
  1274.      * @param array $value Widget instance to sanitize.
  1275.      * @return array|void Sanitized widget instance.
  1276.      */
  1277.     public function sanitize_widget_instance( $value ) {
  1278.         if ( $value === array() ) {
  1279.             return $value;
  1280.         }
  1281.  
  1282.         if ( empty( $value['is_widget_customizer_js_value'] )
  1283.             || empty( $value['instance_hash_key'] )
  1284.             || empty( $value['encoded_serialized_instance'] ) )
  1285.         {
  1286.             return;
  1287.         }
  1288.  
  1289.         $decoded = base64_decode( $value['encoded_serialized_instance'], true );
  1290.         if ( false === $decoded ) {
  1291.             return;
  1292.         }
  1293.  
  1294.         if ( ! hash_equals( $this->get_instance_hash_key( $decoded ), $value['instance_hash_key'] ) ) {
  1295.             return;
  1296.         }
  1297.  
  1298.         $instance = unserialize( $decoded );
  1299.         if ( false === $instance ) {
  1300.             return;
  1301.         }
  1302.  
  1303.         return $instance;
  1304.     }
  1305.  
  1306.     /**
  1307.      * Converts a widget instance into JSON-representable format.
  1308.      *
  1309.      * @since 3.9.0
  1310.      *
  1311.      * @param array $value Widget instance to convert to JSON.
  1312.      * @return array JSON-converted widget instance.
  1313.      */
  1314.     public function sanitize_widget_js_instance( $value ) {
  1315.         if ( empty( $value['is_widget_customizer_js_value'] ) ) {
  1316.             $serialized = serialize( $value );
  1317.  
  1318.             $value = array(
  1319.                 'encoded_serialized_instance'   => base64_encode( $serialized ),
  1320.                 'title'                         => empty( $value['title'] ) ? '' : $value['title'],
  1321.                 'is_widget_customizer_js_value' => true,
  1322.                 'instance_hash_key'             => $this->get_instance_hash_key( $serialized ),
  1323.             );
  1324.         }
  1325.         return $value;
  1326.     }
  1327.  
  1328.     /**
  1329.      * Strips out widget IDs for widgets which are no longer registered.
  1330.      *
  1331.      * One example where this might happen is when a plugin orphans a widget
  1332.      * in a sidebar upon deactivation.
  1333.      *
  1334.      * @since 3.9.0
  1335.      *
  1336.      * @global array $wp_registered_widgets
  1337.      *
  1338.      * @param array $widget_ids List of widget IDs.
  1339.      * @return array Parsed list of widget IDs.
  1340.      */
  1341.     public function sanitize_sidebar_widgets_js_instance( $widget_ids ) {
  1342.         global $wp_registered_widgets;
  1343.         $widget_ids = array_values( array_intersect( $widget_ids, array_keys( $wp_registered_widgets ) ) );
  1344.         return $widget_ids;
  1345.     }
  1346.  
  1347.     /**
  1348.      * Finds and invokes the widget update and control callbacks.
  1349.      *
  1350.      * Requires that `$_POST` be populated with the instance data.
  1351.      *
  1352.      * @since 3.9.0
  1353.      *
  1354.      * @global array $wp_registered_widget_updates
  1355.      * @global array $wp_registered_widget_controls
  1356.      *
  1357.      * @param  string $widget_id Widget ID.
  1358.      * @return WP_Error|array Array containing the updated widget information.
  1359.      *                        A WP_Error object, otherwise.
  1360.      */
  1361.     public function call_widget_update( $widget_id ) {
  1362.         global $wp_registered_widget_updates, $wp_registered_widget_controls;
  1363.  
  1364.         $setting_id = $this->get_setting_id( $widget_id );
  1365.  
  1366.         /*
  1367.          * Make sure that other setting changes have previewed since this widget
  1368.          * may depend on them (e.g. Menus being present for Navigation Menu widget).
  1369.          */
  1370.         if ( ! did_action( 'customize_preview_init' ) ) {
  1371.             foreach ( $this->manager->settings() as $setting ) {
  1372.                 if ( $setting->id !== $setting_id ) {
  1373.                     $setting->preview();
  1374.                 }
  1375.             }
  1376.         }
  1377.  
  1378.         $this->start_capturing_option_updates();
  1379.         $parsed_id   = $this->parse_widget_id( $widget_id );
  1380.         $option_name = 'widget_' . $parsed_id['id_base'];
  1381.  
  1382.         /*
  1383.          * If a previously-sanitized instance is provided, populate the input vars
  1384.          * with its values so that the widget update callback will read this instance
  1385.          */
  1386.         $added_input_vars = array();
  1387.         if ( ! empty( $_POST['sanitized_widget_setting'] ) ) {
  1388.             $sanitized_widget_setting = json_decode( $this->get_post_value( 'sanitized_widget_setting' ), true );
  1389.             if ( false === $sanitized_widget_setting ) {
  1390.                 $this->stop_capturing_option_updates();
  1391.                 return new WP_Error( 'widget_setting_malformed' );
  1392.             }
  1393.  
  1394.             $instance = $this->sanitize_widget_instance( $sanitized_widget_setting );
  1395.             if ( is_null( $instance ) ) {
  1396.                 $this->stop_capturing_option_updates();
  1397.                 return new WP_Error( 'widget_setting_unsanitized' );
  1398.             }
  1399.  
  1400.             if ( ! is_null( $parsed_id['number'] ) ) {
  1401.                 $value = array();
  1402.                 $value[$parsed_id['number']] = $instance;
  1403.                 $key = 'widget-' . $parsed_id['id_base'];
  1404.                 $_REQUEST[$key] = $_POST[$key] = wp_slash( $value );
  1405.                 $added_input_vars[] = $key;
  1406.             } else {
  1407.                 foreach ( $instance as $key => $value ) {
  1408.                     $_REQUEST[$key] = $_POST[$key] = wp_slash( $value );
  1409.                     $added_input_vars[] = $key;
  1410.                 }
  1411.             }
  1412.         }
  1413.  
  1414.         // Invoke the widget update callback.
  1415.         foreach ( (array) $wp_registered_widget_updates as $name => $control ) {
  1416.             if ( $name === $parsed_id['id_base'] && is_callable( $control['callback'] ) ) {
  1417.                 ob_start();
  1418.                 call_user_func_array( $control['callback'], $control['params'] );
  1419.                 ob_end_clean();
  1420.                 break;
  1421.             }
  1422.         }
  1423.  
  1424.         // Clean up any input vars that were manually added
  1425.         foreach ( $added_input_vars as $key ) {
  1426.             unset( $_POST[ $key ] );
  1427.             unset( $_REQUEST[ $key ] );
  1428.         }
  1429.  
  1430.         // Make sure the expected option was updated.
  1431.         if ( 0 !== $this->count_captured_options() ) {
  1432.             if ( $this->count_captured_options() > 1 ) {
  1433.                 $this->stop_capturing_option_updates();
  1434.                 return new WP_Error( 'widget_setting_too_many_options' );
  1435.             }
  1436.  
  1437.             $updated_option_name = key( $this->get_captured_options() );
  1438.             if ( $updated_option_name !== $option_name ) {
  1439.                 $this->stop_capturing_option_updates();
  1440.                 return new WP_Error( 'widget_setting_unexpected_option' );
  1441.             }
  1442.         }
  1443.  
  1444.         // Obtain the widget instance.
  1445.         $option = $this->get_captured_option( $option_name );
  1446.         if ( null !== $parsed_id['number'] ) {
  1447.             $instance = $option[ $parsed_id['number'] ];
  1448.         } else {
  1449.             $instance = $option;
  1450.         }
  1451.  
  1452.         /*
  1453.          * Override the incoming $_POST['customized'] for a newly-created widget's
  1454.          * setting with the new $instance so that the preview filter currently
  1455.          * in place from WP_Customize_Setting::preview() will use this value
  1456.          * instead of the default widget instance value (an empty array).
  1457.          */
  1458.         $this->manager->set_post_value( $setting_id, $this->sanitize_widget_js_instance( $instance ) );
  1459.  
  1460.         // Obtain the widget control with the updated instance in place.
  1461.         ob_start();
  1462.         $form = $wp_registered_widget_controls[ $widget_id ];
  1463.         if ( $form ) {
  1464.             call_user_func_array( $form['callback'], $form['params'] );
  1465.         }
  1466.         $form = ob_get_clean();
  1467.  
  1468.         $this->stop_capturing_option_updates();
  1469.  
  1470.         return compact( 'instance', 'form' );
  1471.     }
  1472.  
  1473.     /**
  1474.      * Updates widget settings asynchronously.
  1475.      *
  1476.      * Allows the Customizer to update a widget using its form, but return the new
  1477.      * instance info via Ajax instead of saving it to the options table.
  1478.      *
  1479.      * Most code here copied from wp_ajax_save_widget().
  1480.      *
  1481.      * @since 3.9.0
  1482.      *
  1483.      * @see wp_ajax_save_widget()
  1484.      */
  1485.     public function wp_ajax_update_widget() {
  1486.  
  1487.         if ( ! is_user_logged_in() ) {
  1488.             wp_die( 0 );
  1489.         }
  1490.  
  1491.         check_ajax_referer( 'update-widget', 'nonce' );
  1492.  
  1493.         if ( ! current_user_can( 'edit_theme_options' ) ) {
  1494.             wp_die( -1 );
  1495.         }
  1496.  
  1497.         if ( empty( $_POST['widget-id'] ) ) {
  1498.             wp_send_json_error( 'missing_widget-id' );
  1499.         }
  1500.  
  1501.         /** This action is documented in wp-admin/includes/ajax-actions.php */
  1502.         do_action( 'load-widgets.php' );
  1503.  
  1504.         /** This action is documented in wp-admin/includes/ajax-actions.php */
  1505.         do_action( 'widgets.php' );
  1506.  
  1507.         /** This action is documented in wp-admin/widgets.php */
  1508.         do_action( 'sidebar_admin_setup' );
  1509.  
  1510.         $widget_id = $this->get_post_value( 'widget-id' );
  1511.         $parsed_id = $this->parse_widget_id( $widget_id );
  1512.         $id_base = $parsed_id['id_base'];
  1513.  
  1514.         $is_updating_widget_template = (
  1515.             isset( $_POST[ 'widget-' . $id_base ] )
  1516.             &&
  1517.             is_array( $_POST[ 'widget-' . $id_base ] )
  1518.             &&
  1519.             preg_match( '/__i__|%i%/', key( $_POST[ 'widget-' . $id_base ] ) )
  1520.         );
  1521.         if ( $is_updating_widget_template ) {
  1522.             wp_send_json_error( 'template_widget_not_updatable' );
  1523.         }
  1524.  
  1525.         $updated_widget = $this->call_widget_update( $widget_id ); // => {instance,form}
  1526.         if ( is_wp_error( $updated_widget ) ) {
  1527.             wp_send_json_error( $updated_widget->get_error_code() );
  1528.         }
  1529.  
  1530.         $form = $updated_widget['form'];
  1531.         $instance = $this->sanitize_widget_js_instance( $updated_widget['instance'] );
  1532.  
  1533.         wp_send_json_success( compact( 'form', 'instance' ) );
  1534.     }
  1535.  
  1536.     /*
  1537.      * Selective Refresh Methods
  1538.      */
  1539.  
  1540.     /**
  1541.      * Filters arguments for dynamic widget partials.
  1542.      *
  1543.      * @since 4.5.0
  1544.      *
  1545.      * @param array|false $partial_args Partial arguments.
  1546.      * @param string      $partial_id   Partial ID.
  1547.      * @return array (Maybe) modified partial arguments.
  1548.      */
  1549.     public function customize_dynamic_partial_args( $partial_args, $partial_id ) {
  1550.         if ( ! current_theme_supports( 'customize-selective-refresh-widgets' ) ) {
  1551.             return $partial_args;
  1552.         }
  1553.  
  1554.         if ( preg_match( '/^widget\[(?P<widget_id>.+)\]$/', $partial_id, $matches ) ) {
  1555.             if ( false === $partial_args ) {
  1556.                 $partial_args = array();
  1557.             }
  1558.             $partial_args = array_merge(
  1559.                 $partial_args,
  1560.                 array(
  1561.                     'type'                => 'widget',
  1562.                     'render_callback'     => array( $this, 'render_widget_partial' ),
  1563.                     'container_inclusive' => true,
  1564.                     'settings'            => array( $this->get_setting_id( $matches['widget_id'] ) ),
  1565.                     'capability'          => 'edit_theme_options',
  1566.                 )
  1567.             );
  1568.         }
  1569.  
  1570.         return $partial_args;
  1571.     }
  1572.  
  1573.     /**
  1574.      * Adds hooks for selective refresh.
  1575.      *
  1576.      * @since 4.5.0
  1577.      */
  1578.     public function selective_refresh_init() {
  1579.         if ( ! current_theme_supports( 'customize-selective-refresh-widgets' ) ) {
  1580.             return;
  1581.         }
  1582.         add_filter( 'dynamic_sidebar_params', array( $this, 'filter_dynamic_sidebar_params' ) );
  1583.         add_filter( 'wp_kses_allowed_html', array( $this, 'filter_wp_kses_allowed_data_attributes' ) );
  1584.         add_action( 'dynamic_sidebar_before', array( $this, 'start_dynamic_sidebar' ) );
  1585.         add_action( 'dynamic_sidebar_after', array( $this, 'end_dynamic_sidebar' ) );
  1586.     }
  1587.  
  1588.     /**
  1589.      * Inject selective refresh data attributes into widget container elements.
  1590.      *
  1591.      * @param array $params {
  1592.      *     Dynamic sidebar params.
  1593.      *
  1594.      *     @type array $args        Sidebar args.
  1595.      *     @type array $widget_args Widget args.
  1596.      * }
  1597.      * @see WP_Customize_Nav_Menus_Partial_Refresh::filter_wp_nav_menu_args()
  1598.      *
  1599.      * @return array Params.
  1600.      */
  1601.     public function filter_dynamic_sidebar_params( $params ) {
  1602.         $sidebar_args = array_merge(
  1603.             array(
  1604.                 'before_widget' => '',
  1605.                 'after_widget' => '',
  1606.             ),
  1607.             $params[0]
  1608.         );
  1609.  
  1610.         // Skip widgets not in a registered sidebar or ones which lack a proper wrapper element to attach the data-* attributes to.
  1611.         $matches = array();
  1612.         $is_valid = (
  1613.             isset( $sidebar_args['id'] )
  1614.             &&
  1615.             is_registered_sidebar( $sidebar_args['id'] )
  1616.             &&
  1617.             ( isset( $this->current_dynamic_sidebar_id_stack[0] ) && $this->current_dynamic_sidebar_id_stack[0] === $sidebar_args['id'] )
  1618.             &&
  1619.             preg_match( '#^<(?P<tag_name>\w+)#', $sidebar_args['before_widget'], $matches )
  1620.         );
  1621.         if ( ! $is_valid ) {
  1622.             return $params;
  1623.         }
  1624.         $this->before_widget_tags_seen[ $matches['tag_name'] ] = true;
  1625.  
  1626.         $context = array(
  1627.             'sidebar_id' => $sidebar_args['id'],
  1628.         );
  1629.         if ( isset( $this->context_sidebar_instance_number ) ) {
  1630.             $context['sidebar_instance_number'] = $this->context_sidebar_instance_number;
  1631.         } else if ( isset( $sidebar_args['id'] ) && isset( $this->sidebar_instance_count[ $sidebar_args['id'] ] ) ) {
  1632.             $context['sidebar_instance_number'] = $this->sidebar_instance_count[ $sidebar_args['id'] ];
  1633.         }
  1634.  
  1635.         $attributes = sprintf( ' data-customize-partial-id="%s"', esc_attr( 'widget[' . $sidebar_args['widget_id'] . ']' ) );
  1636.         $attributes .= ' data-customize-partial-type="widget"';
  1637.         $attributes .= sprintf( ' data-customize-partial-placement-context="%s"', esc_attr( wp_json_encode( $context ) ) );
  1638.         $attributes .= sprintf( ' data-customize-widget-id="%s"', esc_attr( $sidebar_args['widget_id'] ) );
  1639.         $sidebar_args['before_widget'] = preg_replace( '#^(<\w+)#', '$1 ' . $attributes, $sidebar_args['before_widget'] );
  1640.  
  1641.         $params[0] = $sidebar_args;
  1642.         return $params;
  1643.     }
  1644.  
  1645.     /**
  1646.      * List of the tag names seen for before_widget strings.
  1647.      *
  1648.      * This is used in the {@see 'filter_wp_kses_allowed_html'} filter to ensure that the
  1649.      * data-* attributes can be whitelisted.
  1650.      *
  1651.      * @since 4.5.0
  1652.      * @var array
  1653.      */
  1654.     protected $before_widget_tags_seen = array();
  1655.  
  1656.     /**
  1657.      * Ensures the HTML data-* attributes for selective refresh are allowed by kses.
  1658.      *
  1659.      * This is needed in case the `$before_widget` is run through wp_kses() when printed.
  1660.      *
  1661.      * @since 4.5.0
  1662.      *
  1663.      * @param array $allowed_html Allowed HTML.
  1664.      * @return array (Maybe) modified allowed HTML.
  1665.      */
  1666.     public function filter_wp_kses_allowed_data_attributes( $allowed_html ) {
  1667.         foreach ( array_keys( $this->before_widget_tags_seen ) as $tag_name ) {
  1668.             if ( ! isset( $allowed_html[ $tag_name ] ) ) {
  1669.                 $allowed_html[ $tag_name ] = array();
  1670.             }
  1671.             $allowed_html[ $tag_name ] = array_merge(
  1672.                 $allowed_html[ $tag_name ],
  1673.                 array_fill_keys( array(
  1674.                     'data-customize-partial-id',
  1675.                     'data-customize-partial-type',
  1676.                     'data-customize-partial-placement-context',
  1677.                     'data-customize-partial-widget-id',
  1678.                     'data-customize-partial-options',
  1679.                 ), true )
  1680.             );
  1681.         }
  1682.         return $allowed_html;
  1683.     }
  1684.  
  1685.     /**
  1686.      * Keep track of the number of times that dynamic_sidebar() was called for a given sidebar index.
  1687.      *
  1688.      * This helps facilitate the uncommon scenario where a single sidebar is rendered multiple times on a template.
  1689.      *
  1690.      * @since 4.5.0
  1691.      * @var array
  1692.      */
  1693.     protected $sidebar_instance_count = array();
  1694.  
  1695.     /**
  1696.      * The current request's sidebar_instance_number context.
  1697.      *
  1698.      * @since 4.5.0
  1699.      * @var int
  1700.      */
  1701.     protected $context_sidebar_instance_number;
  1702.  
  1703.     /**
  1704.      * Current sidebar ID being rendered.
  1705.      *
  1706.      * @since 4.5.0
  1707.      * @var array
  1708.      */
  1709.     protected $current_dynamic_sidebar_id_stack = array();
  1710.  
  1711.     /**
  1712.      * Begins keeping track of the current sidebar being rendered.
  1713.      *
  1714.      * Insert marker before widgets are rendered in a dynamic sidebar.
  1715.      *
  1716.      * @since 4.5.0
  1717.      *
  1718.      * @param int|string $index Index, name, or ID of the dynamic sidebar.
  1719.      */
  1720.     public function start_dynamic_sidebar( $index ) {
  1721.         array_unshift( $this->current_dynamic_sidebar_id_stack, $index );
  1722.         if ( ! isset( $this->sidebar_instance_count[ $index ] ) ) {
  1723.             $this->sidebar_instance_count[ $index ] = 0;
  1724.         }
  1725.         $this->sidebar_instance_count[ $index ] += 1;
  1726.         if ( ! $this->manager->selective_refresh->is_render_partials_request() ) {
  1727.             printf( "\n<!--dynamic_sidebar_before:%s:%d-->\n", esc_html( $index ), intval( $this->sidebar_instance_count[ $index ] ) );
  1728.         }
  1729.     }
  1730.  
  1731.     /**
  1732.      * Finishes keeping track of the current sidebar being rendered.
  1733.      *
  1734.      * Inserts a marker after widgets are rendered in a dynamic sidebar.
  1735.      *
  1736.      * @since 4.5.0
  1737.      *
  1738.      * @param int|string $index Index, name, or ID of the dynamic sidebar.
  1739.      */
  1740.     public function end_dynamic_sidebar( $index ) {
  1741.         array_shift( $this->current_dynamic_sidebar_id_stack );
  1742.         if ( ! $this->manager->selective_refresh->is_render_partials_request() ) {
  1743.             printf( "\n<!--dynamic_sidebar_after:%s:%d-->\n", esc_html( $index ), intval( $this->sidebar_instance_count[ $index ] ) );
  1744.         }
  1745.     }
  1746.  
  1747.     /**
  1748.      * Current sidebar being rendered.
  1749.      *
  1750.      * @since 4.5.0
  1751.      * @var string
  1752.      */
  1753.     protected $rendering_widget_id;
  1754.  
  1755.     /**
  1756.      * Current widget being rendered.
  1757.      *
  1758.      * @since 4.5.0
  1759.      * @var string
  1760.      */
  1761.     protected $rendering_sidebar_id;
  1762.  
  1763.     /**
  1764.      * Filters sidebars_widgets to ensure the currently-rendered widget is the only widget in the current sidebar.
  1765.      *
  1766.      * @since 4.5.0
  1767.      *
  1768.      * @param array $sidebars_widgets Sidebars widgets.
  1769.      * @return array Filtered sidebars widgets.
  1770.      */
  1771.     public function filter_sidebars_widgets_for_rendering_widget( $sidebars_widgets ) {
  1772.         $sidebars_widgets[ $this->rendering_sidebar_id ] = array( $this->rendering_widget_id );
  1773.         return $sidebars_widgets;
  1774.     }
  1775.  
  1776.     /**
  1777.      * Renders a specific widget using the supplied sidebar arguments.
  1778.      *
  1779.      * @since 4.5.0
  1780.      *
  1781.      * @see dynamic_sidebar()
  1782.      *
  1783.      * @param WP_Customize_Partial $partial Partial.
  1784.      * @param array                $context {
  1785.      *     Sidebar args supplied as container context.
  1786.      *
  1787.      *     @type string $sidebar_id              ID for sidebar for widget to render into.
  1788.      *     @type int    $sidebar_instance_number Disambiguating instance number.
  1789.      * }
  1790.      * @return string|false
  1791.      */
  1792.     public function render_widget_partial( $partial, $context ) {
  1793.         $id_data   = $partial->id_data();
  1794.         $widget_id = array_shift( $id_data['keys'] );
  1795.  
  1796.         if ( ! is_array( $context )
  1797.             || empty( $context['sidebar_id'] )
  1798.             || ! is_registered_sidebar( $context['sidebar_id'] )
  1799.         ) {
  1800.             return false;
  1801.         }
  1802.  
  1803.         $this->rendering_sidebar_id = $context['sidebar_id'];
  1804.  
  1805.         if ( isset( $context['sidebar_instance_number'] ) ) {
  1806.             $this->context_sidebar_instance_number = intval( $context['sidebar_instance_number'] );
  1807.         }
  1808.  
  1809.         // Filter sidebars_widgets so that only the queried widget is in the sidebar.
  1810.         $this->rendering_widget_id = $widget_id;
  1811.  
  1812.         $filter_callback = array( $this, 'filter_sidebars_widgets_for_rendering_widget' );
  1813.         add_filter( 'sidebars_widgets', $filter_callback, 1000 );
  1814.  
  1815.         // Render the widget.
  1816.         ob_start();
  1817.         dynamic_sidebar( $this->rendering_sidebar_id = $context['sidebar_id'] );
  1818.         $container = ob_get_clean();
  1819.  
  1820.         // Reset variables for next partial render.
  1821.         remove_filter( 'sidebars_widgets', $filter_callback, 1000 );
  1822.  
  1823.         $this->context_sidebar_instance_number = null;
  1824.         $this->rendering_sidebar_id = null;
  1825.         $this->rendering_widget_id = null;
  1826.  
  1827.         return $container;
  1828.     }
  1829.  
  1830.     //
  1831.     // Option Update Capturing
  1832.     //
  1833.  
  1834.     /**
  1835.      * List of captured widget option updates.
  1836.      *
  1837.      * @since 3.9.0
  1838.      * @var array $_captured_options Values updated while option capture is happening.
  1839.      */
  1840.     protected $_captured_options = array();
  1841.  
  1842.     /**
  1843.      * Whether option capture is currently happening.
  1844.      *
  1845.      * @since 3.9.0
  1846.      * @var bool $_is_current Whether option capture is currently happening or not.
  1847.      */
  1848.     protected $_is_capturing_option_updates = false;
  1849.  
  1850.     /**
  1851.      * Determines whether the captured option update should be ignored.
  1852.      *
  1853.      * @since 3.9.0
  1854.      *
  1855.      * @param string $option_name Option name.
  1856.      * @return bool Whether the option capture is ignored.
  1857.      */
  1858.     protected function is_option_capture_ignored( $option_name ) {
  1859.         return ( 0 === strpos( $option_name, '_transient_' ) );
  1860.     }
  1861.  
  1862.     /**
  1863.      * Retrieves captured widget option updates.
  1864.      *
  1865.      * @since 3.9.0
  1866.      *
  1867.      * @return array Array of captured options.
  1868.      */
  1869.     protected function get_captured_options() {
  1870.         return $this->_captured_options;
  1871.     }
  1872.  
  1873.     /**
  1874.      * Retrieves the option that was captured from being saved.
  1875.      *
  1876.      * @since 4.2.0
  1877.      *
  1878.      * @param string $option_name Option name.
  1879.      * @param mixed  $default     Optional. Default value to return if the option does not exist. Default false.
  1880.      * @return mixed Value set for the option.
  1881.      */
  1882.     protected function get_captured_option( $option_name, $default = false ) {
  1883.         if ( array_key_exists( $option_name, $this->_captured_options ) ) {
  1884.             $value = $this->_captured_options[ $option_name ];
  1885.         } else {
  1886.             $value = $default;
  1887.         }
  1888.         return $value;
  1889.     }
  1890.  
  1891.     /**
  1892.      * Retrieves the number of captured widget option updates.
  1893.      *
  1894.      * @since 3.9.0
  1895.      *
  1896.      * @return int Number of updated options.
  1897.      */
  1898.     protected function count_captured_options() {
  1899.         return count( $this->_captured_options );
  1900.     }
  1901.  
  1902.     /**
  1903.      * Begins keeping track of changes to widget options, caching new values.
  1904.      *
  1905.      * @since 3.9.0
  1906.      */
  1907.     protected function start_capturing_option_updates() {
  1908.         if ( $this->_is_capturing_option_updates ) {
  1909.             return;
  1910.         }
  1911.  
  1912.         $this->_is_capturing_option_updates = true;
  1913.  
  1914.         add_filter( 'pre_update_option', array( $this, 'capture_filter_pre_update_option' ), 10, 3 );
  1915.     }
  1916.  
  1917.     /**
  1918.      * Pre-filters captured option values before updating.
  1919.      *
  1920.      * @since 3.9.0
  1921.      *
  1922.      * @param mixed  $new_value   The new option value.
  1923.      * @param string $option_name Name of the option.
  1924.      * @param mixed  $old_value   The old option value.
  1925.      * @return mixed Filtered option value.
  1926.      */
  1927.     public function capture_filter_pre_update_option( $new_value, $option_name, $old_value ) {
  1928.         if ( $this->is_option_capture_ignored( $option_name ) ) {
  1929.             return;
  1930.         }
  1931.  
  1932.         if ( ! isset( $this->_captured_options[ $option_name ] ) ) {
  1933.             add_filter( "pre_option_{$option_name}", array( $this, 'capture_filter_pre_get_option' ) );
  1934.         }
  1935.  
  1936.         $this->_captured_options[ $option_name ] = $new_value;
  1937.  
  1938.         return $old_value;
  1939.     }
  1940.  
  1941.     /**
  1942.      * Pre-filters captured option values before retrieving.
  1943.      *
  1944.      * @since 3.9.0
  1945.      *
  1946.      * @param mixed $value Value to return instead of the option value.
  1947.      * @return mixed Filtered option value.
  1948.      */
  1949.     public function capture_filter_pre_get_option( $value ) {
  1950.         $option_name = preg_replace( '/^pre_option_/', '', current_filter() );
  1951.  
  1952.         if ( isset( $this->_captured_options[ $option_name ] ) ) {
  1953.             $value = $this->_captured_options[ $option_name ];
  1954.  
  1955.             /** This filter is documented in wp-includes/option.php */
  1956.             $value = apply_filters( 'option_' . $option_name, $value );
  1957.         }
  1958.  
  1959.         return $value;
  1960.     }
  1961.  
  1962.     /**
  1963.      * Undoes any changes to the options since options capture began.
  1964.      *
  1965.      * @since 3.9.0
  1966.      */
  1967.     protected function stop_capturing_option_updates() {
  1968.         if ( ! $this->_is_capturing_option_updates ) {
  1969.             return;
  1970.         }
  1971.  
  1972.         remove_filter( 'pre_update_option', array( $this, 'capture_filter_pre_update_option' ), 10 );
  1973.  
  1974.         foreach ( array_keys( $this->_captured_options ) as $option_name ) {
  1975.             remove_filter( "pre_option_{$option_name}", array( $this, 'capture_filter_pre_get_option' ) );
  1976.         }
  1977.  
  1978.         $this->_captured_options = array();
  1979.         $this->_is_capturing_option_updates = false;
  1980.     }
  1981.  
  1982.     /**
  1983.      * {@internal Missing Summary}
  1984.      *
  1985.      * See the {@see 'customize_dynamic_setting_args'} filter.
  1986.      *
  1987.      * @since 3.9.0
  1988.      * @deprecated 4.2.0 Deprecated in favor of the {@see 'customize_dynamic_setting_args'} filter.
  1989.      */
  1990.     public function setup_widget_addition_previews() {
  1991.         _deprecated_function( __METHOD__, '4.2.0', 'customize_dynamic_setting_args' );
  1992.     }
  1993.  
  1994.     /**
  1995.      * {@internal Missing Summary}
  1996.      *
  1997.      * See the {@see 'customize_dynamic_setting_args'} filter.
  1998.      *
  1999.      * @since 3.9.0
  2000.      * @deprecated 4.2.0 Deprecated in favor of the {@see 'customize_dynamic_setting_args'} filter.
  2001.      */
  2002.     public function prepreview_added_sidebars_widgets() {
  2003.         _deprecated_function( __METHOD__, '4.2.0', 'customize_dynamic_setting_args' );
  2004.     }
  2005.  
  2006.     /**
  2007.      * {@internal Missing Summary}
  2008.      *
  2009.      * See the {@see 'customize_dynamic_setting_args'} filter.
  2010.      *
  2011.      * @since 3.9.0
  2012.      * @deprecated 4.2.0 Deprecated in favor of the {@see 'customize_dynamic_setting_args'} filter.
  2013.      */
  2014.     public function prepreview_added_widget_instance() {
  2015.         _deprecated_function( __METHOD__, '4.2.0', 'customize_dynamic_setting_args' );
  2016.     }
  2017.  
  2018.     /**
  2019.      * {@internal Missing Summary}
  2020.      *
  2021.      * See the {@see 'customize_dynamic_setting_args'} filter.
  2022.      *
  2023.      * @since 3.9.0
  2024.      * @deprecated 4.2.0 Deprecated in favor of the {@see 'customize_dynamic_setting_args'} filter.
  2025.      */
  2026.     public function remove_prepreview_filters() {
  2027.         _deprecated_function( __METHOD__, '4.2.0', 'customize_dynamic_setting_args' );
  2028.     }
  2029. }
  2030.