WordPress.org

Make WordPress Core

Ticket #26203: 26203.diff

File 26203.diff, 5.3 KB (added by leewillis77, 7 years ago)

Hook docs patch

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

     
    99 */
    1010class WP_Users_List_Table extends WP_List_Table {
    1111
     12        /**
     13         * The site ID that this table is being generated for.
     14         *
     15         * @since 3.1.0
     16         * @var   int $site_id The site ID.
     17         */
    1218        var $site_id;
     19
     20        /**
     21         * True if the table is being generated for the multisite site users page.
     22         *
     23         * @since 3.1.0
     24         * @var   bool $is_site_users
     25         */
    1326        var $is_site_users;
    1427
     28        /**
     29         * Constructor
     30         *
     31         * @since 3.1.0
     32         * @see   WP_List_Table::__construct()
     33         */
    1534        function __construct( $args = array() ) {
    1635                parent::__construct( array(
    1736                        'singular' => 'user',
     
    2544                        $this->site_id = isset( $_REQUEST['id'] ) ? intval( $_REQUEST['id'] ) : 0;
    2645        }
    2746
     47        /**
     48         * @since 3.1.0
     49         * @see   WP_List_Table::__construct()
     50         */
    2851        function ajax_user_can() {
    2952                if ( $this->is_site_users )
    3053                        return current_user_can( 'manage_sites' );
     
    3255                        return current_user_can( 'list_users' );
    3356        }
    3457
     58        /**
     59         * @since 3.1.0
     60         * @see   WP_List_Table::prepare_items()
     61         */
    3562        function prepare_items() {
    3663                global $role, $usersearch;
    3764
     
    75102                ) );
    76103        }
    77104
     105        /**
     106         * @since 3.1.0
     107         * @see   WP_List_Table::no_items()
     108         */
    78109        function no_items() {
    79110                _e( 'No matching users were found.' );
    80111        }
    81112
     113        /**
     114         * Returns an associative array listing all the views that can be used with this table.
     115         *
     116         * Provides a list of roles, andd user count for that role for easy filter of the user table.
     117         *
     118         * @since  3.1.0
     119         * @see    WP_List_Table::get_views()
     120         * @return array An array of HTML links, one for each view.
     121         */
    82122        function get_views() {
    83123                global $wp_roles, $role;
    84124
     
    119159                return $role_links;
    120160        }
    121161
     162        /**
     163         * @since  3.1.0
     164         * @see    WP_List_Table::get_bulk_actions()
     165         */
    122166        function get_bulk_actions() {
    123167                $actions = array();
    124168
     
    133177                return $actions;
    134178        }
    135179
     180        /**
     181         * Output the controls to allow user roles to be changed in bulk.
     182         *
     183         * @since 3.1.0
     184         * @see   WP_List_Table::extra_tablenav()
     185         * @param string $which Whether this is being invoked above ("top") or below the table ("bottom").
     186         */
    136187        function extra_tablenav( $which ) {
    137188                if ( 'top' != $which )
    138189                        return;
     
    148199                        submit_button( __( 'Change' ), 'button', 'changeit', false );
    149200                endif;
    150201
     202                /**
     203                 * Triggered after the extra tablenav on the user list page
     204                 *
     205                 * @since 3.5.0
     206                 */
    151207                do_action( 'restrict_manage_users' );
    152208                echo '</div>';
    153209        }
    154210
     211        /**
     212         * Capture the bulk action required, and return it.
     213         *
     214         * Overriden from the base class implementation to capture the role change drop-down.
     215         *
     216         * @since  3.1.0
     217         * @see    WP_List_Table::current_action()
     218         * @return string The bulk action required.
     219         */
    155220        function current_action() {
    156221                if ( isset($_REQUEST['changeit']) && !empty($_REQUEST['new_role']) )
    157222                        return 'promote';
     
    159224                return parent::current_action();
    160225        }
    161226
     227        /**
     228         *  @since  3.1.0
     229         *  @see    WP_List_Table::get_columns()
     230         *  @return array Array in which the key is the ID of the column, and the value is the description.
     231         */
    162232        function get_columns() {
    163233                $c = array(
    164234                        'cb'       => '<input type="checkbox" />',
     
    175245                return $c;
    176246        }
    177247
     248        /**
     249         * @since 3.1.0
     250         * @see   WP_List_Table::get_sortable_columns()
     251         */
    178252        function get_sortable_columns() {
    179253                $c = array(
    180254                        'username' => 'login',
     
    188262                return $c;
    189263        }
    190264
     265        /**
     266         * @since 3.1.0
     267         * @see   WP_List_Table::display_rows()
     268         */
    191269        function display_rows() {
    192270                // Query the post counts for this page
    193271                if ( ! $this->is_site_users )
     
    216294        /**
    217295         * Generate HTML for a single row on the users.php admin panel.
    218296         *
    219          * @since 2.1.0
     297         * @since 3.1.0
    220298         *
    221299         * @param object $user_object
    222300         * @param string $style Optional. Attributes added to the TR element. Must be sanitized.
     
    257335                                $actions['delete'] = "<a class='submitdelete' href='" . wp_nonce_url( "users.php?action=delete&amp;user=$user_object->ID", 'bulk-users' ) . "'>" . __( 'Delete' ) . "</a>";
    258336                        if ( is_multisite() && get_current_user_id() != $user_object->ID && current_user_can( 'remove_user', $user_object->ID ) )
    259337                                $actions['remove'] = "<a class='submitdelete' href='" . wp_nonce_url( $url."action=remove&amp;user=$user_object->ID", 'bulk-users' ) . "'>" . __( 'Remove' ) . "</a>";
     338                        /**
     339                         * The actions available against a user.
     340                         *
     341                         * @since 3.1.0
     342                         * @var   array $actions Array of actions available
     343                         * @var   WP_User $user_object The user object being listed.
     344                         */
    260345                        $actions = apply_filters( 'user_row_actions', $actions, $user_object );
    261346                        $edit .= $this->row_actions( $actions );
    262347
     
    313398                                        break;
    314399                                default:
    315400                                        $r .= "<td $attributes>";
     401                                        /**
     402                                         * Provide output for a custom column on the users list table.
     403                                         *
     404                                         * @since 3.1.0
     405                                         * @var   string The current content for the column.
     406                                         * @var   string The column being rendered.
     407                                         * @var   int    The user ID being rendered.
     408                                         */
    316409                                        $r .= apply_filters( 'manage_users_custom_column', '', $column_name, $user_object->ID );
    317410                                        $r .= "</td>";
    318411                        }