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


Generated: Fri Nov 27 01:00:04 2020 Cross-referenced by PHPXref 0.7.1