WordPress.org

Make WordPress Core

Ticket #25752: 25752.diff

File 25752.diff, 6.3 KB (added by mauryaratan, 8 years ago)

Updated the docs

  • wp-admin/includes/dashboard.php

     
    5959        // Hook to register new widgets
    6060        // Filter widget order
    6161        if ( is_network_admin() ) {
     62                /**
     63                * Fires on dashboard widget setup for in the Multisite Network Admin.
     64                *
     65                * @since 3.1.0
     66                */
    6267                do_action( 'wp_network_dashboard_setup' );
     68
     69                /**
     70                 * Filters the list of Dashboard widgets to be added in the Multisite Network Admin.
     71                 *
     72                 * @since 3.1.0
     73                 *
     74                 * @param array An array of dashboard widgets to add in Multisite Network Admin.
     75                 */
    6376                $dashboard_widgets = apply_filters( 'wp_network_dashboard_widgets', array() );
    6477        } elseif ( is_user_admin() ) {
     78                /**
     79                 * Fires on dashboard widget setup in admin.
     80                 *
     81                 * @since 3.1.0
     82                 */
    6583                do_action( 'wp_user_dashboard_setup' );
     84
     85                /**
     86                 * Filters the list of Dashboard widgets to be added in admin.
     87                 *
     88                 * @since 3.1.0
     89                 *
     90                 * @param array An array of dashboard widget to add in admin.
     91                 */
    6692                $dashboard_widgets = apply_filters( 'wp_user_dashboard_widgets', array() );
    6793        } else {
     94                /**
     95                 * Fires on dashboard widget setup.
     96                 *
     97                 * @since 2.5.0
     98                 */
    6899                do_action( 'wp_dashboard_setup' );
     100
     101                /**
     102                 * Filters the list of Dashboard widgets.
     103                 *
     104                 * @since 2.5.0
     105                 *
     106                 * @param array An array of dashboard widget to add.
     107                 */
    69108                $dashboard_widgets = apply_filters( 'wp_dashboard_widgets', array() );
    70109        }
    71110
     
    259298        // activity_box_end has a core action, but only prints content when multisite.
    260299        // Using an output buffer is the only way to really check if anything's displayed here.
    261300        ob_start();
     301
     302        /**
     303        * Fires at the end of Right now dashboard widget.
     304        *
     305        * @since 2.5.0
     306        */
    262307        do_action( 'rightnow_end' );
     308
     309        /**
     310        * Fires at the end of Right now dashboard widget box.
     311        *
     312        * @since 2.0.0
     313        */
    263314        do_action( 'activity_box_end' );
    264315        $actions = ob_get_clean();
    265316
     
    297348        <br class="clear" />
    298349
    299350        <p class="youhave"><?php echo $sentence; ?></p>
    300         <?php do_action( 'wpmuadminresult', '' ); ?>
    301351
     352
     353        <?php
     354                /**
     355                 * Fires on Right now dashboard widget in Multisite Network Admin.
     356                 *
     357                 * Displaed after Network stats showing number of sites and users.
     358                 *
     359                 * @since 3.0.0
     360                 */
     361                do_action( 'wpmuadminresult', '' );
     362        ?>
     363
    302364        <form action="<?php echo network_admin_url('users.php'); ?>" method="get">
    303365                <p>
    304366                        <input type="search" name="s" value="" size="30" autocomplete="off" />
     
    313375                </p>
    314376        </form>
    315377<?php
     378        /**
     379        * Fires at the end of Right now dashboard widget in Multisite.
     380        *
     381        * @since 3.0.0
     382        */
     383
    316384        do_action( 'mu_rightnow_end' );
     385        /**
     386        * Fires at the end of Right now dashboard widget box in Multisite.
     387        *
     388        * @since 3.0.0
     389        */
    317390        do_action( 'mu_activity_box_end' );
    318391}
    319392
     
    355428                <?php endif; ?>
    356429
    357430                <div class="input-text-wrap" id="title-wrap">
    358                         <label class="screen-reader-text prompt" for="title" id="title-prompt-text"><?php echo apply_filters( 'enter_title_here', __( 'Title' ), $post ); ?></label>
     431                        <label class="screen-reader-text prompt" for="title" id="title-prompt-text">
     432                                <?php /** This filter is documented in wp-admin/edit-form-advanced.php */ ?>
     433                                <?php echo apply_filters( 'enter_title_here', __( 'Title' ), $post ); ?>
     434                        </label>
    359435                        <input type="text" name="post_title" id="title" autocomplete="off" />
    360436                </div>
    361437
     
    458534                else
    459535                        $actions['trash'] = "<a href='$trash_url' data-wp-lists='delete:the-comment-list:comment-$comment->comment_ID::trash=1' class='delete vim-d vim-destructive' title='" . esc_attr__( 'Move this comment to the trash' ) . "'>" . _x('Trash', 'verb') . '</a>';
    460536
     537                /**
     538                 * Filters the Recent Comments dashboard widget comment actions.
     539                 *
     540                 * Displays comment actions on Recent Comments dashboard widgets such as approve, edit etc.
     541                 *
     542                 * @since 2.6.0
     543                 *
     544                 * @param array  $actions An array of comment actions.
     545                 * @param object $comment The comment object.
     546                 */
    461547                $actions = apply_filters( 'comment_row_actions', array_filter($actions), $comment );
    462548
    463549                $i = 0;
     
    827913function wp_dashboard_primary() {
    828914        $feeds = array(
    829915                'news'   => array(
     916                        /**
     917                         * Filter the primary dashboard widget link.
     918                         *
     919                         * @since 2.5.0
     920                         *
     921                         * @param string Primary dashboard widget link.
     922                         */
    830923                        'link'         => apply_filters( 'dashboard_primary_link', __( 'http://wordpress.org/news/' ) ),
     924
     925                        /**
     926                         * Filter the primary dashboard widget feed.
     927                         *
     928                         * @since 2.3.0
     929                         *
     930                         * @param string Primary dashboard widget feed link.
     931                         */
    831932                        'url'          => apply_filters( 'dashboard_primary_feed', __( 'http://wordpress.org/news/feed/' ) ),
     933
     934                        /**
     935                         * Filter the primary dashboard widget title.
     936                         *
     937                         * @since 2.3.0
     938                         *
     939                         * @param string Primary dashboard widget title.
     940                         */
    832941                        'title'        => apply_filters( 'dashboard_primary_title', __( 'WordPress Blog' ) ),
    833942                        'items'        => 1,
    834943                        'show_summary' => 1,
     
    836945                        'show_date'    => 1,
    837946                ),
    838947                'planet' => array(
     948                        /**
     949                         * Filter the dashboard secondary widget title.
     950                         *
     951                         * @since 2.3.0
     952                         *
     953                         * @param string Secondary dashboard widget link.
     954                         */
    839955                        'link'         => apply_filters( 'dashboard_secondary_link', __( 'http://planet.wordpress.org/' ) ),
     956
     957                        /**
     958                         * Filter the dashboard secondary widget feed.
     959                         *
     960                         * @since 2.3.0
     961                         *
     962                         * @param string Secondary dashboard widget feed link.
     963                         */
    840964                        'url'          => apply_filters( 'dashboard_secondary_feed', __( 'http://planet.wordpress.org/feed/' ) ),
     965
     966                        /**
     967                         * Filter the dashboard secondary widget title.
     968                         *
     969                         * @since 2.3.0
     970                         *
     971                         * @param string Secondary dashboard widget title.
     972                         */
    841973                        'title'        => apply_filters( 'dashboard_secondary_title', __( 'Other WordPress News' ) ),
    842974                        'items'        => 3,
    843975                        'show_summary' => 0,
     
    10531185                $notice .= '<div class="clear"></div>';
    10541186        }
    10551187
     1188        /**
     1189        * Filters the browse happy notice for browser nag meta box.
     1190        *
     1191        * @since 3.2.0
     1192        *
     1193        * @param string $notice The content that will be printed.
     1194        * @param array $response An array containing web browser information.
     1195        */
    10561196        echo apply_filters( 'browse-happy-notice', $notice, $response );
    10571197}
    10581198