WordPress.org

Make WordPress Core

Ticket #26661: widgets.php.4.patch

File widgets.php.4.patch, 2.4 KB (added by westonruter, 6 years ago)

Applying some more hook docs improvements gleaned from DrewAPicture in #25368

  • src/wp-admin/includes/widgets.php

     
    188188        $widget_title = esc_html( strip_tags( $sidebar_args['widget_name'] ) );
    189189        $has_form = 'noform';
    190190
    191         //temporary_hook #26661
    192         do_action( 'temp_wp_widget_control_before', $sidebar_args );
     191        /**
     192         * Invoked before wp_widget_control() echoes $before_widget. To filter
     193         * $sidebar_args, use dynamic_sidebar_params
     194         *
     195         * @since 3.9.0
     196         *
     197         * @see dynamic_sidebar_params
     198         *
     199         * @param array $sidebar_args {
     200         *     An associative array of sidebar arguments.
     201         *
     202         *     @type string $widget_id       ID of the widget.
     203         *     @type string $widget_name     Name of the widget.
     204         *     @type string $before_widget   HTML markup to prepend to each widget in the sidebar.
     205         *     @type string $after_widget    HTML markup to append to each widget in the sidebar.
     206         *     @type string $before_title    HTML markup to prepend to the widget title when displayed.
     207         *     @type string $after_title     HTML markup to append to the widget title when displayed.
     208         * }
     209         */
     210        do_action( 'wp_widget_control_before', $sidebar_args );
    193211
    194212        echo $sidebar_args['before_widget']; ?>
    195213        <div class="widget-top">
     
    241259<?php
    242260        echo $sidebar_args['after_widget'];
    243261
    244         //temporary_hook #26661
    245         do_action( 'temp_wp_widget_control_after', $sidebar_args, 'noform' !== $has_form );
     262        /**
     263         * Invoked after wp_widget_control() echoes $after_widget. To filter
     264         * $sidebar_args, use dynamic_sidebar_params.
     265         *
     266         * @since 3.9.0
     267         *
     268         * @see dynamic_sidebar_params
     269         *
     270         * @param array $sidebar_args {
     271         *     An associative array of sidebar arguments.
     272         *
     273         *     @type string $widget_id       ID of the widget.
     274         *     @type string $widget_name     Name of the widget.
     275         *     @type string $before_widget   HTML markup to prepend to each widget in the sidebar.
     276         *     @type string $after_widget    HTML markup to append to each widget in the sidebar.
     277         *     @type string $before_title    HTML markup to prepend to the widget title when displayed.
     278         *     @type string $after_title     HTML markup to append to the widget title when displayed.
     279         * }
     280         * @param boolean Whether the widget defined a form
     281         */
     282        do_action( 'wp_widget_control_after', $sidebar_args, 'noform' !== $has_form );
    246283
    247284        return $sidebar_args;
    248285}