WordPress.org

Make WordPress Core

Ticket #25752: 25752.2.diff

File 25752.2.diff, 8.9 KB (added by DrewAPicture, 8 years ago)

2nd pass

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

     
    5656        // WordPress News
    5757        wp_add_dashboard_widget( 'dashboard_primary', __( 'WordPress News' ), 'wp_dashboard_primary' );
    5858
    59         // Hook to register new widgets
    60         // Filter widget order
    6159        if ( is_network_admin() ) {
     60
     61                /**
     62                 * Fires on dashboard widget setup in the Network Admin dashboard.
     63                 *
     64                 * @since 3.1.0
     65                 */
    6266                do_action( 'wp_network_dashboard_setup' );
     67
     68                /**
     69                 * Filter the list of Network Admin dashboard widgets to load.
     70                 *
     71                 * @since 3.1.0
     72                 *
     73                 * @param array $dashboard_widgets An array of dashboard widgets.
     74                 */
    6375                $dashboard_widgets = apply_filters( 'wp_network_dashboard_widgets', array() );
    6476        } elseif ( is_user_admin() ) {
     77
     78                /**
     79                 * Fires on dashboard widget set up in the User Admin dashboard.
     80                 *
     81                 * @since 3.1.0
     82                 */
    6583                do_action( 'wp_user_dashboard_setup' );
     84
     85                /**
     86                 * Filter the list of User Admin dashboard widgets to load.
     87                 *
     88                 * @since 3.1.0
     89                 *
     90                 * @param array $dashboard_widgets An array of dashboard widgets.
     91                 */
    6692                $dashboard_widgets = apply_filters( 'wp_user_dashboard_widgets', array() );
    6793        } else {
     94
     95                /**
     96                 * Fires on dashboard widget set up in the Admin dashboard.
     97                 *
     98                 * @since 2.5.0
     99                 */
    68100                do_action( 'wp_dashboard_setup' );
     101
     102                /**
     103                 * Filter the list of Admin dashboard widgets to load.
     104                 *
     105                 * @since 2.5.0
     106                 *
     107                 * @param array $dashboard_widgets An array of dashboard widgets.
     108                 */
    69109                $dashboard_widgets = apply_filters( 'wp_dashboard_widgets', array() );
    70110        }
    71111
     
    165205
    166206}
    167207
    168 /* Dashboard Widgets */
     208//
     209// Dashboard Widgets
     210//
    169211
    170212/**
    171213 * Dashboard widget that displays some basic stats about the site.
     
    220262        }
    221263
    222264        /**
    223          * Include additional elements in the 'At a Glance' dashboard widget.
    224          * This widget was previously 'Right Now'.
     265         * Filter the array of extra elements to list in the 'At a Glance' dashboard widget.
    225266         *
     267         * Prior to 3.8.0, the widget was named 'Right Now'.
     268         *
    226269         * @since 3.8.0
    227          * @param array $items Array of items.
     270         *
     271         * @param array $items Array of extra 'At a Glance' widget items.
    228272         */
    229273        $elements = apply_filters( 'dashboard_glance_items', array() );
     274
    230275        if ( $elements ) {
    231276                echo '<li>' . implode( "</li>\n<li>", $elements ) . "</li>\n";
    232277        }
     
    240285        if ( ! is_network_admin() && ! is_user_admin() && current_user_can( 'manage_options' ) && '1' != get_option( 'blog_public' ) ) {
    241286
    242287                /**
    243                  * Filter the title attribute for the link displayed in Site Content metabox when search engines are discouraged from indexing the site.
     288                 * Filter the title attribute for the 'Search Engines Discouraged' link
     289                 * message displayed in the 'At a Glance' meta box.
    244290                 *
     291                 * Prior to 3.8.0, the widget was named 'Right Now'.
     292                 *
    245293                 * @since 3.0.0
    246294                 *
    247                  * @param string Default attribute text.
     295                 * @param string $title Default attribute text.
    248296                 */
    249297                $title = apply_filters( 'privacy_on_link_title', __( 'Your site is asking search engines not to index its content' ) );
    250298
    251299                /**
    252                  * Filter the text for the link displayed in Site Content metabox when search engines are discouraged from indexing the site.
     300                 * Filter the label for the 'Search Engines Discouraged' link displayed
     301                 * in the 'At a Glance' meta box.
    253302                 *
     303                 * Prior to 3.8.0, the widget was named 'Right Now'.
     304                 *
    254305                 * @since 3.0.0
    255306                 *
    256                  * @param string Default text.
     307                 * @param string $content Default text.
    257308                 */
    258309                $content = apply_filters( 'privacy_on_link_text' , __( 'Search Engines Discouraged' ) );
    259310
     
    265316        // activity_box_end has a core action, but only prints content when multisite.
    266317        // Using an output buffer is the only way to really check if anything's displayed here.
    267318        ob_start();
     319
     320        /**
     321         * Fires at the end of the 'At a Glance' dashboard widget.
     322         *
     323         * Prior to 3.8.0, the widget was named 'Right Now'.
     324         *
     325         * @since 2.0.0
     326         */
    268327        do_action( 'rightnow_end' );
     328
     329        /**
     330         * Fires at the end of the 'At a Glance' dashboard widget.
     331         *
     332         * Prior to 3.8.0, the widget was named 'Right Now'.
     333         *
     334         * @since 2.0.0
     335         */
    269336        do_action( 'activity_box_end' );
     337
    270338        $actions = ob_get_clean();
    271339
    272340        if ( !empty( $actions ) ) : ?>
     
    303371        <br class="clear" />
    304372
    305373        <p class="youhave"><?php echo $sentence; ?></p>
    306         <?php do_action( 'wpmuadminresult', '' ); ?>
    307374
     375
     376        <?php
     377                /**
     378                 * Fires in the Network Admin 'Right Now' dashboard widget
     379                 * just before the user and site search form fields.
     380                 *
     381                 * @since MU
     382                 *
     383                 * @param null $unused
     384                 */
     385                do_action( 'wpmuadminresult', '' );
     386        ?>
     387
    308388        <form action="<?php echo network_admin_url('users.php'); ?>" method="get">
    309389                <p>
    310390                        <input type="search" name="s" value="" size="30" autocomplete="off" />
     
    319399                </p>
    320400        </form>
    321401<?php
     402        /**
     403         * Fires at the end of the Network Admin 'Right Now' dashboard widget.
     404         *
     405         * @since MU
     406         */
    322407        do_action( 'mu_rightnow_end' );
     408
     409        /**
     410         * Fires at the end of the Network Admin 'Right Now' dashboard widget.
     411         *
     412         * @since MU
     413         */
    323414        do_action( 'mu_activity_box_end' );
    324415}
    325416
     
    361452                <?php endif; ?>
    362453
    363454                <div class="input-text-wrap" id="title-wrap">
    364                         <label class="screen-reader-text prompt" for="title" id="title-prompt-text"><?php echo apply_filters( 'enter_title_here', __( 'Title' ), $post ); ?></label>
     455                        <label class="screen-reader-text prompt" for="title" id="title-prompt-text">
     456
     457                                <?php
     458                                /** This filter is documented in wp-admin/edit-form-advanced.php */
     459                                echo apply_filters( 'enter_title_here', __( 'Title' ), $post );
     460                                ?>
     461                        </label>
    365462                        <input type="text" name="post_title" id="title" autocomplete="off" />
    366463                </div>
    367464
     
    464561                else
    465562                        $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>';
    466563
     564                /**
     565                 * Filter the comment row actions in the 'Recent Comments' dashboard widget.
     566                 *
     567                 * @since 2.6.0
     568                 *
     569                 * @param array  $actions An array of comment actions. Default actions include:
     570                 *                        'Approve', 'Unapprove', 'Edit', 'Reply', 'Spam',
     571                 *                        'Delete', and 'Trash'.
     572                 * @param object $comment The comment object.
     573                 */
    467574                $actions = apply_filters( 'comment_row_actions', array_filter($actions), $comment );
    468575
    469576                $i = 0;
     
    833940 */
    834941function wp_dashboard_primary() {
    835942        $feeds = array(
    836                 'news'   => array(
     943                'news' => array(
     944
     945                        /**
     946                         * Filter the primary link URL for the 'WordPress News' dashboard widget.
     947                         *
     948                         * @since 2.5.0
     949                         *
     950                         * @param string $link The widget's primary link URL.
     951                         */
    837952                        'link'         => apply_filters( 'dashboard_primary_link', __( 'http://wordpress.org/news/' ) ),
     953
     954                        /**
     955                         * Filter the primary feed URL for the 'WordPress News' dashboard widget.
     956                         *
     957                         * @since 2.3.0
     958                         *
     959                         * @param string $url The widget's primary feed URL.
     960                         */
    838961                        'url'          => apply_filters( 'dashboard_primary_feed', __( 'http://wordpress.org/news/feed/' ) ),
     962
     963                        /**
     964                         * Filter the primary link title for the 'WordPress News' dashboard widget.
     965                         *
     966                         * @since 2.3.0
     967                         *
     968                         * @param string $title Title attribute for the widget's primary link.
     969                         */
    839970                        'title'        => apply_filters( 'dashboard_primary_title', __( 'WordPress Blog' ) ),
    840971                        'items'        => 1,
    841972                        'show_summary' => 1,
     
    843974                        'show_date'    => 1,
    844975                ),
    845976                'planet' => array(
     977
     978                        /**
     979                         * Filter the secondary link URL for the 'WordPress News' dashboard widget.
     980                         *
     981                         * @since 2.3.0
     982                         *
     983                         * @param string $link The widget's secondary link URL.
     984                         */
    846985                        'link'         => apply_filters( 'dashboard_secondary_link', __( 'http://planet.wordpress.org/' ) ),
     986
     987                        /**
     988                         * Filter the secondary feed URL for the 'WordPress News' dashboard widget.
     989                         *
     990                         * @since 2.3.0
     991                         *
     992                         * @param string $url The widget's secondary feed URL.
     993                         */
    847994                        'url'          => apply_filters( 'dashboard_secondary_feed', __( 'http://planet.wordpress.org/feed/' ) ),
     995
     996                        /**
     997                         * Filter the secondary link title for the 'WordPress News' dashboard widget.
     998                         *
     999                         * @since 2.3.0
     1000                         *
     1001                         * @param string $title Title attribute for the widget's secondary link.
     1002                         */
    8481003                        'title'        => apply_filters( 'dashboard_secondary_title', __( 'Other WordPress News' ) ),
    8491004                        'items'        => 3,
    8501005                        'show_summary' => 0,
     
    10601215                $notice .= '<div class="clear"></div>';
    10611216        }
    10621217
     1218        /**
     1219        * Filter the notice output for the 'Browse Happy' nag meta box.
     1220        *
     1221        * @since 3.2.0
     1222        *
     1223        * @param string $notice   The outputted content.
     1224        * @param array  $response An array containing web browser information.
     1225        */
    10631226        echo apply_filters( 'browse-happy-notice', $notice, $response );
    10641227}
    10651228