Changeset 51249

Timestamp:

06/28/2021 08:34:18 AM (3 years ago)

Author:

SergeyBiryukov

Message:

Docs: Update documentation for WP_Widget_Block per the documentation standards.

Remove unused $post global reference.

Follow-up to [50995], [51058], [51063], [51221].

See #52628, #53461.

File:

• trunk/src/wp-includes/widgets/class-wp-widget-block.php (modified) (7 diffs)

trunk/src/wp-includes/widgets/class-wp-widget-block.php

@@ -44 +44 @@
         );
         parent::__construct( 'block', __( 'Block' ), $widget_ops, $control_ops );
+
         add_filter( 'is_wide_widget_in_customizer', array( $this, 'set_is_wide_widget_in_customizer' ), 10, 2 );
     }
@@ -55 +56 @@
      *                        'before_widget', and 'after_widget'.
      * @param array $instance Settings for the current Block widget instance.
-     *
-     * @global WP_Post $post Global post object.
      */
     public function widget( $args, $instance ) {
@@ -89 +88 @@
      * Calculates the classname to use in the block widget's container HTML.
      *
-     * Usually this is set to $this->widget_options['classname'] by
+     * Usually this is set to `$this->widget_options['classname']` by
      * dynamic_sidebar(). In this case, however, we want to set the classname
      * dynamically depending on the block contained by this block widget.
@@ -100 +99 @@
      *
      * @param string $content The HTML content of the current block widget.
-     *
      * @return string The classname to use in the block widget's container HTML.
      */
@@ -158 +156 @@
          * The classname used in the block widget's container HTML.
          *
-         * This can be set according to the name of the block contained by the
-         * block widget.
+         * This can be set according to the name of the block contained by the block widget.
          *
          * @since 5.8.0
          *
-         * @param string $classname The classname to be used in the block widget's container HTML, e.g. 'widget_block widget_text'.
-         * @param string $block_name The name of the block contained by the block widget, e.g. 'core/paragraph'.
+         * @param string $classname  The classname to be used in the block widget's container HTML,
+         *                           e.g. 'widget_block widget_text'.
+         * @param string $block_name The name of the block contained by the block widget,
+         *                           e.g. 'core/paragraph'.
          */
         return apply_filters( 'widget_block_dynamic_classname', $classname, $block_name );
@@ -177 +176 @@
      *                            WP_Widget::form().
      * @param array $old_instance Old settings for this instance.
-     *
      * @return array Settings to save or bool false to cancel saving.
      */
@@ -207 +205 @@
 
     /**
-     * Make sure no block widget is considered to be wide.
-     *
-     * @since 5.8.0
-     *
-     * @param boolean $is_wide Is regarded wide.
-     * @param string  $widget_id Widget ID.
-     *
-     * @return bool Updated is_wide value.
+     * Makes sure no block widget is considered to be wide.
+     *
+     * @since 5.8.0
+     *
+     * @param bool   $is_wide   Whether the widget is considered wide.
+     * @param string $widget_id Widget ID.
+     * @return bool Updated `is_wide` value.
      */
     public function set_is_wide_widget_in_customizer( $is_wide, $widget_id ) {