WordPress.org
Get WordPress

Make WordPress Core

Changeset 30679


Ignore:
Timestamp:
12/01/2014 12:32:19 AM (10 years ago)
Author:
wonderboymusic
Message:

Improve various @param docs for List Tables.

See #30224.

Location:
trunk/src/wp-admin/includes
Files:
10 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-admin/includes/class-wp-list-table.php

    r30648 r30679  
    480480     * @since 3.1.0
    481481     * @access protected
     482     *
     483     * @param string $post_type
    482484     */
    483485    protected function months_dropdown( $post_type ) {
    … …  
    536538     * @since 3.1.0
    537539     * @access protected
     540     *
     541     * @param string $current_mode
    538542     */
    539543    protected function view_switcher( $current_mode ) {
    … …  
    602606     * @access protected
    603607     *
     608     * @param string $option
     609     * @param int    $default
    604610     * @return int
    605611     */
    … …  
    630636     * @since 3.1.0
    631637     * @access protected
     638     *
     639     * @param string $which
    632640     */
    633641    protected function pagination( $which ) {
    … …  
    930938     * @since 3.1.0
    931939     * @access protected
     940     * @param string $which
    932941     */
    933942    protected function display_tablenav( $which ) {
    … …  
    955964     * @since 3.1.0
    956965     * @access protected
     966     *
     967     * @param string $which
    957968     */
    958969    protected function extra_tablenav( $which ) {}

  • trunk/src/wp-admin/includes/class-wp-media-list-table.php

    r30661 r30679  
    105105    }
    106106
     107    /**
     108     * @param string $which
     109     */
    107110    protected function extra_tablenav( $which ) {
    108111        if ( 'bar' !== $which ) {
    … …  
    147150    }
    148151
     152    /**
     153     * @param string $which
     154     */
    149155    protected function pagination( $which ) {
    150         global $mode;
    151 
    152156        parent::pagination( $which );
    153157    }
    … …  
    494498    }
    495499
     500    /**
     501     * @param WP_Post $post
     502     * @param string  $att_title
     503     */
    496504    private function _get_row_actions( $post, $att_title ) {
    497505        $actions = array();

  • trunk/src/wp-admin/includes/class-wp-ms-sites-list-table.php

    r29707 r30679  
    147147    }
    148148
     149    /**
     150     * @param string $which
     151     */
    149152    protected function pagination( $which ) {
    150153        global $mode;

  • trunk/src/wp-admin/includes/class-wp-ms-themes-list-table.php

    r30648 r30679  
    143143    }
    144144
     145    /**
     146     * @staticvar string $term
     147     * @param WP_Theme $theme
     148     * @return bool
     149     */
    145150    public function _search_callback( $theme ) {
    146151        static $term;
    … …  
    164169
    165170    // Not used by any core columns.
     171    /**
     172     * @global string $orderby
     173     * @global string $order
     174     * @param array $theme_a
     175     * @param array $theme_b
     176     * @return int
     177     */
    166178    public function _order_callback( $theme_a, $theme_b ) {
    167179        global $orderby, $order;
    … …  
    267279    }
    268280
     281    /**
     282     * @global string $status
     283     * @global int $page
     284     * @global string $s
     285     * @global array $totals
     286     * @param WP_Theme $theme
     287     */
    269288    public function single_row( $theme ) {
    270289        global $status, $page, $s, $totals;

  • trunk/src/wp-admin/includes/class-wp-ms-users-list-table.php

    r29206 r30679  
    103103    }
    104104
     105    /**
     106     * @global string $mode
     107     * @param string $which
     108     */
    105109    protected function pagination( $which ) {
    106110        global $mode;

  • trunk/src/wp-admin/includes/class-wp-plugin-install-list-table.php

    r30648 r30679  
    269269    }
    270270
     271    /**
     272     * @param string $which
     273     */
    271274    protected function display_tablenav( $which ) {
    272275        if ( $GLOBALS['tab'] === 'featured' ) {
    … …  
    307310    }
    308311
     312    /**
     313     * @param object $plugin_a
     314     * @param object $plugin_b
     315     * @return int
     316     */
    309317    private function order_callback( $plugin_a, $plugin_b ) {
    310318        $orderby = $this->orderby;

  • trunk/src/wp-admin/includes/class-wp-plugins-list-table.php

    r30648 r30679  
    192192    }
    193193
     194    /**
     195     * @staticvar string $term
     196     * @param array $plugin
     197     * @return boolean
     198     */
    194199    public function _search_callback( $plugin ) {
    195200        static $term;
    … …  
    206211    }
    207212
     213    /**
     214     * @global string $orderby
     215     * @global string $order
     216     * @param array $plugin_a
     217     * @param array $plugin_b
     218     * @return int
     219     */
    208220    public function _order_callback( $plugin_a, $plugin_b ) {
    209221        global $orderby, $order;
    … …  
    309321    }
    310322
     323    /**
     324     * @global string $status
     325     * @param string $which
     326     * @return null
     327     */
    311328    public function bulk_actions( $which = '' ) {
    312329        global $status;
    … …  
    318335    }
    319336
     337    /**
     338     * @global string $status
     339     * @param string $which
     340     * @return null
     341     */
    320342    protected function extra_tablenav( $which ) {
    321343        global $status;
    … …  
    353375    }
    354376
     377    /**
     378     * @global string $status
     379     * @global int $page
     380     * @global string $s
     381     * @global array $totals
     382     * @param array $item
     383     */
    355384    public function single_row( $item ) {
    356385        global $status, $page, $s, $totals;

  • trunk/src/wp-admin/includes/class-wp-posts-list-table.php

    r30648 r30679  
    218218    }
    219219
     220    /**
     221     * @global int $cat
     222     * @param string $which
     223     */
    220224    protected function extra_tablenav( $which ) {
    221225        global $cat;
    … …  
    269273    }
    270274
     275    /**
     276     * @global string $mode
     277     * @param string $which
     278     */
    271279    protected function pagination( $which ) {
    272280        global $mode;
    … …  
    376384    }
    377385
     386    /**
     387     * @global WP_Query $wp_query
     388     * @global int $per_page
     389     * @param array $posts
     390     * @param int $level
     391     */
    378392    public function display_rows( $posts = array(), $level = 0 ) {
    379393        global $wp_query, $per_page;
    … …  
    391405    }
    392406
     407    /**
     408     * @global string $mode
     409     * @param array $posts
     410     * @param int $level
     411     */
    393412    private function _display_rows( $posts, $level = 0 ) {
    394413        global $mode;
    … …  
    406425    }
    407426
     427    /**
     428     * @global wpdb $wpdb
     429     * @param array $pages
     430     * @param int $pagenum
     431     * @param int $per_page
     432     * @return bool|null
     433     */
    408434    private function _display_rows_hierarchical( $pages, $pagenum = 1, $per_page = 20 ) {
    409435        global $wpdb;
    … …  
    543569    }
    544570
     571    /**
     572     * @global string $mode
     573     * @staticvar string $alternate
     574     * @param WP_Post $post
     575     * @param int $level
     576     */
    545577    public function single_row( $post, $level = 0 ) {
    546578        global $mode;

  • trunk/src/wp-admin/includes/class-wp-terms-list-table.php

    r30648 r30679  
    203203    }
    204204
     205    /**
     206     * @param string $taxonomy
     207     * @param array $terms
     208     * @param array $children
     209     * @param int $start
     210     * @param int $per_page
     211     * @param int $count
     212     * @param int $parent
     213     * @param int $level
     214     */
    205215    private function _rows( $taxonomy, $terms, &$children, $start, $per_page, &$count, $parent = 0, $level = 0 ) {
    206216
    … …  
    251261    }
    252262
     263    /**
     264     * @global string $taxonomy
     265     * @staticvar string $row_class
     266     * @param object $tag
     267     * @param int $level
     268     */
    253269    public function single_row( $tag, $level = 0 ) {
    254270        global $taxonomy;
    … …  
    265281    }
    266282
     283    /**
     284     * @param object $tag
     285     * @return string
     286     */
    267287    public function column_cb( $tag ) {
    268288        $default_term = get_option( 'default_' . $this->screen->taxonomy );
    … …  
    275295    }
    276296
     297    /**
     298     * @param object $tag
     299     * @return string
     300     */
    277301    public function column_name( $tag ) {
    278302        $taxonomy = $this->screen->taxonomy;
    … …  
    349373    }
    350374
     375    /**
     376     * @param object $tag
     377     * @return string
     378     */
    351379    public function column_description( $tag ) {
    352380        return $tag->description;
    353381    }
    354382
     383    /**
     384     * @param object $tag
     385     * @return string
     386     */
    355387    public function column_slug( $tag ) {
    356388        /** This filter is documented in wp-admin/edit-tag-form.php */
    … …  
    358390    }
    359391
     392    /**
     393     * @param object $tag
     394     * @return string
     395     */
    360396    public function column_posts( $tag ) {
    361397        $count = number_format_i18n( $tag->count );
    … …  
    382418    }
    383419
     420    /**
     421     * @param object $tag
     422     * @return string
     423     */
    384424    public function column_links( $tag ) {
    385425        $count = number_format_i18n( $tag->count );
    … …  
    389429    }
    390430
     431    /**
     432     * @param object $tag
     433     * @param string $column_name
     434     * @return string
     435     */
    391436    public function column_default( $tag, $column_name ) {
    392437        /**

  • trunk/src/wp-admin/includes/class-wp-themes-list-table.php

    r30105 r30679  
    9696    }
    9797
     98    /**
     99     * @param string $which
     100     * @return null
     101     */
    98102    public function tablenav( $which = 'top' ) {
    99103        if ( $this->get_pagination_arg( 'total_pages' ) <= 1 )
    … …  
    220224    }
    221225
     226    /**
     227     * @param WP_Theme $theme
     228     * @return bool
     229     */
    222230    public function search_theme( $theme ) {
    223231        // Search the features
    … …  
    256264     * @since 3.4.0
    257265     * @access public
     266     *
     267     * @param array $extra_args
    258268     */
    259269    public function _js_vars( $extra_args = array() ) {
Note: See TracChangeset for help on using the changeset viewer.