WordPress.org

Make WordPress Core

Ticket #25752: 25752.3.diff

File 25752.3.diff, 9.5 KB (added by kpdesign, 8 years ago)

Third 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
     
    87127                update_option( 'dashboard_widget_options', $widget_options );
    88128
    89129        /** This action is documented in wp-admin/edit-form-advanced.php */
    90         do_action('do_meta_boxes', $screen->id, 'normal', '');
     130        do_action( 'do_meta_boxes', $screen->id, 'normal', '' );
     131
    91132        /** This action is documented in wp-admin/edit-form-advanced.php */
    92         do_action('do_meta_boxes', $screen->id, 'side', '');
     133        do_action( 'do_meta_boxes', $screen->id, 'side', '' );
    93134}
    94135
    95136function wp_add_dashboard_widget( $widget_id, $widget_name, $callback, $control_callback = null, $callback_args = null ) {
     
    165206
    166207}
    167208
    168 /* Dashboard Widgets */
     209//
     210// Dashboard Widgets
     211//
    169212
    170213/**
    171214 * Dashboard widget that displays some basic stats about the site.
     
    220263        }
    221264
    222265        /**
    223          * Include additional elements in the 'At a Glance' dashboard widget.
    224          * This widget was previously 'Right Now'.
     266         * Filter the array of extra elements to list in the 'At a Glance' dashboard widget.
    225267         *
     268         * Prior to 3.8.0, the widget was named 'Right Now'.
     269         *
    226270         * @since 3.8.0
    227          * @param array $items Array of items.
     271         *
     272         * @param array $items Array of extra 'At a Glance' widget items.
    228273         */
    229274        $elements = apply_filters( 'dashboard_glance_items', array() );
     275
    230276        if ( $elements ) {
    231277                echo '<li>' . implode( "</li>\n<li>", $elements ) . "</li>\n";
    232278        }
     
    240286        if ( ! is_network_admin() && ! is_user_admin() && current_user_can( 'manage_options' ) && '1' != get_option( 'blog_public' ) ) {
    241287
    242288                /**
    243                  * Filter the title attribute for the link displayed in Site Content metabox when search engines are discouraged from indexing the site.
     289                 * Filter the title attribute for the 'Search Engines Discouraged' link
     290                 * message displayed in the 'At a Glance' dashboard widget.
    244291                 *
     292                 * Prior to 3.8.0, the widget was named 'Right Now'.
     293                 *
    245294                 * @since 3.0.0
    246295                 *
    247                  * @param string Default attribute text.
     296                 * @param string $title Default attribute text.
    248297                 */
    249298                $title = apply_filters( 'privacy_on_link_title', __( 'Your site is asking search engines not to index its content' ) );
    250299
    251300                /**
    252                  * Filter the text for the link displayed in Site Content metabox when search engines are discouraged from indexing the site.
     301                 * Filter the label for the 'Search Engines Discouraged' link displayed
     302                 * in the 'At a Glance' dashboard widget.
    253303                 *
     304                 * Prior to 3.8.0, the widget was named 'Right Now'.
     305                 *
    254306                 * @since 3.0.0
    255307                 *
    256                  * @param string Default text.
     308                 * @param string $content Default text.
    257309                 */
    258310                $content = apply_filters( 'privacy_on_link_text' , __( 'Search Engines Discouraged' ) );
    259311
     
    265317        // activity_box_end has a core action, but only prints content when multisite.
    266318        // Using an output buffer is the only way to really check if anything's displayed here.
    267319        ob_start();
     320
     321        /**
     322         * Fires at the end of the 'At a Glance' dashboard widget.
     323         *
     324         * Prior to 3.8.0, the widget was named 'Right Now'.
     325         *
     326         * @since 2.5.0
     327         */
    268328        do_action( 'rightnow_end' );
     329
     330        /**
     331         * Fires at the end of the 'At a Glance' dashboard widget.
     332         *
     333         * Prior to 3.8.0, the widget was named 'Right Now'.
     334         *
     335         * @since 2.0.0
     336         */
    269337        do_action( 'activity_box_end' );
     338
    270339        $actions = ob_get_clean();
    271340
    272341        if ( !empty( $actions ) ) : ?>
     
    303372        <br class="clear" />
    304373
    305374        <p class="youhave"><?php echo $sentence; ?></p>
    306         <?php do_action( 'wpmuadminresult', '' ); ?>
    307375
     376
     377        <?php
     378                /**
     379                 * Fires in the Network Admin 'Right Now' dashboard widget
     380                 * just before the user and site search form fields.
     381                 *
     382                 * @since MU
     383                 *
     384                 * @param null $unused
     385                 */
     386                do_action( 'wpmuadminresult', '' );
     387        ?>
     388
    308389        <form action="<?php echo network_admin_url('users.php'); ?>" method="get">
    309390                <p>
    310391                        <input type="search" name="s" value="" size="30" autocomplete="off" />
     
    319400                </p>
    320401        </form>
    321402<?php
     403        /**
     404         * Fires at the end of the Network Admin 'Right Now' dashboard widget.
     405         *
     406         * @since MU
     407         */
    322408        do_action( 'mu_rightnow_end' );
     409
     410        /**
     411         * Fires at the end of the Network Admin 'Right Now' dashboard widget.
     412         *
     413         * @since MU
     414         */
    323415        do_action( 'mu_activity_box_end' );
    324416}
    325417
     
    361453                <?php endif; ?>
    362454
    363455                <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>
     456                        <label class="screen-reader-text prompt" for="title" id="title-prompt-text">
     457
     458                                <?php
     459                                /** This filter is documented in wp-admin/edit-form-advanced.php */
     460                                echo apply_filters( 'enter_title_here', __( 'Title' ), $post );
     461                                ?>
     462                        </label>
    365463                        <input type="text" name="post_title" id="title" autocomplete="off" />
    366464                </div>
    367465
     
    464562                else
    465563                        $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>';
    466564
     565                /**
     566                 * Filter the action links displayed for each comment in the 'Recent Comments'
     567                 * dashboard widget.
     568                 *
     569                 * @since 2.6.0
     570                 *
     571                 * @param array  $actions An array of comment actions. Default actions include:
     572                 *                        'Approve', 'Unapprove', 'Edit', 'Reply', 'Spam',
     573                 *                        'Delete', and 'Trash'.
     574                 * @param object $comment The comment object.
     575                 */
    467576                $actions = apply_filters( 'comment_row_actions', array_filter($actions), $comment );
    468577
    469578                $i = 0;
     
    833942 */
    834943function wp_dashboard_primary() {
    835944        $feeds = array(
    836                 'news'   => array(
     945                'news' => array(
     946
     947                        /**
     948                         * Filter the primary link URL for the 'WordPress News' dashboard widget.
     949                         *
     950                         * @since 2.5.0
     951                         *
     952                         * @param string $link The widget's primary link URL.
     953                         */
    837954                        'link'         => apply_filters( 'dashboard_primary_link', __( 'http://wordpress.org/news/' ) ),
     955
     956                        /**
     957                         * Filter the primary feed URL for the 'WordPress News' dashboard widget.
     958                         *
     959                         * @since 2.3.0
     960                         *
     961                         * @param string $url The widget's primary feed URL.
     962                         */
    838963                        'url'          => apply_filters( 'dashboard_primary_feed', __( 'http://wordpress.org/news/feed/' ) ),
     964
     965                        /**
     966                         * Filter the primary link title for the 'WordPress News' dashboard widget.
     967                         *
     968                         * @since 2.3.0
     969                         *
     970                         * @param string $title Title attribute for the widget's primary link.
     971                         */
    839972                        'title'        => apply_filters( 'dashboard_primary_title', __( 'WordPress Blog' ) ),
    840973                        'items'        => 1,
    841974                        'show_summary' => 1,
     
    843976                        'show_date'    => 1,
    844977                ),
    845978                'planet' => array(
     979
     980                        /**
     981                         * Filter the secondary link URL for the 'WordPress News' dashboard widget.
     982                         *
     983                         * @since 2.3.0
     984                         *
     985                         * @param string $link The widget's secondary link URL.
     986                         */
    846987                        'link'         => apply_filters( 'dashboard_secondary_link', __( 'http://planet.wordpress.org/' ) ),
     988
     989                        /**
     990                         * Filter the secondary feed URL for the 'WordPress News' dashboard widget.
     991                         *
     992                         * @since 2.3.0
     993                         *
     994                         * @param string $url The widget's secondary feed URL.
     995                         */
    847996                        'url'          => apply_filters( 'dashboard_secondary_feed', __( 'http://planet.wordpress.org/feed/' ) ),
     997
     998                        /**
     999                         * Filter the secondary link title for the 'WordPress News' dashboard widget.
     1000                         *
     1001                         * @since 2.3.0
     1002                         *
     1003                         * @param string $title Title attribute for the widget's secondary link.
     1004                         */
    8481005                        'title'        => apply_filters( 'dashboard_secondary_title', __( 'Other WordPress News' ) ),
    8491006                        'items'        => 3,
    8501007                        'show_summary' => 0,
     
    10601217                $notice .= '<div class="clear"></div>';
    10611218        }
    10621219
     1220        /**
     1221        * Filter the notice output for the 'Browse Happy' nag meta box.
     1222        *
     1223        * @since 3.2.0
     1224        *
     1225        * @param string $notice   The notice content.
     1226        * @param array  $response An array containing web browser information.
     1227        */
    10631228        echo apply_filters( 'browse-happy-notice', $notice, $response );
    10641229}
    10651230