[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

/wp-includes/widgets/ -> class-wp-widget-custom-html.php (source)

   1  <?php
   2  /**
   3   * Widget API: WP_Widget_Custom_HTML class
   4   *
   5   * @package WordPress
   6   * @subpackage Widgets
   7   * @since 4.8.1
   8   */
   9  
  10  /**
  11   * Core class used to implement a Custom HTML widget.
  12   *
  13   * @since 4.8.1
  14   *
  15   * @see WP_Widget
  16   */
  17  class WP_Widget_Custom_HTML extends WP_Widget {
  18  
  19      /**
  20       * Whether or not the widget has been registered yet.
  21       *
  22       * @since 4.9.0
  23       * @var bool
  24       */
  25      protected $registered = false;
  26  
  27      /**
  28       * Default instance.
  29       *
  30       * @since 4.8.1
  31       * @var array
  32       */
  33      protected $default_instance = array(
  34          'title'   => '',
  35          'content' => '',
  36      );
  37  
  38      /**
  39       * Sets up a new Custom HTML widget instance.
  40       *
  41       * @since 4.8.1
  42       */
  43  	public function __construct() {
  44          $widget_ops  = array(
  45              'classname'                   => 'widget_custom_html',
  46              'description'                 => __( 'Arbitrary HTML code.' ),
  47              'customize_selective_refresh' => true,
  48          );
  49          $control_ops = array(
  50              'width'  => 400,
  51              'height' => 350,
  52          );
  53          parent::__construct( 'custom_html', __( 'Custom HTML' ), $widget_ops, $control_ops );
  54      }
  55  
  56      /**
  57       * Add hooks for enqueueing assets when registering all widget instances of this widget class.
  58       *
  59       * @since 4.9.0
  60       *
  61       * @param integer $number Optional. The unique order number of this widget instance
  62       *                        compared to other instances of the same class. Default -1.
  63       */
  64  	public function _register_one( $number = -1 ) {
  65          parent::_register_one( $number );
  66          if ( $this->registered ) {
  67              return;
  68          }
  69          $this->registered = true;
  70  
  71          wp_add_inline_script( 'custom-html-widgets', sprintf( 'wp.customHtmlWidgets.idBases.push( %s );', wp_json_encode( $this->id_base ) ) );
  72  
  73          // Note that the widgets component in the customizer will also do the 'admin_print_scripts-widgets.php' action in WP_Customize_Widgets::print_scripts().
  74          add_action( 'admin_print_scripts-widgets.php', array( $this, 'enqueue_admin_scripts' ) );
  75  
  76          // Note that the widgets component in the customizer will also do the 'admin_footer-widgets.php' action in WP_Customize_Widgets::print_footer_scripts().
  77          add_action( 'admin_footer-widgets.php', array( 'WP_Widget_Custom_HTML', 'render_control_template_scripts' ) );
  78  
  79          // Note this action is used to ensure the help text is added to the end.
  80          add_action( 'admin_head-widgets.php', array( 'WP_Widget_Custom_HTML', 'add_help_text' ) );
  81      }
  82  
  83      /**
  84       * Filter gallery shortcode attributes.
  85       *
  86       * Prevents all of a site's attachments from being shown in a gallery displayed on a
  87       * non-singular template where a $post context is not available.
  88       *
  89       * @since 4.9.0
  90       *
  91       * @param array $attrs Attributes.
  92       * @return array Attributes.
  93       */
  94  	public function _filter_gallery_shortcode_attrs( $attrs ) {
  95          if ( ! is_singular() && empty( $attrs['id'] ) && empty( $attrs['include'] ) ) {
  96              $attrs['id'] = -1;
  97          }
  98          return $attrs;
  99      }
 100  
 101      /**
 102       * Outputs the content for the current Custom HTML widget instance.
 103       *
 104       * @since 4.8.1
 105       *
 106       * @global WP_Post $post Global post object.
 107       *
 108       * @param array $args     Display arguments including 'before_title', 'after_title',
 109       *                        'before_widget', and 'after_widget'.
 110       * @param array $instance Settings for the current Custom HTML widget instance.
 111       */
 112  	public function widget( $args, $instance ) {
 113          global $post;
 114  
 115          // Override global $post so filters (and shortcodes) apply in a consistent context.
 116          $original_post = $post;
 117          if ( is_singular() ) {
 118              // Make sure post is always the queried object on singular queries (not from another sub-query that failed to clean up the global $post).
 119              $post = get_queried_object();
 120          } else {
 121              // Nullify the $post global during widget rendering to prevent shortcodes from running with the unexpected context on archive queries.
 122              $post = null;
 123          }
 124  
 125          // Prevent dumping out all attachments from the media library.
 126          add_filter( 'shortcode_atts_gallery', array( $this, '_filter_gallery_shortcode_attrs' ) );
 127  
 128          $instance = array_merge( $this->default_instance, $instance );
 129  
 130          /** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */
 131          $title = apply_filters( 'widget_title', $instance['title'], $instance, $this->id_base );
 132  
 133          // Prepare instance data that looks like a normal Text widget.
 134          $simulated_text_widget_instance = array_merge(
 135              $instance,
 136              array(
 137                  'text'   => isset( $instance['content'] ) ? $instance['content'] : '',
 138                  'filter' => false, // Because wpautop is not applied.
 139                  'visual' => false, // Because it wasn't created in TinyMCE.
 140              )
 141          );
 142          unset( $simulated_text_widget_instance['content'] ); // Was moved to 'text' prop.
 143  
 144          /** This filter is documented in wp-includes/widgets/class-wp-widget-text.php */
 145          $content = apply_filters( 'widget_text', $instance['content'], $simulated_text_widget_instance, $this );
 146  
 147          // Adds noreferrer and noopener relationships, without duplicating values, to all HTML A elements that have a target.
 148          $content = wp_targeted_link_rel( $content );
 149  
 150          /**
 151           * Filters the content of the Custom HTML widget.
 152           *
 153           * @since 4.8.1
 154           *
 155           * @param string                $content  The widget content.
 156           * @param array                 $instance Array of settings for the current widget.
 157           * @param WP_Widget_Custom_HTML $this     Current Custom HTML widget instance.
 158           */
 159          $content = apply_filters( 'widget_custom_html_content', $content, $instance, $this );
 160  
 161          // Restore post global.
 162          $post = $original_post;
 163          remove_filter( 'shortcode_atts_gallery', array( $this, '_filter_gallery_shortcode_attrs' ) );
 164  
 165          // Inject the Text widget's container class name alongside this widget's class name for theme styling compatibility.
 166          $args['before_widget'] = preg_replace( '/(?<=\sclass=["\'])/', 'widget_text ', $args['before_widget'] );
 167  
 168          echo $args['before_widget'];
 169          if ( ! empty( $title ) ) {
 170              echo $args['before_title'] . $title . $args['after_title'];
 171          }
 172          echo '<div class="textwidget custom-html-widget">'; // The textwidget class is for theme styling compatibility.
 173          echo $content;
 174          echo '</div>';
 175          echo $args['after_widget'];
 176      }
 177  
 178      /**
 179       * Handles updating settings for the current Custom HTML widget instance.
 180       *
 181       * @since 4.8.1
 182       *
 183       * @param array $new_instance New settings for this instance as input by the user via
 184       *                            WP_Widget::form().
 185       * @param array $old_instance Old settings for this instance.
 186       * @return array Settings to save or bool false to cancel saving.
 187       */
 188  	public function update( $new_instance, $old_instance ) {
 189          $instance          = array_merge( $this->default_instance, $old_instance );
 190          $instance['title'] = sanitize_text_field( $new_instance['title'] );
 191          if ( current_user_can( 'unfiltered_html' ) ) {
 192              $instance['content'] = $new_instance['content'];
 193          } else {
 194              $instance['content'] = wp_kses_post( $new_instance['content'] );
 195          }
 196          return $instance;
 197      }
 198  
 199      /**
 200       * Loads the required scripts and styles for the widget control.
 201       *
 202       * @since 4.9.0
 203       */
 204  	public function enqueue_admin_scripts() {
 205          $settings = wp_enqueue_code_editor(
 206              array(
 207                  'type'       => 'text/html',
 208                  'codemirror' => array(
 209                      'indentUnit' => 2,
 210                      'tabSize'    => 2,
 211                  ),
 212              )
 213          );
 214  
 215          wp_enqueue_script( 'custom-html-widgets' );
 216          if ( empty( $settings ) ) {
 217              $settings = array(
 218                  'disabled' => true,
 219              );
 220          }
 221          wp_add_inline_script( 'custom-html-widgets', sprintf( 'wp.customHtmlWidgets.init( %s );', wp_json_encode( $settings ) ), 'after' );
 222  
 223          $l10n = array(
 224              'errorNotice' => array(
 225                  /* translators: %d: Error count. */
 226                  'singular' => _n( 'There is %d error which must be fixed before you can save.', 'There are %d errors which must be fixed before you can save.', 1 ),
 227                  /* translators: %d: Error count. */
 228                  'plural'   => _n( 'There is %d error which must be fixed before you can save.', 'There are %d errors which must be fixed before you can save.', 2 ), // @todo This is lacking, as some languages have a dedicated dual form. For proper handling of plurals in JS, see #20491.
 229              ),
 230          );
 231          wp_add_inline_script( 'custom-html-widgets', sprintf( 'jQuery.extend( wp.customHtmlWidgets.l10n, %s );', wp_json_encode( $l10n ) ), 'after' );
 232      }
 233  
 234      /**
 235       * Outputs the Custom HTML widget settings form.
 236       *
 237       * @since 4.8.1
 238       * @since 4.9.0 The form contains only hidden sync inputs. For the control UI, see `WP_Widget_Custom_HTML::render_control_template_scripts()`.
 239       *
 240       * @see WP_Widget_Custom_HTML::render_control_template_scripts()
 241       * @param array $instance Current instance.
 242       * @returns void
 243       */
 244  	public function form( $instance ) {
 245          $instance = wp_parse_args( (array) $instance, $this->default_instance );
 246          ?>
 247          <input id="<?php echo $this->get_field_id( 'title' ); ?>" name="<?php echo $this->get_field_name( 'title' ); ?>" class="title sync-input" type="hidden" value="<?php echo esc_attr( $instance['title'] ); ?>"/>
 248          <textarea id="<?php echo $this->get_field_id( 'content' ); ?>" name="<?php echo $this->get_field_name( 'content' ); ?>" class="content sync-input" hidden><?php echo esc_textarea( $instance['content'] ); ?></textarea>
 249          <?php
 250      }
 251  
 252      /**
 253       * Render form template scripts.
 254       *
 255       * @since 4.9.0
 256       */
 257  	public static function render_control_template_scripts() {
 258          ?>
 259          <script type="text/html" id="tmpl-widget-custom-html-control-fields">
 260              <# var elementIdPrefix = 'el' + String( Math.random() ).replace( /\D/g, '' ) + '_' #>
 261              <p>
 262                  <label for="{{ elementIdPrefix }}title"><?php esc_html_e( 'Title:' ); ?></label>
 263                  <input id="{{ elementIdPrefix }}title" type="text" class="widefat title">
 264              </p>
 265  
 266              <p>
 267                  <label for="{{ elementIdPrefix }}content" id="{{ elementIdPrefix }}content-label"><?php esc_html_e( 'Content:' ); ?></label>
 268                  <textarea id="{{ elementIdPrefix }}content" class="widefat code content" rows="16" cols="20"></textarea>
 269              </p>
 270  
 271              <?php if ( ! current_user_can( 'unfiltered_html' ) ) : ?>
 272                  <?php
 273                  $probably_unsafe_html = array( 'script', 'iframe', 'form', 'input', 'style' );
 274                  $allowed_html         = wp_kses_allowed_html( 'post' );
 275                  $disallowed_html      = array_diff( $probably_unsafe_html, array_keys( $allowed_html ) );
 276                  ?>
 277                  <?php if ( ! empty( $disallowed_html ) ) : ?>
 278                      <# if ( data.codeEditorDisabled ) { #>
 279                          <p>
 280                              <?php _e( 'Some HTML tags are not permitted, including:' ); ?>
 281                              <code><?php echo join( '</code>, <code>', $disallowed_html ); ?></code>
 282                          </p>
 283                      <# } #>
 284                  <?php endif; ?>
 285              <?php endif; ?>
 286  
 287              <div class="code-editor-error-container"></div>
 288          </script>
 289          <?php
 290      }
 291  
 292      /**
 293       * Add help text to widgets admin screen.
 294       *
 295       * @since 4.9.0
 296       */
 297  	public static function add_help_text() {
 298          $screen = get_current_screen();
 299  
 300          $content  = '<p>';
 301          $content .= __( 'Use the Custom HTML widget to add arbitrary HTML code to your widget areas.' );
 302          $content .= '</p>';
 303  
 304          if ( 'false' !== wp_get_current_user()->syntax_highlighting ) {
 305              $content .= '<p>';
 306              $content .= sprintf(
 307                  /* translators: 1: Link to user profile, 2: Additional link attributes, 3: Accessibility text. */
 308                  __( 'The edit field automatically highlights code syntax. You can disable this in your <a href="%1$s" %2$s>user profile%3$s</a> to work in plain text mode.' ),
 309                  esc_url( get_edit_profile_url() ),
 310                  'class="external-link" target="_blank"',
 311                  sprintf(
 312                      '<span class="screen-reader-text"> %s</span>',
 313                      /* translators: Accessibility text. */
 314                      __( '(opens in a new tab)' )
 315                  )
 316              );
 317              $content .= '</p>';
 318  
 319              $content .= '<p id="editor-keyboard-trap-help-1">' . __( 'When using a keyboard to navigate:' ) . '</p>';
 320              $content .= '<ul>';
 321              $content .= '<li id="editor-keyboard-trap-help-2">' . __( 'In the editing area, the Tab key enters a tab character.' ) . '</li>';
 322              $content .= '<li id="editor-keyboard-trap-help-3">' . __( 'To move away from this area, press the Esc key followed by the Tab key.' ) . '</li>';
 323              $content .= '<li id="editor-keyboard-trap-help-4">' . __( 'Screen reader users: when in forms mode, you may need to press the Esc key twice.' ) . '</li>';
 324              $content .= '</ul>';
 325          }
 326  
 327          $screen->add_help_tab(
 328              array(
 329                  'id'      => 'custom_html_widget',
 330                  'title'   => __( 'Custom HTML Widget' ),
 331                  'content' => $content,
 332              )
 333          );
 334      }
 335  }


Generated: Thu Sep 19 01:00:03 2019 Cross-referenced by PHPXref 0.7.1