Skip to:
Content

bbPress.org


Ignore:
Timestamp:
12/05/2025 02:27:53 AM (6 months ago)
Author:
johnjamesjacoby
Message:

Tools - Code Improvement: docs & code formatting improvements.

Props johnjamesjacoby, noruzzaman.

Fixes #3659.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/includes/common/widgets.php

    r7379 r7380  
    22
    33/**
    4  * bbPress Widgets
     4 * bbPress Widgets.
    55 *
    66 * Contains the forum list, topic list, reply list and login form widgets.
    … …  
    1414
    1515/**
    16  * bbPress Login Widget
    17  *
    18  * Adds a widget which displays the login form
     16 * bbPress Login Widget.
     17 *
     18 * Adds a widget which displays the login form.
    1919 *
    2020 * @since 2.0.0 bbPress (r2827)
    … …  
    2323
    2424    /**
    25      * bbPress Login Widget
    26      *
    27      * Registers the login widget
     25     * bbPress Login Widget.
     26     *
     27     * Registers the login widget.
    2828     *
    2929     * @since 2.0.0 bbPress (r2827)
    … …  
    4343
    4444    /**
    45      * Register the widget
     45     * Register the widget.
    4646     *
    4747     * @since 2.0.0 bbPress (r3389)
    … …  
    5252
    5353    /**
    54      * Displays the output, the login form
     54     * Displays the output, the login form.
    5555     *
    5656     * @since 2.0.0 bbPress (r2827)
    5757     *
    58      * @param array $args Arguments
    59      * @param array $instance Instance
     58     * @param array $args Arguments.
     59     * @param array $instance Instance.
    6060     */
    6161    public function widget( $args = array(), $instance = array() ) {
    … …  
    147147
    148148    /**
    149      * Update the login widget options
     149     * Update the login widget options.
    150150     *
    151151     * @since 2.0.0 bbPress (r2827)
    152152     *
    153      * @param array $new_instance The new instance options
    154      * @param array $old_instance The old instance options
     153     * @param array $new_instance The new instance options.
     154     * @param array $old_instance The old instance options.
    155155     */
    156156    public function update( $new_instance, $old_instance ) {
    … …  
    164164
    165165    /**
    166      * Output the login widget options form
     166     * Output the login widget options form.
    167167     *
    168168     * @since 2.0.0 bbPress (r2827)
    169169     *
    170      * @param $instance Instance
     170     * @param $instance Instance.
    171171     */
    172172    public function form( $instance = array() ) {
    … …  
    198198     * @since 2.3.0 bbPress (r4802)
    199199     *
    200      * @param $instance Instance
     200     * @param $instance Instance.
    201201     */
    202202    public function parse_settings( $instance = array() ) {
    … …  
    214214
    215215/**
    216  * bbPress Views Widget
    217  *
    218  * Adds a widget which displays the view list
     216 * bbPress Views Widget.
     217 *
     218 * Adds a widget which displays the view list.
    219219 *
    220220 * @since 2.0.0 bbPress (r3020)
    … …  
    223223
    224224    /**
    225      * bbPress View Widget
    226      *
    227      * Registers the view widget
     225     * bbPress View Widget.
     226     *
     227     * Registers the view widget.
    228228     *
    229229     * @since 2.0.0 bbPress (r3020)
    … …  
    243243
    244244    /**
    245      * Register the widget
     245     * Register the widget.
    246246     *
    247247     * @since 2.0.0 bbPress (r3389)
    … …  
    252252
    253253    /**
    254      * Displays the output, the view list
     254     * Displays the output, the view list.
    255255     *
    256256     * @since 2.0.0 bbPress (r3020)
    257257     *
    258      * @param array $args Arguments
    259      * @param array $instance Instance
     258     * @param array $args Arguments.
     259     * @param array $instance Instance.
    260260     */
    261261    public function widget( $args = array(), $instance = array() ) {
    … …  
    301301
    302302    /**
    303      * Update the view widget options
     303     * Update the view widget options.
    304304     *
    305305     * @since 2.0.0 bbPress (r3020)
    306306     *
    307      * @param array $new_instance The new instance options
    308      * @param array $old_instance The old instance options
     307     * @param array $new_instance The new instance options.
     308     * @param array $old_instance The old instance options.
    309309     */
    310310    public function update( $new_instance = array(), $old_instance = array() ) {
    … …  
    316316
    317317    /**
    318      * Output the view widget options form
     318     * Output the view widget options form.
    319319     *
    320320     * @since 2.0.0 bbPress (r3020)
    321321     *
    322      * @param $instance Instance
     322     * @param $instance Instance.
    323323     */
    324324    public function form( $instance = array() ) {
    … …  
    341341     * @since 2.3.0 bbPress (r4802)
    342342     *
    343      * @param $instance Instance
     343     * @param $instance Instance.
    344344     */
    345345    public function parse_settings( $instance = array() ) {
    … …  
    355355
    356356/**
    357  * bbPress Search Widget
    358  *
    359  * Adds a widget which displays the forum search form
     357 * bbPress Search Widget.
     358 *
     359 * Adds a widget which displays the forum search form.
    360360 *
    361361 * @since 2.3.0 bbPress (r4579)
    … …  
    364364
    365365    /**
    366      * bbPress Search Widget
    367      *
    368      * Registers the search widget
     366     * bbPress Search Widget.
     367     *
     368     * Registers the search widget.
    369369     *
    370370     * @since 2.3.0 bbPress (r4579)
    … …  
    384384
    385385    /**
    386      * Register the widget
     386     * Register the widget.
    387387     *
    388388     * @since 2.3.0 bbPress (r4579)
    … …  
    393393
    394394    /**
    395      * Displays the output, the search form
     395     * Displays the output, the search form.
    396396     *
    397397     * @since 2.3.0 bbPress (r4579)
    … …  
    425425
    426426    /**
    427      * Update the widget options
     427     * Update the widget options.
    428428     *
    429429     * @since 2.3.0 bbPress (r4579)
    430430     *
    431      * @param array $new_instance The new instance options
    432      * @param array $old_instance The old instance options
     431     * @param array $new_instance The new instance options.
     432     * @param array $old_instance The old instance options.
    433433     */
    434434    public function update( $new_instance, $old_instance ) {
    … …  
    440440
    441441    /**
    442      * Output the search widget options form
     442     * Output the search widget options form.
    443443     *
    444444     * @since 2.3.0 bbPress (r4579)
    445445     *
    446      * @param $instance Instance
     446     * @param $instance Instance.
    447447     */
    448448    public function form( $instance ) {
    … …  
    465465     * @since 2.3.0 bbPress (r4802)
    466466     *
    467      * @param $instance Instance
     467     * @param $instance Instance.
    468468     */
    469469    public function parse_settings( $instance = array() ) {
    … …  
    479479
    480480/**
    481  * bbPress Forum Widget
    482  *
    483  * Adds a widget which displays the forum list
     481 * bbPress Forum Widget.
     482 *
     483 * Adds a widget which displays the forum list.
    484484 *
    485485 * @since 2.0.0 bbPress (r2653)
    … …  
    488488
    489489    /**
    490      * bbPress Forum Widget
    491      *
    492      * Registers the forum widget
     490     * bbPress Forum Widget.
     491     *
     492     * Registers the forum widget.
    493493     *
    494494     * @since 2.0.0 bbPress (r2653)
    … …  
    508508
    509509    /**
    510      * Register the widget
     510     * Register the widget.
    511511     *
    512512     * @since 2.0.0 bbPress (r3389)
    … …  
    517517
    518518    /**
    519      * Displays the output, the forum list
     519     * Displays the output, the forum list.
    520520     *
    521521     * @since 2.0.0 bbPress (r2653)
    522522     *
    523      * @param array $args Arguments
    524      * @param array $instance Instance
     523     * @param array $args Arguments.
     524     * @param array $instance Instance.
    525525     */
    526526    public function widget( $args, $instance ) {
    … …  
    592592
    593593    /**
    594      * Update the forum widget options
     594     * Update the forum widget options.
    595595     *
    596596     * @since 2.0.0 bbPress (r2653)
    597597     *
    598      * @param array $new_instance The new instance options
    599      * @param array $old_instance The old instance options
     598     * @param array $new_instance The new instance options.
     599     * @param array $old_instance The old instance options.
    600600     */
    601601    public function update( $new_instance, $old_instance ) {
    … …  
    613613
    614614    /**
    615      * Output the forum widget options form
     615     * Output the forum widget options form.
    616616     *
    617617     * @since 2.0.0 bbPress (r2653)
    618618     *
    619      * @param $instance Instance
     619     * @param $instance Instance.
    620620     */
    621621    public function form( $instance ) {
    … …  
    648648     * @since 2.3.0 bbPress (r4802)
    649649     *
    650      * @param $instance Instance
     650     * @param $instance Instance.
    651651     */
    652652    public function parse_settings( $instance = array() ) {
    … …  
    663663
    664664/**
    665  * bbPress Topic Widget
    666  *
    667  * Adds a widget which displays the topic list
     665 * bbPress Topic Widget.
     666 *
     667 * Adds a widget which displays the topic list.
    668668 *
    669669 * @since 2.0.0 bbPress (r2653)
    … …  
    672672
    673673    /**
    674      * bbPress Topic Widget
    675      *
    676      * Registers the topic widget
     674     * bbPress Topic Widget.
     675     *
     676     * Registers the topic widget.
    677677     *
    678678     * @since 2.0.0 bbPress (r2653)
    … …  
    692692
    693693    /**
    694      * Register the widget
     694     * Register the widget.
    695695     *
    696696     * @since 2.0.0 bbPress (r3389)
    … …  
    701701
    702702    /**
    703      * Displays the output, the topic list
     703     * Displays the output, the topic list.
    704704     *
    705705     * @since 2.0.0 bbPress (r2653)
    … …  
    876876
    877877    /**
    878      * Update the topic widget options
     878     * Update the topic widget options.
    879879     *
    880880     * @since 2.0.0 bbPress (r2653)
    881881     *
    882      * @param array $new_instance The new instance options
    883      * @param array $old_instance The old instance options
     882     * @param array $new_instance The new instance options.
     883     * @param array $old_instance The old instance options.
    884884     */
    885885    public function update( $new_instance = array(), $old_instance = array() ) {
    … …  
    909909
    910910    /**
    911      * Output the topic widget options form
     911     * Output the topic widget options form.
    912912     *
    913913     * @since 2.0.0 bbPress (r2653)
    914914     *
    915      * @param $instance Instance
     915     * @param $instance Instance.
    916916     */
    917917    public function form( $instance = array() ) {
    … …  
    953953     * @since 2.3.0 bbPress (r4802)
    954954     *
    955      * @param $instance Instance
     955     * @param $instance Instance.
    956956     */
    957957    public function parse_settings( $instance = array() ) {
    … …  
    972972
    973973/**
    974  * bbPress Statistics Widget
    975  *
    976  * Adds a widget which displays the forum statistics
     974 * bbPress Statistics Widget.
     975 *
     976 * Adds a widget which displays the forum statistics.
    977977 *
    978978 * @since 2.3.0 bbPress (r4509)
    … …  
    981981
    982982    /**
    983      * bbPress Statistics Widget
    984      *
    985      * Registers the statistics widget
     983     * bbPress Statistics Widget.
     984     *
     985     * Registers the statistics widget.
    986986     *
    987987     * @since 2.3.0 bbPress (r4509)
    … …  
    10011001
    10021002    /**
    1003      * Register the widget
     1003     * Register the widget.
    10041004     *
    10051005     * @since 2.3.0 bbPress (r4509)
    … …  
    10101010
    10111011    /**
    1012      * Displays the output, the statistics
     1012     * Displays the output, the statistics.
    10131013     *
    10141014     * @since 2.3.0 bbPress (r4509)
    10151015     *
    1016      * @param array $args     Arguments
    1017      * @param array $instance Instance
     1016     * @param array $args     Arguments.
     1017     * @param array $instance Instance.
    10181018     */
    10191019    public function widget( $args = array(), $instance = array() ) {
    … …  
    10401040
    10411041    /**
    1042      * Update the statistics widget options
     1042     * Update the statistics widget options.
    10431043     *
    10441044     * @since 2.3.0 bbPress (r4509)
    10451045     *
    1046      * @param array $new_instance The new instance options
    1047      * @param array $old_instance The old instance options
     1046     * @param array $new_instance The new instance options.
     1047     * @param array $old_instance The old instance options.
    10481048     *
    10491049     * @return array
    … …  
    10571057
    10581058    /**
    1059      * Output the statistics widget options form
     1059     * Output the statistics widget options form.
    10601060     *
    10611061     * @since 2.3.0 bbPress (r4509)
    … …  
    10841084     * @since 2.3.0 bbPress (r4802)
    10851085     *
    1086      * @param $instance Instance
     1086     * @param $instance Instance.
    10871087     */
    10881088    public function parse_settings( $instance = array() ) {
    … …  
    10981098
    10991099/**
    1100  * bbPress Replies Widget
    1101  *
    1102  * Adds a widget which displays the replies list
     1100 * bbPress Replies Widget.
     1101 *
     1102 * Adds a widget which displays the replies list.
    11031103 *
    11041104 * @since 2.0.0 bbPress (r2653)
    … …  
    11071107
    11081108    /**
    1109      * bbPress Replies Widget
    1110      *
    1111      * Registers the replies widget
     1109     * bbPress Replies Widget.
     1110     *
     1111     * Registers the replies widget.
    11121112     *
    11131113     * @since 2.0.0 bbPress (r2653)
    … …  
    11271127
    11281128    /**
    1129      * Register the widget
     1129     * Register the widget.
    11301130     *
    11311131     * @since 2.0.0 bbPress (r3389)
    … …  
    11361136
    11371137    /**
    1138      * Displays the output, the replies list
     1138     * Displays the output, the replies list.
    11391139     *
    11401140     * @since 2.0.0 bbPress (r2653)
    … …  
    12541254
    12551255    /**
    1256      * Update the reply widget options
     1256     * Update the reply widget options.
    12571257     *
    12581258     * @since 2.0.0 bbPress (r2653)
    12591259     *
    1260      * @param array $new_instance The new instance options
    1261      * @param array $old_instance The old instance options
     1260     * @param array $new_instance The new instance options.
     1261     * @param array $old_instance The old instance options.
    12621262     */
    12631263    public function update( $new_instance = array(), $old_instance = array() ) {
    … …  
    12801280
    12811281    /**
    1282      * Output the reply widget options form
     1282     * Output the reply widget options form.
    12831283     *
    12841284     * @since 2.0.0 bbPress (r2653)
    12851285     *
    1286      * @param $instance Instance
     1286     * @param $instance Instance.
    12871287     */
    12881288    public function form( $instance = array() ) {
    … …  
    13041304     * @since 2.3.0 bbPress (r4802)
    13051305     *
    1306      * @param $instance Instance
     1306     * @param $instance Instance.
    13071307     */
    13081308    public function parse_settings( $instance = array() ) {
Note: See TracChangeset for help on using the changeset viewer.