WordPress.org

Make WordPress Core

Ticket #41452: 41452.2.diff

File 41452.2.diff, 93.4 KB (added by DrewAPicture, 3 years ago)
  • src/wp-admin/custom-background.php

     
    1818         *
    1919         * @var callable
    2020         * @since 3.0.0
    21          * @access public
    2221         */
    2322        public $admin_header_callback;
    2423
     
    2726         *
    2827         * @var callable
    2928         * @since 3.0.0
    30          * @access public
    3129         */
    3230        public $admin_image_div_callback;
    3331
     
    3533         * Used to trigger a success message when settings updated and set to true.
    3634         *
    3735         * @since 3.0.0
    38          * @access private
    3936         * @var bool
    4037         */
    4138        private $updated;
  • src/wp-admin/custom-header.php

     
    1818         *
    1919         * @var callable
    2020         * @since 2.1.0
    21          * @access public
    2221         */
    2322        public $admin_header_callback;
    2423
     
    2726         *
    2827         * @var callable
    2928         * @since 3.0.0
    30          * @access public
    3129         */
    3230        public $admin_image_div_callback;
    3331
     
    3634         *
    3735         * @var array
    3836         * @since 3.0.0
    39          * @access public
    4037         */
    4138        public $default_headers = array();
    4239
     
    4441         * Used to trigger a success message when settings updated and set to true.
    4542         *
    4643         * @since 3.0.0
    47          * @access private
    4844         * @var bool
    4945         */
    5046        private $updated;
  • src/wp-admin/includes/class-automatic-upgrader-skin.php

     
    2727         *
    2828         * @since 3.7.0
    2929         * @since 4.6.0 The `$context` parameter default changed from `false` to an empty string.
    30          * @access public
    3130         *
    3231         * @see request_filesystem_credentials()
    3332         *
     
    5150        }
    5251
    5352        /**
    54          * @access public
    5553         *
    5654         * @return array
    5755         */
     
    6058        }
    6159
    6260        /**
    63          * @access public
    6461         *
    6562         * @param string|array|WP_Error $data
    6663         */
     
    10198        }
    10299
    103100        /**
    104          * @access public
    105101         */
    106102        public function header() {
    107103                ob_start();
    108104        }
    109105
    110106        /**
    111          * @access public
    112107         */
    113108        public function footer() {
    114109                $output = ob_get_clean();
  • src/wp-admin/includes/class-bulk-plugin-upgrader-skin.php

     
    2424        }
    2525
    2626        /**
    27          * @access public
    2827         *
    2928         * @param string $title
    3029         */
     
    3332        }
    3433
    3534        /**
    36          * @access public
    3735         *
    3836         * @param string $title
    3937         */
     
    4341        }
    4442
    4543        /**
    46          * @access public
    4744         */
    4845        public function bulk_footer() {
    4946                parent::bulk_footer();
  • src/wp-admin/includes/class-bulk-theme-upgrader-skin.php

     
    2424        }
    2525
    2626        /**
    27          * @access public
    2827         *
    2928         * @param string $title
    3029         */
     
    3332        }
    3433
    3534        /**
    36          * @access public
    3735         *
    3836         * @param string $title
    3937         */
     
    4341        }
    4442
    4543        /**
    46          * @access public
    4744         */
    4845        public function bulk_footer() {
    4946                parent::bulk_footer();
  • src/wp-admin/includes/class-bulk-upgrader-skin.php

     
    2323        public $error = false;
    2424
    2525        /**
    26          * @access public
    2726         *
    2827         * @param array $args
    2928         */
     
    3534        }
    3635
    3736        /**
    38          * @access public
    3937         */
    4038        public function add_strings() {
    4139                $this->upgrader->strings['skin_upgrade_start'] = __('The update process is starting. This process may take a while on some hosts, so please be patient.');
     
    4947        }
    5048
    5149        /**
    52          * @access public
    5350         *
    5451         * @param string $string
    5552         */
     
    7572        }
    7673
    7774        /**
    78          * @access public
    7975         */
    8076        public function header() {
    8177                // Nothing, This will be displayed within a iframe.
    8278        }
    8379
    8480        /**
    85          * @access public
    8681         */
    8782        public function footer() {
    8883                // Nothing, This will be displayed within a iframe.
    8984        }
    9085
    9186        /**
    92          * @access public
    9387         *
    9488         * @param string|WP_Error $error
    9589         */
     
    111105        }
    112106
    113107        /**
    114          * @access public
    115108         */
    116109        public function bulk_header() {
    117110                $this->feedback('skin_upgrade_start');
    118111        }
    119112
    120113        /**
    121          * @access public
    122114         */
    123115        public function bulk_footer() {
    124116                $this->feedback('skin_upgrade_end');
    125117        }
    126118
    127119        /**
    128          * @access public
    129120         *
    130121         * @param string $title
    131122         */
     
    139130        }
    140131
    141132        /**
    142          * @access public
    143133         *
    144134         * @param string $title
    145135         */
     
    170160        }
    171161
    172162        /**
    173          * @access public
    174163         */
    175164        public function reset() {
    176165                $this->in_loop = false;
     
    178167        }
    179168
    180169        /**
    181          * @access public
    182170         */
    183171        public function flush_output() {
    184172                wp_ob_end_flush_all();
  • src/wp-admin/includes/class-core-upgrader.php

     
    2424         * Initialize the upgrade strings.
    2525         *
    2626         * @since 2.8.0
    27          * @access public
    2827         */
    2928        public function upgrade_strings() {
    3029                $this->strings['up_to_date'] = __('WordPress is at the latest version.');
     
    4241         * Upgrade WordPress core.
    4342         *
    4443         * @since 2.8.0
    45          * @access public
    4644         *
    4745         * @global WP_Filesystem_Base $wp_filesystem Subclass
    4846         * @global callable           $_wp_filesystem_direct_method
     
    228226         * Determines if this WordPress Core version should update to an offered version or not.
    229227         *
    230228         * @since 3.7.0
    231          * @access public
    232229         *
    233230         * @static
    234231         *
     
    337334         * Compare the disk file checksums against the expected checksums.
    338335         *
    339336         * @since 3.7.0
    340          * @access public
    341337         *
    342338         * @global string $wp_version
    343339         * @global string $wp_local_package
  • src/wp-admin/includes/class-file-upload-upgrader.php

     
    2222         * The full path to the file package.
    2323         *
    2424         * @since 2.8.0
    25          * @access public
    2625         * @var string $package
    2726         */
    2827        public $package;
     
    3130         * The name of the file.
    3231         *
    3332         * @since 2.8.0
    34          * @access public
    3533         * @var string $filename
    3634         */
    3735        public $filename;
     
    4038         * The ID of the attachment post for this file.
    4139         *
    4240         * @since 3.3.0
    43          * @access public
    4441         * @var int $id
    4542         */
    4643        public $id = 0;
     
    4946         * Construct the upgrader for a form.
    5047         *
    5148         * @since 2.8.0
    52          * @access public
    5349         *
    5450         * @param string $form      The name of the form the file was uploaded from.
    5551         * @param string $urlholder The name of the `GET` parameter that holds the filename.
     
    113109         * Delete the attachment/uploaded file.
    114110         *
    115111         * @since 3.2.2
    116          * @access public
    117112         *
    118113         * @return bool Whether the cleanup was successful.
    119114         */
  • src/wp-admin/includes/class-language-pack-upgrader-skin.php

     
    2222        public $display_footer_actions = true;
    2323
    2424        /**
    25          * @access public
    2625         *
    2726         * @param array $args
    2827         */
     
    3837        }
    3938
    4039        /**
    41          * @access public
    4240         */
    4341        public function before() {
    4442                $name = $this->upgrader->get_name_for_update( $this->language_update );
     
    4947        }
    5048
    5149        /**
    52          * @access public
    5350         *
    5451         * @param string|WP_Error $error
    5552         */
     
    6057        }
    6158
    6259        /**
    63          * @access public
    6460         */
    6561        public function after() {
    6662                echo '</div>';
    6763        }
    6864
    6965        /**
    70          * @access public
    7166         */
    7267        public function bulk_footer() {
    7368                $this->decrement_update_count( 'translation' );
  • src/wp-admin/includes/class-language-pack-upgrader.php

     
    2222         * Result of the language pack upgrade.
    2323         *
    2424         * @since 3.7.0
    25          * @access public
    2625         * @var array|WP_Error $result
    2726         * @see WP_Upgrader::$result
    2827         */
     
    3231         * Whether a bulk upgrade/install is being performed.
    3332         *
    3433         * @since 3.7.0
    35          * @access public
    3634         * @var bool $bulk
    3735         */
    3836        public $bulk = true;
     
    4341         * Hooked to the {@see 'upgrader_process_complete'} action by default.
    4442         *
    4543         * @since 3.7.0
    46          * @access public
    4744         * @static
    4845         *
    4946         * @param false|WP_Upgrader $upgrader Optional. WP_Upgrader instance or false. If `$upgrader` is
     
    110107         * Initialize the upgrade strings.
    111108         *
    112109         * @since 3.7.0
    113          * @access public
    114110         */
    115111        public function upgrade_strings() {
    116112                $this->strings['starting_upgrade'] = __( 'Some of your translations need updating. Sit tight for a few more seconds while we update them as well.' );
     
    126122         * Upgrade a language pack.
    127123         *
    128124         * @since 3.7.0
    129          * @access public
    130125         *
    131126         * @param string|false $update Optional. Whether an update offer is available. Default false.
    132127         * @param array        $args   Optional. Other optional arguments, see
     
    151146         * Bulk upgrade language packs.
    152147         *
    153148         * @since 3.7.0
    154          * @access public
    155149         *
    156150         * @global WP_Filesystem_Base $wp_filesystem Subclass
    157151         *
     
    307301         * Language_Pack_Upgrader::bulk_upgrade().
    308302         *
    309303         * @since 3.7.0
    310          * @access public
    311304         *
    312305         * @global WP_Filesystem_Base $wp_filesystem Subclass
    313306         *
     
    349342         * Get the name of an item being updated.
    350343         *
    351344         * @since 3.7.0
    352          * @access public
    353345         *
    354346         * @param object $update The data for an update.
    355347         * @return string The name of the item being updated.
  • src/wp-admin/includes/class-plugin-installer-skin.php

     
    3434        }
    3535
    3636        /**
    37          * @access public
    3837         */
    3938        public function before() {
    4039                if ( !empty($this->api) )
     
    4241        }
    4342
    4443        /**
    45          * @access public
    4644         */
    4745        public function after() {
    4846                $plugin_file = $this->upgrader->plugin_info();
  • src/wp-admin/includes/class-plugin-upgrader-skin.php

     
    2121        public $plugin_network_active = false;
    2222
    2323        /**
    24          * @access public
    2524         *
    2625         * @param array $args
    2726         */
     
    3837        }
    3938
    4039        /**
    41          * @access public
    4240         */
    4341        public function after() {
    4442                $this->plugin = $this->upgrader->plugin_info();
  • src/wp-admin/includes/class-plugin-upgrader.php

     
    2424         * Plugin upgrade result.
    2525         *
    2626         * @since 2.8.0
    27          * @access public
    2827         * @var array|WP_Error $result
    2928         *
    3029         * @see WP_Upgrader::$result
     
    3534         * Whether a bulk upgrade/install is being performed.
    3635         *
    3736         * @since 2.9.0
    38          * @access public
    3937         * @var bool $bulk
    4038         */
    4139        public $bulk = false;
     
    4442         * Initialize the upgrade strings.
    4543         *
    4644         * @since 2.8.0
    47          * @access public
    4845         */
    4946        public function upgrade_strings() {
    5047                $this->strings['up_to_date'] = __('The plugin is at the latest version.');
     
    6259         * Initialize the install strings.
    6360         *
    6461         * @since 2.8.0
    65          * @access public
    6662         */
    6763        public function install_strings() {
    6864                $this->strings['no_package'] = __('Install package not available.');
     
    7975         *
    8076         * @since 2.8.0
    8177         * @since 3.7.0 The `$args` parameter was added, making clearing the plugin update cache optional.
    82          * @access public
    8378         *
    8479         * @param string $package The full local path or URI of the package.
    8580         * @param array  $args {
     
    134129         *
    135130         * @since 2.8.0
    136131         * @since 3.7.0 The `$args` parameter was added, making clearing the plugin update cache optional.
    137          * @access public
    138132         *
    139133         * @param string $plugin The basename path to the main plugin file.
    140134         * @param array  $args {
     
    206200         *
    207201         * @since 2.8.0
    208202         * @since 3.7.0 The `$args` parameter was added, making clearing the plugin update cache optional.
    209          * @access public
    210203         *
    211204         * @param array $plugins Array of the basename paths of the plugins' main files.
    212205         * @param array $args {
     
    325318         * Plugin_Upgrader::install().
    326319         *
    327320         * @since 3.3.0
    328          * @access public
    329321         *
    330322         * @global WP_Filesystem_Base $wp_filesystem Subclass
    331323         *
     
    368360         * This isn't used internally in the class, but is called by the skins.
    369361         *
    370362         * @since 2.8.0
    371          * @access public
    372363         *
    373364         * @return string|false The full path to the main plugin file, or false.
    374365         */
     
    394385         *
    395386         * @since 2.8.0
    396387         * @since 4.1.0 Added a return value.
    397          * @access public
    398388         *
    399389         * @param bool|WP_Error  $return Upgrade offer return.
    400390         * @param array          $plugin Plugin package arguments.
     
    428418         * Plugin_Upgrader::upgrade() and Plugin_Upgrader::bulk_upgrade().
    429419         *
    430420         * @since 2.8.0
    431          * @access public
    432421         *
    433422         * @global WP_Filesystem_Base $wp_filesystem Subclass
    434423     *
  • src/wp-admin/includes/class-theme-installer-skin.php

     
    3434        }
    3535
    3636        /**
    37          * @access public
    3837         */
    3938        public function before() {
    4039                if ( !empty($this->api) )
     
    4241        }
    4342
    4443        /**
    45          * @access public
    4644         */
    4745        public function after() {
    4846                if ( empty($this->upgrader->result['destination_name']) )
  • src/wp-admin/includes/class-theme-upgrader-skin.php

     
    1919        public $theme = '';
    2020
    2121        /**
    22          * @access public
    2322         *
    2423         * @param array $args
    2524         */
     
    3332        }
    3433
    3534        /**
    36          * @access public
    3735         */
    3836        public function after() {
    3937                $this->decrement_update_count( 'theme' );
  • src/wp-admin/includes/class-theme-upgrader.php

     
    2424         * Result of the theme upgrade offer.
    2525         *
    2626         * @since 2.8.0
    27          * @access public
    2827         * @var array|WP_Error $result
    2928         * @see WP_Upgrader::$result
    3029         */
     
    3433         * Whether multiple themes are being upgraded/installed in bulk.
    3534         *
    3635         * @since 2.9.0
    37          * @access public
    3836         * @var bool $bulk
    3937         */
    4038        public $bulk = false;
     
    4341         * Initialize the upgrade strings.
    4442         *
    4543         * @since 2.8.0
    46          * @access public
    4744         */
    4845        public function upgrade_strings() {
    4946                $this->strings['up_to_date'] = __('The theme is at the latest version.');
     
    6057         * Initialize the install strings.
    6158         *
    6259         * @since 2.8.0
    63          * @access public
    6460         */
    6561        public function install_strings() {
    6662                $this->strings['no_package'] = __('Install package not available.');
     
    8884         * Hooked to the {@see 'upgrader_post_install'} filter by Theme_Upgrader::install().
    8985         *
    9086         * @since 3.4.0
    91          * @access public
    9287         *
    9388         * @param bool  $install_result
    9489         * @param array $hook_extra
     
    162157         * a child theme and installing the parent theme fails.
    163158         *
    164159         * @since 3.4.0
    165          * @access public
    166160         *
    167161         * @param array $actions Preview actions.
    168162         * @return array
     
    177171         *
    178172         * @since 2.8.0
    179173         * @since 3.7.0 The `$args` parameter was added, making clearing the update cache optional.
    180          * @access public
    181174         *
    182175         * @param string $package The full local path or URI of the package.
    183176         * @param array  $args {
     
    235228         *
    236229         * @since 2.8.0
    237230         * @since 3.7.0 The `$args` parameter was added, making clearing the update cache optional.
    238          * @access public
    239231         *
    240232         * @param string $theme The theme slug.
    241233         * @param array  $args {
     
    306298         *
    307299         * @since 3.0.0
    308300         * @since 3.7.0 The `$args` parameter was added, making clearing the update cache optional.
    309          * @access public
    310301         *
    311302         * @param array $themes The theme slugs.
    312303         * @param array $args {
     
    427418         * files.
    428419         *
    429420         * @since 3.3.0
    430          * @access public
    431421         *
    432422         * @global WP_Filesystem_Base $wp_filesystem Subclass
    433423         *
     
    486476         * Theme_Upgrader::bulk_upgrade().
    487477         *
    488478         * @since 2.8.0
    489          * @access public
    490479         *
    491480         * @param bool|WP_Error  $return
    492481         * @param array          $theme
     
    514503         * and Theme_Upgrader::bulk_upgrade().
    515504         *
    516505         * @since 2.8.0
    517          * @access public
    518506         *
    519507         * @param bool|WP_Error  $return
    520508         * @param array          $theme
     
    549537         * and Theme_Upgrader::bulk_upgrade().
    550538         *
    551539         * @since 2.8.0
    552          * @access public
    553540         *
    554541         * @global WP_Filesystem_Base $wp_filesystem Subclass
    555542         *
     
    583570         *
    584571         * @since 2.8.0
    585572         * @since 3.0.0 The `$theme` argument was added.
    586          * @access public
    587573         *
    588574         * @param string $theme The directory name of the theme. This is optional, and if not supplied,
    589575         *                      the directory name from the last result will be used.
  • src/wp-admin/includes/class-wp-ajax-upgrader-skin.php

     
    2222         * Holds the WP_Error object.
    2323         *
    2424         * @since 4.6.0
    25          * @access protected
    2625         * @var null|WP_Error
    2726         */
    2827        protected $errors = null;
     
    3130         * Constructor.
    3231         *
    3332         * @since 4.6.0
    34          * @access public
    3533         *
    3634         * @param array $args Options for the upgrader, see WP_Upgrader_Skin::__construct().
    3735         */
     
    4543         * Retrieves the list of errors.
    4644         *
    4745         * @since 4.6.0
    48          * @access public
    4946         *
    5047         * @return WP_Error Errors during an upgrade.
    5148         */
     
    5754         * Retrieves a string for error messages.
    5855         *
    5956         * @since 4.6.0
    60          * @access public
    6157         *
    6258         * @return string Error messages during an upgrade.
    6359         */
     
    7975         * Stores a log entry for an error.
    8076         *
    8177         * @since 4.6.0
    82          * @access public
    8378         *
    8479         * @param string|WP_Error $errors Errors.
    8580         */
     
    115110         * Stores a log entry.
    116111         *
    117112         * @since 4.6.0
    118          * @access public
    119113         *
    120114         * @param string|array|WP_Error $data Log entry data.
    121115         */
  • src/wp-admin/includes/class-wp-automatic-updater.php

     
    1919         * Tracks update results during processing.
    2020         *
    2121         * @var array
    22          * @access protected
    2322         */
    2423        protected $update_results = array();
    2524
     
    2726         * Whether the entire automatic updater is disabled.
    2827         *
    2928         * @since 3.7.0
    30          * @access public
    3129         */
    3230        public function is_disabled() {
    3331                // Background updates are disabled if you don't want file changes.
     
    6866         * how things get updated.
    6967         *
    7068         * @since 3.7.0
    71          * @access public
    7269         *
    7370         * @param string $context The filesystem path to check, in addition to ABSPATH.
    7471         */
     
    121118         * Tests to see if we can and should update a specific item.
    122119         *
    123120         * @since 3.7.0
    124          * @access public
    125121         *
    126122         * @global wpdb $wpdb WordPress database abstraction object.
    127123         *
     
    205201         * Notifies an administrator of a core update.
    206202         *
    207203         * @since 3.7.0
    208          * @access protected
    209204         *
    210205         * @param object $item The update offer.
    211206         */
     
    249244         * Update an item, if appropriate.
    250245         *
    251246         * @since 3.7.0
    252          * @access public
    253247         *
    254248         * @param string $type The type of update being checked: 'core', 'theme', 'plugin', 'translation'.
    255249         * @param object $item The update offer.
     
    370364         * Kicks off the background update process, looping through all pending updates.
    371365         *
    372366         * @since 3.7.0
    373          * @access public
    374367         */
    375368        public function run() {
    376369                if ( $this->is_disabled() )
     
    487480         * and if we need to avoid processing future updates.
    488481         *
    489482         * @since Unknown
    490          * @access protected
    491483         *
    492484         * @param object $update_result The result of the core update. Includes the update offer and result.
    493485         */
     
    575567         * Sends an email upon the completion or failure of a background core update.
    576568         *
    577569         * @since 3.7.0
    578          * @access protected
    579570         *
    580571         * @param string $type        The type of email to send. Can be one of 'success', 'fail', 'manual', 'critical'.
    581572         * @param object $core_update The update offer that was attempted.
     
    773764         * Prepares and sends an email of a full log of background update results, useful for debugging and geekery.
    774765         *
    775766         * @since 3.7.0
    776          * @access protected
    777767         */
    778768        protected function send_debug_email() {
    779769                $update_count = 0;
  • src/wp-admin/includes/class-wp-comments-list-table.php

     
    2929         * Constructor.
    3030         *
    3131         * @since 3.1.0
    32          * @access public
    3332         *
    3433         * @see WP_List_Table::__construct() for more information on default arguments.
    3534         *
     
    428427         * Get the name of the default primary column.
    429428         *
    430429         * @since 4.3.0
    431          * @access protected
    432430         *
    433431         * @return string Name of the default primary column, in this case, 'comment'.
    434432         */
     
    437435        }
    438436
    439437        /**
    440          * @access public
    441438         */
    442439        public function display() {
    443440                wp_nonce_field( "fetch-list-" . get_class( $this ), '_ajax_fetch_list_nonce' );
     
    715712        }
    716713
    717714        /**
    718          * @access public
    719715         *
    720716         * @param WP_Comment $comment The comment object.
    721717         */
     
    741737        }
    742738
    743739        /**
    744          * @access public
    745740         *
    746741         * @param WP_Comment $comment The comment object.
    747742         */
  • src/wp-admin/includes/class-wp-community-events.php

     
    1818        /**
    1919         * ID for a WordPress user account.
    2020         *
    21          * @access protected
    2221         * @since 4.8.0
    2322         *
    2423         * @var int
     
    2827        /**
    2928         * Stores location data for the user.
    3029         *
    31          * @access protected
    3230         * @since 4.8.0
    3331         *
    3432         * @var bool|array
     
    171169        /**
    172170         * Builds an array of args to use in an HTTP request to the w.org Events API.
    173171         *
    174          * @access protected
    175172         * @since 4.8.0
    176173         *
    177174         * @param string $search   Optional. City search string. Default empty string.
     
    229226         * _NOT_ guarantee that the returned address is valid or accurate, and it can
    230227         * be easily spoofed.
    231228         *
    232          * @access protected
    233229         * @since 4.8.0
    234230         *
    235231         * @return false|string The anonymized address on success; the given address
     
    281277         * Test if two pairs of latitude/longitude coordinates match each other.
    282278         *
    283279         * @since 4.8.0
    284          * @access protected
    285280         *
    286281         * @param array $a The first pair, with indexes 'latitude' and 'longitude'.
    287282         * @param array $b The second pair, with indexes 'latitude' and 'longitude'.
     
    303298         * functions, and having it abstracted keeps the logic consistent and DRY,
    304299         * which is less prone to errors.
    305300         *
    306          * @access protected
    307301         * @since 4.8.0
    308302         *
    309303         * @param  array $location Should contain 'latitude' and 'longitude' indexes.
     
    324318        /**
    325319         * Caches an array of events data from the Events API.
    326320         *
    327          * @access protected
    328321         * @since 4.8.0
    329322         *
    330323         * @param array    $events     Response body from the API request.
     
    366359         * the cache, then all users would see the events in the localized data/time
    367360         * of the user who triggered the cache refresh, rather than their own.
    368361         *
    369          * @access protected
    370362         * @since 4.8.0
    371363         *
    372364         * @param  array $response_body The response which contains the events.
     
    395387        /**
    396388         * Discards expired events, and reduces the remaining list.
    397389         *
    398          * @access protected
    399390         * @since 4.8.0
    400391         *
    401392         * @param  array $response_body The response body which contains the events.
     
    436427         * Errors are logged instead of being triggered, to avoid breaking the JSON
    437428         * response when called from AJAX handlers and `display_errors` is enabled.
    438429         *
    439          * @access protected
    440430         * @since 4.8.0
    441431         *
    442432         * @param string $message A description of what occurred.
  • src/wp-admin/includes/class-wp-filesystem-base.php

     
    1515        /**
    1616         * Whether to display debug data for the connection.
    1717         *
    18          * @access public
    1918         * @since 2.5.0
    2019         * @var bool
    2120         */
     
    2423        /**
    2524         * Cached list of local filepaths to mapped remote filepaths.
    2625         *
    27          * @access public
    2826         * @since 2.7.0
    2927         * @var array
    3028         */
     
    3331        /**
    3432         * The Access method of the current connection, Set automatically.
    3533         *
    36          * @access public
    3734         * @since 2.5.0
    3835         * @var string
    3936         */
    4037        public $method = '';
    4138
    4239        /**
    43          * @access public
    4440         * @var WP_Error
    4541         */
    4642        public $errors = null;
    4743
    4844        /**
    49          * @access public
    5045         */
    5146        public $options = array();
    5247
    5348        /**
    5449         * Return the path on the remote filesystem of ABSPATH.
    5550         *
    56          * @access public
    5751         * @since 2.7.0
    5852         *
    5953         * @return string The location of the remote path.
     
    6963        /**
    7064         * Return the path on the remote filesystem of WP_CONTENT_DIR.
    7165         *
    72          * @access public
    7366         * @since 2.7.0
    7467         *
    7568         * @return string The location of the remote path.
     
    8174        /**
    8275         * Return the path on the remote filesystem of WP_PLUGIN_DIR.
    8376         *
    84          * @access public
    8577         * @since 2.7.0
    8678         *
    8779         * @return string The location of the remote path.
     
    9385        /**
    9486         * Return the path on the remote filesystem of the Themes Directory.
    9587         *
    96          * @access public
    9788         * @since 2.7.0
    9889         *
    9990         * @param string $theme The Theme stylesheet or template for the directory.
     
    112103        /**
    113104         * Return the path on the remote filesystem of WP_LANG_DIR.
    114105         *
    115          * @access public
    116106         * @since 3.2.0
    117107         *
    118108         * @return string The location of the remote path.
     
    124114        /**
    125115         * Locate a folder on the remote filesystem.
    126116         *
    127          * @access public
    128117         * @since 2.5.0
    129118         * @deprecated 2.7.0 use WP_Filesystem::abspath() or WP_Filesystem::wp_*_dir() instead.
    130119         * @see WP_Filesystem::abspath()
     
    147136        /**
    148137         * Locate a folder on the remote filesystem.
    149138         *
    150          * @access public
    151139         * @since 2.5.0
    152140         * @deprecated 2.7.0 use WP_Filesystem::abspath() or WP_Filesystem::wp_*_dir() methods instead.
    153141         * @see WP_Filesystem::abspath()
     
    172160         * Assumes that on Windows systems, Stripping off the Drive
    173161         * letter is OK Sanitizes \\ to / in windows filepaths.
    174162         *
    175          * @access public
    176163         * @since 2.7.0
    177164         *
    178165         * @param string $folder the folder to locate.
     
    238225         *
    239226         * Expects Windows sanitized path.
    240227         *
    241          * @access public
    242228         * @since 2.7.0
    243229         *
    244230         * @param string $folder The folder to locate.
     
    319305         *
    320306         * @link https://secure.php.net/manual/en/function.fileperms.php
    321307         *
    322          * @access public
    323308         * @since 2.5.0
    324309         *
    325310         * @param string $file String filename.
     
    370355        /**
    371356         * Gets the permissions of the specified file or filepath in their octal format
    372357         *
    373          * @access public
    374358         * @since 2.5.0
    375359         * @param string $file
    376360         * @return string the last 3 characters of the octal number
     
    387371         *
    388372         * @link https://secure.php.net/manual/en/function.chmod.php#49614
    389373         *
    390          * @access public
    391374         * @since 2.5.0
    392375         *
    393376         * @param string $mode string The *nix-style file permission.
     
    418401        /**
    419402         * Determine if the string provided contains binary characters.
    420403         *
    421          * @access public
    422404         * @since 2.7.0
    423405         *
    424406         * @param string $text String to test against.
     
    433415         *
    434416         * Default behavior is to do nothing, override this in your subclass, if desired.
    435417         *
    436          * @access public
    437418         * @since 2.5.0
    438419         *
    439420         * @param string $file      Path to the file.
     
    448429        /**
    449430         * Connect filesystem.
    450431         *
    451          * @access public
    452432         * @since 2.5.0
    453433         * @abstract
    454434         *
     
    461441        /**
    462442         * Read entire file into a string.
    463443         *
    464          * @access public
    465444         * @since 2.5.0
    466445         * @abstract
    467446         *
     
    475454        /**
    476455         * Read entire file into an array.
    477456         *
    478          * @access public
    479457         * @since 2.5.0
    480458         * @abstract
    481459         *
     
    489467        /**
    490468         * Write a string to a file.
    491469         *
    492          * @access public
    493470         * @since 2.5.0
    494471         * @abstract
    495472         *
     
    505482        /**
    506483         * Get the current working directory.
    507484         *
    508          * @access public
    509485         * @since 2.5.0
    510486         * @abstract
    511487         *
     
    518494        /**
    519495         * Change current directory.
    520496         *
    521          * @access public
    522497         * @since 2.5.0
    523498         * @abstract
    524499         *
     
    532507        /**
    533508         * Change the file group.
    534509         *
    535          * @access public
    536510         * @since 2.5.0
    537511         * @abstract
    538512         *
     
    548522        /**
    549523         * Change filesystem permissions.
    550524         *
    551          * @access public
    552525         * @since 2.5.0
    553526         * @abstract
    554527         *
     
    564537        /**
    565538         * Get the file owner.
    566539         *
    567          * @access public
    568540         * @since 2.5.0
    569541         * @abstract
    570542         *
     
    578550        /**
    579551         * Get the file's group.
    580552         *
    581          * @access public
    582553         * @since 2.5.0
    583554         * @abstract
    584555         *
     
    592563        /**
    593564         * Copy a file.
    594565         *
    595          * @access public
    596566         * @since 2.5.0
    597567         * @abstract
    598568         *
     
    611581        /**
    612582         * Move a file.
    613583         *
    614          * @access public
    615584         * @since 2.5.0
    616585         * @abstract
    617586         *
     
    628597        /**
    629598         * Delete a file or directory.
    630599         *
    631          * @access public
    632600         * @since 2.5.0
    633601         * @abstract
    634602         *
     
    646614        /**
    647615         * Check if a file or directory exists.
    648616         *
    649          * @access public
    650617         * @since 2.5.0
    651618         * @abstract
    652619         *
     
    660627        /**
    661628         * Check if resource is a file.
    662629         *
    663          * @access public
    664630         * @since 2.5.0
    665631         * @abstract
    666632         *
     
    674640        /**
    675641         * Check if resource is a directory.
    676642         *
    677          * @access public
    678643         * @since 2.5.0
    679644         * @abstract
    680645         *
     
    688653        /**
    689654         * Check if a file is readable.
    690655         *
    691          * @access public
    692656         * @since 2.5.0
    693657         * @abstract
    694658         *
     
    702666        /**
    703667         * Check if a file or directory is writable.
    704668         *
    705          * @access public
    706669         * @since 2.5.0
    707670         * @abstract
    708671         *
     
    716679        /**
    717680         * Gets the file's last access time.
    718681         *
    719          * @access public
    720682         * @since 2.5.0
    721683         * @abstract
    722684         *
     
    730692        /**
    731693         * Gets the file modification time.
    732694         *
    733          * @access public
    734695         * @since 2.5.0
    735696         * @abstract
    736697         *
     
    744705        /**
    745706         * Gets the file size (in bytes).
    746707         *
    747          * @access public
    748708         * @since 2.5.0
    749709         * @abstract
    750710         *
     
    760720         *
    761721         * Note: If $file doesn't exist, it will be created.
    762722         *
    763          * @access public
    764723         * @since 2.5.0
    765724         * @abstract
    766725         *
     
    778737        /**
    779738         * Create a directory.
    780739         *
    781          * @access public
    782740         * @since 2.5.0
    783741         * @abstract
    784742         *
     
    798756        /**
    799757         * Delete a directory.
    800758         *
    801          * @access public
    802759         * @since 2.5.0
    803760         * @abstract
    804761         *
     
    814771        /**
    815772         * Get details for files in a directory or a specific file.
    816773         *
    817          * @access public
    818774         * @since 2.5.0
    819775         * @abstract
    820776         *
  • src/wp-admin/includes/class-wp-filesystem-direct.php

     
    1818        /**
    1919         * constructor
    2020         *
    21          * @access public
    2221         *
    2322         * @param mixed $arg ignored argument
    2423         */
     
    3029        /**
    3130         * Reads entire file into a string
    3231         *
    33          * @access public
    3432         *
    3533         * @param string $file Name of the file to read.
    3634         * @return string|bool The function returns the read data or false on failure.
     
    4240        /**
    4341         * Reads entire file into an array
    4442         *
    45          * @access public
    4643         *
    4744         * @param string $file Path to the file.
    4845         * @return array|bool the file contents in an array or false on failure.
     
    5451        /**
    5552         * Write a string to a file
    5653         *
    57          * @access public
    5854         *
    5955         * @param string $file     Remote path to the file where to write the data.
    6056         * @param string $contents The data to write.
     
    8884        /**
    8985         * Gets the current working directory
    9086         *
    91          * @access public
    9287         *
    9388         * @return string|bool the current working directory on success, or false on failure.
    9489         */
     
    9994        /**
    10095         * Change directory
    10196         *
    102          * @access public
    10397         *
    10498         * @param string $dir The new current directory.
    10599         * @return bool Returns true on success or false on failure.
     
    111105        /**
    112106         * Changes file group
    113107         *
    114          * @access public
    115108         *
    116109         * @param string $file      Path to the file.
    117110         * @param mixed  $group     A group name or number.
     
    137130        /**
    138131         * Changes filesystem permissions
    139132         *
    140          * @access public
    141133         *
    142134         * @param string $file      Path to the file.
    143135         * @param int    $mode      Optional. The permissions as octal number, usually 0644 for files,
     
    169161        /**
    170162         * Changes file owner
    171163         *
    172          * @access public
    173164         *
    174165         * @param string $file      Path to the file.
    175166         * @param mixed  $owner     A user name or number.
     
    195186        /**
    196187         * Gets file owner
    197188         *
    198          * @access public
    199189         *
    200190         * @param string $file Path to the file.
    201191         * @return string|bool Username of the user or false on error.
     
    215205         *
    216206         * FIXME does not handle errors in fileperms()
    217207         *
    218          * @access public
    219208         *
    220209         * @param string $file Path to the file.
    221210         * @return string Mode of the file (last 3 digits).
     
    225214        }
    226215
    227216        /**
    228          * @access public
    229217         *
    230218         * @param string $file
    231219         * @return string|false
     
    241229        }
    242230
    243231        /**
    244          * @access public
    245232         *
    246233         * @param string $source
    247234         * @param string $destination
     
    260247        }
    261248
    262249        /**
    263          * @access public
    264250         *
    265251         * @param string $source
    266252         * @param string $destination
     
    284270        }
    285271
    286272        /**
    287          * @access public
    288273         *
    289274         * @param string $file
    290275         * @param bool $recursive
     
    319304                return $retval;
    320305        }
    321306        /**
    322          * @access public
    323307         *
    324308         * @param string $file
    325309         * @return bool
     
    328312                return @file_exists($file);
    329313        }
    330314        /**
    331          * @access public
    332315         *
    333316         * @param string $file
    334317         * @return bool
     
    337320                return @is_file($file);
    338321        }
    339322        /**
    340          * @access public
    341323         *
    342324         * @param string $path
    343325         * @return bool
     
    347329        }
    348330
    349331        /**
    350          * @access public
    351332         *
    352333         * @param string $file
    353334         * @return bool
     
    357338        }
    358339
    359340        /**
    360          * @access public
    361341         *
    362342         * @param string $file
    363343         * @return bool
     
    367347        }
    368348
    369349        /**
    370          * @access public
    371350         *
    372351         * @param string $file
    373352         * @return int
     
    377356        }
    378357
    379358        /**
    380          * @access public
    381359         *
    382360         * @param string $file
    383361         * @return int
     
    387365        }
    388366
    389367        /**
    390          * @access public
    391368         *
    392369         * @param string $file
    393370         * @return int
     
    397374        }
    398375
    399376        /**
    400          * @access public
    401377         *
    402378         * @param string $file
    403379         * @param int $time
     
    413389        }
    414390
    415391        /**
    416          * @access public
    417392         *
    418393         * @param string $path
    419394         * @param mixed  $chmod
     
    441416        }
    442417
    443418        /**
    444          * @access public
    445419         *
    446420         * @param string $path
    447421         * @param bool $recursive
     
    452426        }
    453427
    454428        /**
    455          * @access public
    456429         *
    457430         * @param string $path
    458431         * @param bool $include_hidden
  • src/wp-admin/includes/class-wp-filesystem-ftpext.php

     
    1717        public $link;
    1818
    1919        /**
    20          * @access public
    2120         *
    2221         * @param array $opt
    2322         */
     
    6362        }
    6463
    6564        /**
    66          * @access public
    6765         *
    6866         * @return bool
    6967         */
     
    105103         * Retrieves the file contents.
    106104         *
    107105         * @since 2.5.0
    108          * @access public
    109106         *
    110107         * @param string $file Filename.
    111108         * @return string|false File contents on success, false if no temp file could be opened,
     
    138135        }
    139136
    140137        /**
    141          * @access public
    142138         *
    143139         * @param string $file
    144140         * @return array
     
    148144        }
    149145
    150146        /**
    151          * @access public
    152147         *
    153148         * @param string $file
    154149         * @param string $contents
     
    190185        }
    191186
    192187        /**
    193          * @access public
    194188         *
    195189         * @return string
    196190         */
     
    202196        }
    203197
    204198        /**
    205          * @access public
    206199         *
    207200         * @param string $dir
    208201         * @return bool
     
    212205        }
    213206
    214207        /**
    215          * @access public
    216208         *
    217209         * @param string $file
    218210         * @param int $mode
     
    243235        }
    244236
    245237        /**
    246          * @access public
    247238         *
    248239         * @param string $file
    249240         * @return string
     
    253244                return $dir[$file]['owner'];
    254245        }
    255246        /**
    256          * @access public
    257247         *
    258248         * @param string $file
    259249         * @return string
     
    264254        }
    265255
    266256        /**
    267          * @access public
    268257         *
    269258         * @param string $file
    270259         * @return string
     
    275264        }
    276265
    277266        /**
    278          * @access public
    279267         *
    280268         * @param string $source
    281269         * @param string $destination
     
    293281        }
    294282
    295283        /**
    296          * @access public
    297284         *
    298285         * @param string $source
    299286         * @param string $destination
     
    305292        }
    306293
    307294        /**
    308          * @access public
    309295         *
    310296         * @param string $file
    311297         * @param bool $recursive
     
    328314        }
    329315
    330316        /**
    331          * @access public
    332317         *
    333318         * @param string $file
    334319         * @return bool
     
    344329        }
    345330
    346331        /**
    347          * @access public
    348332         *
    349333         * @param string $file
    350334         * @return bool
     
    354338        }
    355339
    356340        /**
    357          * @access public
    358341         *
    359342         * @param string $path
    360343         * @return bool
     
    370353        }
    371354
    372355        /**
    373          * @access public
    374356         *
    375357         * @param string $file
    376358         * @return bool
     
    380362        }
    381363
    382364        /**
    383          * @access public
    384365         *
    385366         * @param string $file
    386367         * @return bool
     
    390371        }
    391372
    392373        /**
    393          * @access public
    394374         *
    395375         * @param string $file
    396376         * @return bool
     
    400380        }
    401381
    402382        /**
    403          * @access public
    404383         *
    405384         * @param string $file
    406385         * @return int
     
    410389        }
    411390
    412391        /**
    413          * @access public
    414392         *
    415393         * @param string $file
    416394         * @return int
     
    420398        }
    421399
    422400        /**
    423          * @access public
    424401         *
    425402         * @param string $file
    426403         * @return bool
     
    430407        }
    431408
    432409        /**
    433          * @access public
    434410         *
    435411         * @param string $path
    436412         * @param mixed $chmod
     
    450426        }
    451427
    452428        /**
    453          * @access public
    454429         *
    455430         * @param string $path
    456431         * @param bool $recursive
     
    461436        }
    462437
    463438        /**
    464          * @access public
    465439         *
    466440         * @staticvar bool $is_windows
    467441         * @param string $line
     
    543517        }
    544518
    545519        /**
    546          * @access public
    547520         *
    548521         * @param string $path
    549522         * @param bool $include_hidden
     
    600573        }
    601574
    602575        /**
    603          * @access public
    604576         */
    605577        public function __destruct() {
    606578                if ( $this->link )
  • src/wp-admin/includes/class-wp-filesystem-ftpsockets.php

     
    1515 */
    1616class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
    1717        /**
    18          * @access public
    1918         * @var ftp
    2019         */
    2120        public $ftp;
    2221
    2322        /**
    24          * @access public
    2523         *
    2624         * @param array $opt
    2725         */
     
    5856        }
    5957
    6058        /**
    61          * @access public
    6259         *
    6360         * @return bool
    6461         */
     
    108105         * Retrieves the file contents.
    109106         *
    110107         * @since 2.5.0
    111          * @access public
    112108         *
    113109         * @param string $file Filename.
    114110         * @return string|false File contents on success, false if no temp file could be opened,
     
    150146        }
    151147
    152148        /**
    153          * @access public
    154149         *
    155150         * @param string $file
    156151         * @return array
     
    160155        }
    161156
    162157        /**
    163          * @access public
    164158         *
    165159         * @param string $file
    166160         * @param string $contents
     
    202196        }
    203197
    204198        /**
    205          * @access public
    206199         *
    207200         * @return string
    208201         */
     
    214207        }
    215208
    216209        /**
    217          * @access public
    218210         *
    219211         * @param string $file
    220212         * @return bool
     
    224216        }
    225217
    226218        /**
    227          * @access public
    228219         *
    229220         * @param string $file
    230221         * @param int|bool $mode
     
    253244        }
    254245
    255246        /**
    256          * @access public
    257247         *
    258248         * @param string $file
    259249         * @return string
     
    264254        }
    265255
    266256        /**
    267          * @access public
    268257         *
    269258         * @param string $file
    270259         * @return string
     
    275264        }
    276265
    277266        /**
    278          * @access public
    279267         *
    280268         * @param string $file
    281269         * @return string
     
    286274        }
    287275
    288276        /**
    289          * @access public
    290277         *
    291278         * @param string   $source
    292279         * @param string   $destination
     
    306293        }
    307294
    308295        /**
    309          * @access public
    310296         *
    311297         * @param string $source
    312298         * @param string $destination
     
    318304        }
    319305
    320306        /**
    321          * @access public
    322307         *
    323308         * @param string $file
    324309         * @param bool   $recursive
     
    337322        }
    338323
    339324        /**
    340          * @access public
    341325         *
    342326         * @param string $file
    343327         * @return bool
     
    354338        }
    355339
    356340        /**
    357          * @access public
    358341         *
    359342         * @param string $file
    360343         * @return bool
     
    368351        }
    369352
    370353        /**
    371          * @access public
    372354         *
    373355         * @param string $path
    374356         * @return bool
     
    383365        }
    384366
    385367        /**
    386          * @access public
    387368         *
    388369         * @param string $file
    389370         * @return bool
     
    393374        }
    394375
    395376        /**
    396          * @access public
    397377         *
    398378         * @param string $file
    399379         * @return bool
     
    403383        }
    404384
    405385        /**
    406          * @access public
    407386         *
    408387         * @param string $file
    409388         * @return bool
     
    413392        }
    414393
    415394        /**
    416          * @access public
    417395         *
    418396         * @param string $file
    419397         * @return int
     
    431409        }
    432410
    433411        /**
    434          * @access public
    435412         *
    436413         * @param string $file
    437414         * @param int $time
     
    443420        }
    444421
    445422        /**
    446          * @access public
    447423         *
    448424         * @param string $path
    449425         * @param mixed  $chmod
     
    465441        }
    466442
    467443        /**
    468          * @access public
    469444         *
    470445         * @param string $path
    471446         * @param bool $recursive
     
    476451        }
    477452
    478453        /**
    479          * @access public
    480454         *
    481455         * @param string $path
    482456         * @param bool   $include_hidden
     
    536510        }
    537511
    538512        /**
    539          * @access public
    540513         */
    541514        public function __destruct() {
    542515                $this->ftp->quit();
  • src/wp-admin/includes/class-wp-filesystem-ssh2.php

     
    3636class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
    3737
    3838        /**
    39          * @access public
    4039         */
    4140        public $link = false;
    4241
    4342        /**
    44          * @access public
    4543         * @var resource
    4644         */
    4745        public $sftp_link;
    4846        public $keys = false;
    4947
    5048        /**
    51          * @access public
    5249         *
    5350         * @param array $opt
    5451         */
     
    109106        }
    110107
    111108        /**
    112          * @access public
    113109         *
    114110         * @return bool
    115111         */
     
    174170         * this, the path is converted to /./ which is semantically the same as /
    175171         * See https://bugs.php.net/bug.php?id=64169 for more details.
    176172         *
    177          * @access public
    178173         *
    179174         * @since 4.4.0
    180175         *
     
    189184        }
    190185
    191186        /**
    192          * @access public
    193          *
     187         *
    194188         * @param string $command
    195189         * @param bool $returnbool
    196190         * @return bool|string True on success, false on failure. String if the command was executed, `$returnbool`
     
    222216        }
    223217
    224218        /**
    225          * @access public
    226219         *
    227220         * @param string $file
    228221         * @return string|false
     
    232225        }
    233226
    234227        /**
    235          * @access public
    236228         *
    237229         * @param string $file
    238230         * @return array
     
    242234        }
    243235
    244236        /**
    245          * @access public
    246237         *
    247238         * @param string   $file
    248239         * @param string   $contents
     
    261252        }
    262253
    263254        /**
    264          * @access public
    265255         *
    266256         * @return bool
    267257         */
     
    274264        }
    275265
    276266        /**
    277          * @access public
    278267         *
    279268         * @param string $dir
    280269         * @return bool|string
     
    284273        }
    285274
    286275        /**
    287          * @access public
    288276         *
    289277         * @param string $file
    290278         * @param string $group
     
    301289        }
    302290
    303291        /**
    304          * @access public
    305292         *
    306293         * @param string $file
    307294         * @param int    $mode
     
    329316        /**
    330317         * Change the ownership of a file / folder.
    331318         *
    332          * @access public
    333319         *
    334320         * @param string     $file      Path to the file.
    335321         * @param string|int $owner     A user name or number.
     
    345331        }
    346332
    347333        /**
    348          * @access public
    349334         *
    350335         * @param string $file
    351336         * @return string|false
     
    361346        }
    362347
    363348        /**
    364          * @access public
    365349         *
    366350         * @param string $file
    367351         * @return string
     
    371355        }
    372356
    373357        /**
    374          * @access public
    375358         *
    376359         * @param string $file
    377360         * @return string|false
     
    387370        }
    388371
    389372        /**
    390          * @access public
    391373         *
    392374         * @param string   $source
    393375         * @param string   $destination
     
    405387        }
    406388
    407389        /**
    408          * @access public
    409390         *
    410391         * @param string $source
    411392         * @param string $destination
     
    417398        }
    418399
    419400        /**
    420          * @access public
    421401         *
    422402         * @param string      $file
    423403         * @param bool        $recursive
     
    439419        }
    440420
    441421        /**
    442          * @access public
    443422         *
    444423         * @param string $file
    445424         * @return bool
     
    449428        }
    450429
    451430        /**
    452          * @access public
    453431         *
    454432         * @param string $file
    455433         * @return bool
     
    459437        }
    460438
    461439        /**
    462          * @access public
    463440         *
    464441         * @param string $path
    465442         * @return bool
     
    469446        }
    470447
    471448        /**
    472          * @access public
    473449         *
    474450         * @param string $file
    475451         * @return bool
     
    479455        }
    480456
    481457        /**
    482          * @access public
    483458         *
    484459         * @param string $file
    485460         * @return bool
     
    490465        }
    491466
    492467        /**
    493          * @access public
    494468         *
    495469         * @param string $file
    496470         * @return int
     
    500474        }
    501475
    502476        /**
    503          * @access public
    504477         *
    505478         * @param string $file
    506479         * @return int
     
    510483        }
    511484
    512485        /**
    513          * @access public
    514486         *
    515487         * @param string $file
    516488         * @return int
     
    520492        }
    521493
    522494        /**
    523          * @access public
    524495         *
    525496         * @param string $file
    526497         * @param int    $time
     
    531502        }
    532503
    533504        /**
    534          * @access public
    535505         *
    536506         * @param string $path
    537507         * @param mixed  $chmod
     
    556526        }
    557527
    558528        /**
    559          * @access public
    560529         *
    561530         * @param string $path
    562531         * @param bool   $recursive
     
    567536        }
    568537
    569538        /**
    570          * @access public
    571539         *
    572540         * @param string $path
    573541         * @param bool   $include_hidden
  • src/wp-admin/includes/class-wp-links-list-table.php

     
    2121         * Constructor.
    2222         *
    2323         * @since 3.1.0
    24          * @access public
    2524         *
    2625         * @see WP_List_Table::__construct() for more information on default arguments.
    2726         *
     
    6968        }
    7069
    7170        /**
    72          * @access public
    7371         */
    7472        public function no_items() {
    7573                _e( 'No links found.' );
     
    151149         * Get the name of the default primary column.
    152150         *
    153151         * @since 4.3.0
    154          * @access protected
    155152         *
    156153         * @return string Name of the default primary column, in this case, 'name'.
    157154         */
     
    163160         * Handles the checkbox column output.
    164161         *
    165162         * @since 4.3.0
    166          * @access public
    167163         *
    168164         * @param object $link The current link object.
    169165         */
     
    178174         * Handles the link name column output.
    179175         *
    180176         * @since 4.3.0
    181          * @access public
    182177         *
    183178         * @param object $link The current link object.
    184179         */
     
    196191         * Handles the link URL column output.
    197192         *
    198193         * @since 4.3.0
    199          * @access public
    200194         *
    201195         * @param object $link The current link object.
    202196         */
     
    209203         * Handles the link categories column output.
    210204         *
    211205         * @since 4.3.0
    212          * @access public
    213206         *
    214207         * @global int $cat_id
    215208         *
     
    237230         * Handles the link relation column output.
    238231         *
    239232         * @since 4.3.0
    240          * @access public
    241233         *
    242234         * @param object $link The current link object.
    243235         */
     
    249241         * Handles the link visibility column output.
    250242         *
    251243         * @since 4.3.0
    252          * @access public
    253244         *
    254245         * @param object $link The current link object.
    255246         */
     
    265256         * Handles the link rating column output.
    266257         *
    267258         * @since 4.3.0
    268          * @access public
    269259         *
    270260         * @param object $link The current link object.
    271261         */
     
    277267         * Handles the default column output.
    278268         *
    279269         * @since 4.3.0
    280          * @access public
    281270         *
    282271         * @param object $link        Link object.
    283272         * @param string $column_name Current column name.
     
    311300         * Generates and displays row action links.
    312301         *
    313302         * @since 4.3.0
    314          * @access protected
    315303         *
    316304         * @param object $link        Link being acted upon.
    317305         * @param string $column_name Current column name.
  • src/wp-admin/includes/class-wp-list-table-compat.php

     
    2929        }
    3030
    3131        /**
    32          * @access protected
    3332         *
    3433         * @return array
    3534         */
     
    4342        }
    4443
    4544        /**
    46          * @access public
    4745         *
    4846         * @return array
    4947         */
  • src/wp-admin/includes/class-wp-list-table.php

     
    1919         * The current list of items.
    2020         *
    2121         * @since 3.1.0
    22          * @access public
    2322         * @var array
    2423         */
    2524        public $items;
     
    2827         * Various information about the current table.
    2928         *
    3029         * @since 3.1.0
    31          * @access protected
    3230         * @var array
    3331         */
    3432        protected $_args;
     
    3735         * Various information needed for displaying the pagination.
    3836         *
    3937         * @since 3.1.0
    40          * @access protected
    4138         * @var array
    4239         */
    4340        protected $_pagination_args = array();
     
    4643         * The current screen.
    4744         *
    4845         * @since 3.1.0
    49          * @access protected
    5046         * @var object
    5147         */
    5248        protected $screen;
     
    5551         * Cached bulk actions.
    5652         *
    5753         * @since 3.1.0
    58          * @access private
    5954         * @var array
    6055         */
    6156        private $_actions;
     
    6459         * Cached pagination output.
    6560         *
    6661         * @since 3.1.0
    67          * @access private
    6862         * @var string
    6963         */
    7064        private $_pagination;
     
    7367         * The view switcher modes.
    7468         *
    7569         * @since 4.1.0
    76          * @access protected
    7770         * @var array
    7871         */
    7972        protected $modes = array();
     
    8275         * Stores the value returned by ->get_column_info().
    8376         *
    8477         * @since 4.1.0
    85          * @access protected
    8678         * @var array
    8779         */
    8880        protected $_column_headers;
     
    9082        /**
    9183         * {@internal Missing Summary}
    9284         *
    93          * @access protected
    9485         * @var array
    9586         */
    9687        protected $compat_fields = array( '_args', '_pagination_args', 'screen', '_actions', '_pagination' );
     
    9889        /**
    9990         * {@internal Missing Summary}
    10091         *
    101          * @access protected
    10292         * @var array
    10393         */
    10494        protected $compat_methods = array( 'set_pagination_args', 'get_views', 'get_bulk_actions', 'bulk_actions',
     
    113103         * the default $args.
    114104         *
    115105         * @since 3.1.0
    116          * @access public
    117106         *
    118107         * @param array|string $args {
    119108         *     Array or string of arguments.
     
    169158         * Make private properties readable for backward compatibility.
    170159         *
    171160         * @since 4.0.0
    172          * @access public
    173161         *
    174162         * @param string $name Property to get.
    175163         * @return mixed Property.
     
    184172         * Make private properties settable for backward compatibility.
    185173         *
    186174         * @since 4.0.0
    187          * @access public
    188175         *
    189176         * @param string $name  Property to check if set.
    190177         * @param mixed  $value Property value.
     
    200187         * Make private properties checkable for backward compatibility.
    201188         *
    202189         * @since 4.0.0
    203          * @access public
    204190         *
    205191         * @param string $name Property to check if set.
    206192         * @return bool Whether the property is set.
     
    215201         * Make private properties un-settable for backward compatibility.
    216202         *
    217203         * @since 4.0.0
    218          * @access public
    219204         *
    220205         * @param string $name Property to unset.
    221206         */
     
    229214         * Make private/protected methods readable for backward compatibility.
    230215         *
    231216         * @since 4.0.0
    232          * @access public
    233217         *
    234218         * @param callable $name      Method to call.
    235219         * @param array    $arguments Arguments to pass when calling.
     
    246230         * Checks the current user's permissions
    247231         *
    248232         * @since 3.1.0
    249          * @access public
    250233         * @abstract
    251234         */
    252235        public function ajax_user_can() {
     
    258241         * @uses WP_List_Table::set_pagination_args()
    259242         *
    260243         * @since 3.1.0
    261          * @access public
    262244         * @abstract
    263245         */
    264246        public function prepare_items() {
     
    269251         * An internal method that sets all the necessary pagination arguments
    270252         *
    271253         * @since 3.1.0
    272          * @access protected
    273254         *
    274255         * @param array|string $args Array or string of arguments with information about the pagination.
    275256         */
     
    296277         * Access the pagination args.
    297278         *
    298279         * @since 3.1.0
    299          * @access public
    300280         *
    301281         * @param string $key Pagination argument to retrieve. Common values include 'total_items',
    302282         *                    'total_pages', 'per_page', or 'infinite_scroll'.
     
    316296         * Whether the table has items to display or not
    317297         *
    318298         * @since 3.1.0
    319          * @access public
    320299         *
    321300         * @return bool
    322301         */
     
    328307         * Message to be displayed when there are no items
    329308         *
    330309         * @since 3.1.0
    331          * @access public
    332310         */
    333311        public function no_items() {
    334312                _e( 'No items found.' );
     
    338316         * Displays the search box.
    339317         *
    340318         * @since 3.1.0
    341          * @access public
    342319         *
    343320         * @param string $text     The 'submit' button label.
    344321         * @param string $input_id ID attribute value for the search input field.
     
    371348         * of views available on this table.
    372349         *
    373350         * @since 3.1.0
    374          * @access protected
    375351         *
    376352         * @return array
    377353         */
     
    383359         * Display the list of views available on this table.
    384360         *
    385361         * @since 3.1.0
    386          * @access public
    387362         */
    388363        public function views() {
    389364                $views = $this->get_views();
     
    417392         * of bulk actions available on this table.
    418393         *
    419394         * @since 3.1.0
    420          * @access protected
    421395         *
    422396         * @return array
    423397         */
     
    429403         * Display the bulk actions dropdown.
    430404         *
    431405         * @since 3.1.0
    432          * @access protected
    433406         *
    434407         * @param string $which The location of the bulk actions: 'top' or 'bottom'.
    435408         *                      This is designated as optional for backward compatibility.
     
    478451         * Get the current action selected from the bulk actions dropdown.
    479452         *
    480453         * @since 3.1.0
    481          * @access public
    482454         *
    483455         * @return string|false The action name or False if no action was selected
    484456         */
     
    499471         * Generate row actions div
    500472         *
    501473         * @since 3.1.0
    502          * @access protected
    503474         *
    504475         * @param array $actions The list of actions
    505476         * @param bool $always_visible Whether the actions should be always visible
     
    529500         * Display a monthly dropdown for filtering items
    530501         *
    531502         * @since 3.1.0
    532          * @access protected
    533503         *
    534504         * @global wpdb      $wpdb
    535505         * @global WP_Locale $wp_locale
     
    610580         * Display a view switcher
    611581         *
    612582         * @since 3.1.0
    613          * @access protected
    614583         *
    615584         * @param string $current_mode
    616585         */
     
    639608         * Display a comment count bubble
    640609         *
    641610         * @since 3.1.0
    642          * @access protected
    643611         *
    644612         * @param int $post_id          The post ID.
    645613         * @param int $pending_comments Number of pending comments.
     
    691659         * Get the current page number
    692660         *
    693661         * @since 3.1.0
    694          * @access public
    695662         *
    696663         * @return int
    697664         */
     
    708675         * Get number of items to display on a single page
    709676         *
    710677         * @since 3.1.0
    711          * @access protected
    712678         *
    713679         * @param string $option
    714680         * @param int    $default
     
    739705         * Display the pagination.
    740706         *
    741707         * @since 3.1.0
    742          * @access protected
    743708         *
    744709         * @param string $which
    745710         */
     
    864829         * 'internal-name' => 'Title'
    865830         *
    866831         * @since 3.1.0
    867          * @access public
    868832         * @abstract
    869833         *
    870834         * @return array
     
    882846         * The second format will make the initial sorting order be descending
    883847         *
    884848         * @since 3.1.0
    885          * @access protected
    886849         *
    887850         * @return array
    888851         */
     
    894857         * Gets the name of the default primary column.
    895858         *
    896859         * @since 4.3.0
    897          * @access protected
    898860         *
    899861         * @return string Name of the default primary column, in this case, an empty string.
    900862         */
     
    924886         * Public wrapper for WP_List_Table::get_default_primary_column_name().
    925887         *
    926888         * @since 4.4.0
    927          * @access public
    928889         *
    929890         * @return string Name of the default primary column.
    930891         */
     
    936897         * Gets the name of the primary column.
    937898         *
    938899         * @since 4.3.0
    939          * @access protected
    940900         *
    941901         * @return string The name of the primary column.
    942902         */
     
    971931         * Get a list of all, hidden and sortable columns, with filter applied
    972932         *
    973933         * @since 3.1.0
    974          * @access protected
    975934         *
    976935         * @return array
    977936         */
     
    1026985         * Return number of visible columns
    1027986         *
    1028987         * @since 3.1.0
    1029          * @access public
    1030988         *
    1031989         * @return int
    1032990         */
     
    1040998         * Print column headers, accounting for hidden and sortable columns.
    1041999         *
    10421000         * @since 3.1.0
    1043          * @access public
    10441001         *
    10451002         * @staticvar int $cb_counter
    10461003         *
     
    11181075         * Display the table
    11191076         *
    11201077         * @since 3.1.0
    1121          * @access public
    11221078         */
    11231079        public function display() {
    11241080                $singular = $this->_args['singular'];
     
    11561112         * Get a list of CSS classes for the WP_List_Table table tag.
    11571113         *
    11581114         * @since 3.1.0
    1159          * @access protected
    11601115         *
    11611116         * @return array List of CSS classes for the table tag.
    11621117         */
     
    11681123         * Generate the table navigation above or below the table
    11691124         *
    11701125         * @since 3.1.0
    1171          * @access protected
    11721126         * @param string $which
    11731127         */
    11741128        protected function display_tablenav( $which ) {
     
    11961150         * Extra controls to be displayed between bulk actions and pagination
    11971151         *
    11981152         * @since 3.1.0
    1199          * @access protected
    12001153         *
    12011154         * @param string $which
    12021155         */
     
    12061159         * Generate the tbody element for the list table.
    12071160         *
    12081161         * @since 3.1.0
    1209          * @access public
    12101162         */
    12111163        public function display_rows_or_placeholder() {
    12121164                if ( $this->has_items() ) {
     
    12221174         * Generate the table rows
    12231175         *
    12241176         * @since 3.1.0
    1225          * @access public
    12261177         */
    12271178        public function display_rows() {
    12281179                foreach ( $this->items as $item )
     
    12331184         * Generates content for a single row of the table
    12341185         *
    12351186         * @since 3.1.0
    1236          * @access public
    12371187         *
    12381188         * @param object $item The current item
    12391189         */
     
    12601210         * Generates the columns for a single row of the table
    12611211         *
    12621212         * @since 3.1.0
    1263          * @access protected
    12641213         *
    12651214         * @param object $item The current item
    12661215         */
     
    13131262         * Generates and display row actions links for the list table.
    13141263         *
    13151264         * @since 4.3.0
    1316          * @access protected
    13171265         *
    13181266         * @param object $item        The item being acted upon.
    13191267         * @param string $column_name Current column name.
     
    13281276         * Handle an incoming ajax request (called from admin-ajax.php)
    13291277         *
    13301278         * @since 3.1.0
    1331          * @access public
    13321279         */
    13331280        public function ajax_response() {
    13341281                $this->prepare_items();
     
    13611308        /**
    13621309         * Send required variables to JavaScript land
    13631310         *
    1364          * @access public
    13651311         */
    13661312        public function _js_vars() {
    13671313                $args = array(
  • src/wp-admin/includes/class-wp-media-list-table.php

     
    2121         *
    2222         * @since 4.4.0
    2323         * @var array
    24          * @access protected
    2524         */
    2625        protected $comment_pending_count = array();
    2726
     
    3332         * Constructor.
    3433         *
    3534         * @since 3.1.0
    36          * @access public
    3735         *
    3836         * @see WP_List_Table::__construct() for more information on default arguments.
    3937         *
     
    210208        }
    211209
    212210        /**
    213          * @access public
    214211         */
    215212        public function no_items() {
    216213                _e( 'No media files found.' );
     
    341338         * Handles the checkbox column output.
    342339         *
    343340         * @since 4.3.0
    344          * @access public
    345341         *
    346342         * @param WP_Post $post The current WP_Post object.
    347343         */
     
    358354         * Handles the title column output.
    359355         *
    360356         * @since 4.3.0
    361          * @access public
    362357         *
    363358         * @param WP_Post $post The current WP_Post object.
    364359         */
     
    405400         * Handles the author column output.
    406401         *
    407402         * @since 4.3.0
    408          * @access public
    409403         *
    410404         * @param WP_Post $post The current WP_Post object.
    411405         */
     
    420414         * Handles the description column output.
    421415         *
    422416         * @since 4.3.0
    423          * @access public
    424417         *
    425418         * @param WP_Post $post The current WP_Post object.
    426419         */
     
    432425         * Handles the date column output.
    433426         *
    434427         * @since 4.3.0
    435          * @access public
    436428         *
    437429         * @param WP_Post $post The current WP_Post object.
    438430         */
     
    460452         * Handles the parent column output.
    461453         *
    462454         * @since 4.3.0
    463          * @access public
    464455         *
    465456         * @param WP_Post $post The current WP_Post object.
    466457         */
     
    521512         * Handles the comments column output.
    522513         *
    523514         * @since 4.3.0
    524          * @access public
    525515         *
    526516         * @param WP_Post $post The current WP_Post object.
    527517         */
     
    543533         * Handles output for the default column.
    544534         *
    545535         * @since 4.3.0
    546          * @access public
    547536         *
    548537         * @param WP_Post $post        The current WP_Post object.
    549538         * @param string  $column_name Current column name.
     
    629618         * Gets the name of the default primary column.
    630619         *
    631620         * @since 4.3.0
    632          * @access protected
    633621         *
    634622         * @return string Name of the default primary column, in this case, 'title'.
    635623         */
     
    764752         * Generates and displays row action links.
    765753         *
    766754         * @since 4.3.0
    767          * @access protected
    768755         *
    769756         * @param object $post        Attachment being acted upon.
    770757         * @param string $column_name Current column name.
  • src/wp-admin/includes/class-wp-ms-sites-list-table.php

     
    2121         * Site status list.
    2222         *
    2323         * @since 4.3.0
    24          * @access public
    2524         * @var array
    2625         */
    2726        public $status_list;
     
    3029         * Constructor.
    3130         *
    3231         * @since 3.1.0
    33          * @access public
    3432         *
    3533         * @see WP_List_Table::__construct() for more information on default arguments.
    3634         *
     
    186184        }
    187185
    188186        /**
    189          * @access public
    190187         */
    191188        public function no_items() {
    192189                _e( 'No sites found.' );
     
    262259         * Handles the checkbox column output.
    263260         *
    264261         * @since 4.3.0
    265          * @access public
    266262         *
    267263         * @param array $blog Current site.
    268264         */
     
    281277         * Handles the ID column output.
    282278         *
    283279         * @since 4.4.0
    284          * @access public
    285280         *
    286281         * @param array $blog Current site.
    287282         */
     
    293288         * Handles the site name column output.
    294289         *
    295290         * @since 4.3.0
    296          * @access public
    297291         *
    298292         * @global string $mode List table view mode.
    299293         *
     
    347341         * Handles the lastupdated column output.
    348342         *
    349343         * @since 4.3.0
    350          * @access public
    351344         *
    352345         * @global string $mode List table view mode.
    353346         *
     
    369362         * Handles the registered column output.
    370363         *
    371364         * @since 4.3.0
    372          * @access public
    373365         *
    374366         * @global string $mode List table view mode.
    375367         *
     
    395387         * Handles the users column output.
    396388         *
    397389         * @since 4.3.0
    398          * @access public
    399390         *
    400391         * @param array $blog Current site.
    401392         */
     
    419410         * Handles the plugins column output.
    420411         *
    421412         * @since 4.3.0
    422          * @access public
    423413         *
    424414         * @param array $blog Current site.
    425415         */
     
    442432         * Handles output for the default column.
    443433         *
    444434         * @since 4.3.0
    445          * @access public
    446435         *
    447436         * @param array  $blog        Current site.
    448437         * @param string $column_name Current column name.
     
    487476         * Gets the name of the default primary column.
    488477         *
    489478         * @since 4.3.0
    490          * @access protected
    491479         *
    492480         * @return string Name of the default primary column, in this case, 'blogname'.
    493481         */
     
    499487         * Generates and displays row action links.
    500488         *
    501489         * @since 4.3.0
    502          * @access protected
    503490         *
    504491         * @param object $blog        Site being acted upon.
    505492         * @param string $column_name Current column name.
  • src/wp-admin/includes/class-wp-ms-themes-list-table.php

     
    2626         * Constructor.
    2727         *
    2828         * @since 3.1.0
    29          * @access public
    3029         *
    3130         * @see WP_List_Table::__construct() for more information on default arguments.
    3231         *
     
    227226        }
    228227
    229228        /**
    230          * @access public
    231229         */
    232230        public function no_items() {
    233231                if ( $this->has_items ) {
     
    263261         * Gets the name of the primary column.
    264262         *
    265263         * @since 4.3.0
    266          * @access protected
    267264         *
    268265         * @return string Unalterable name of the primary column name, in this case, 'name'.
    269266         */
     
    343340        }
    344341
    345342        /**
    346          * @access public
    347343         */
    348344        public function display_rows() {
    349345                foreach ( $this->items as $theme )
     
    354350         * Handles the checkbox column output.
    355351         *
    356352         * @since 4.3.0
    357          * @access public
    358353         *
    359354         * @param WP_Theme $theme The current WP_Theme object.
    360355         */
     
    370365         * Handles the name column output.
    371366         *
    372367         * @since 4.3.0
    373          * @access public
    374368         *
    375369         * @global string $status
    376370         * @global int    $page
     
    512506         * Handles the description column output.
    513507         *
    514508         * @since 4.3.0
    515          * @access public
    516509         *
    517510         * @global string $status
    518511         * @global array  $totals
     
    580573         * Handles default column output.
    581574         *
    582575         * @since 4.3.0
    583          * @access public
    584576         *
    585577         * @param WP_Theme $theme       The current WP_Theme object.
    586578         * @param string   $column_name The current column name.
     
    604596         * Handles the output for a single table row.
    605597         *
    606598         * @since 4.3.0
    607          * @access public
    608599         *
    609600         * @param WP_Theme $item The current WP_Theme object.
    610601         */
  • src/wp-admin/includes/class-wp-ms-users-list-table.php

     
    117117        }
    118118
    119119        /**
    120          * @access public
    121120         */
    122121        public function no_items() {
    123122                _e( 'No users found.' );
     
    200199         * Handles the checkbox column output.
    201200         *
    202201         * @since 4.3.0
    203          * @access public
    204202         *
    205203         * @param WP_User $user The current WP_User object.
    206204         */
     
    218216         * Handles the ID column output.
    219217         *
    220218         * @since 4.4.0
    221          * @access public
    222219         *
    223220         * @param WP_User $user The current WP_User object.
    224221         */
     
    230227         * Handles the username column output.
    231228         *
    232229         * @since 4.3.0
    233          * @access public
    234230         *
    235231         * @param WP_User $user The current WP_User object.
    236232         */
     
    253249         * Handles the name column output.
    254250         *
    255251         * @since 4.3.0
    256          * @access public
    257252         *
    258253         * @param WP_User $user The current WP_User object.
    259254         */
     
    269264         * Handles the email column output.
    270265         *
    271266         * @since 4.3.0
    272          * @access public
    273267         *
    274268         * @param WP_User $user The current WP_User object.
    275269         */
     
    281275         * Handles the registered date column output.
    282276         *
    283277         * @since 4.3.0
    284          * @access public
    285278         *
    286279         * @global string $mode List table view mode.
    287280         *
     
    299292
    300293        /**
    301294         * @since 4.3.0
    302          * @access protected
    303295         *
    304296         * @param WP_User $user
    305297         * @param string  $classes
     
    317309         * Handles the sites column output.
    318310         *
    319311         * @since 4.3.0
    320          * @access public
    321312         *
    322313         * @param WP_User $user The current WP_User object.
    323314         */
     
    382373         * Handles the default column output.
    383374         *
    384375         * @since 4.3.0
    385          * @access public
    386376         *
    387377         * @param WP_User $user       The current WP_User object.
    388378         * @param string $column_name The current column name.
     
    416406         * Gets the name of the default primary column.
    417407         *
    418408         * @since 4.3.0
    419          * @access protected
    420409         *
    421410         * @return string Name of the default primary column, in this case, 'username'.
    422411         */
     
    428417         * Generates and displays row action links.
    429418         *
    430419         * @since 4.3.0
    431          * @access protected
    432420         *
    433421         * @param object $user        User being acted upon.
    434422         * @param string $column_name Current column name.
  • src/wp-admin/includes/class-wp-plugin-install-list-table.php

     
    3939         * within get_plugins().
    4040         *
    4141         * @since 4.0.0
    42          * @access protected
    4342         *
    4443         * @return array
    4544         */
     
    228227        }
    229228
    230229        /**
    231          * @access public
    232230         */
    233231        public function no_items() {
    234232                if ( isset( $this->error ) ) {
  • src/wp-admin/includes/class-wp-plugins-list-table.php

     
    2121         * Constructor.
    2222         *
    2323         * @since 3.1.0
    24          * @access public
    2524         *
    2625         * @see WP_List_Table::__construct() for more information on default arguments.
    2726         *
     
    346345         * Displays the search box.
    347346         *
    348347         * @since 4.6.0
    349          * @access public
    350348         *
    351349         * @param string $text     The 'submit' button label.
    352350         * @param string $input_id ID attribute value for the search input field.
     
    864862         * Gets the name of the primary column for this specific list table.
    865863         *
    866864         * @since 4.3.0
    867          * @access protected
    868865         *
    869866         * @return string Unalterable name for the primary column, in this case, 'name'.
    870867         */
  • src/wp-admin/includes/class-wp-posts-list-table.php

     
    2222         *
    2323         * @since 3.1.0
    2424         * @var bool
    25          * @access protected
    2625         */
    2726        protected $hierarchical_display;
    2827
     
    3130         *
    3231         * @since 3.1.0
    3332         * @var array
    34          * @access protected
    3533         */
    3634        protected $comment_pending_count;
    3735
     
    4038         *
    4139         * @since 3.1.0
    4240         * @var int
    43          * @access private
    4441         */
    4542        private $user_posts_count;
    4643
     
    4946         *
    5047         * @since 3.1.0
    5148         * @var int
    52          * @access private
    5349         */
    5450        private $sticky_posts_count = 0;
    5551
     
    5955         * Current level for output.
    6056         *
    6157         * @since 4.3.0
    62          * @access protected
    6358         * @var int
    6459         */
    6560        protected $current_level = 0;
     
    6863         * Constructor.
    6964         *
    7065         * @since 3.1.0
    71          * @access public
    7266         *
    7367         * @see WP_List_Table::__construct() for more information on default arguments.
    7468         *
     
    196190        }
    197191
    198192        /**
    199          * @access public
    200193         */
    201194        public function no_items() {
    202195                if ( isset( $_REQUEST['post_status'] ) && 'trash' === $_REQUEST['post_status'] )
     
    229222         * Helper to create links to edit.php with params.
    230223         *
    231224         * @since 4.4.0
    232          * @access protected
    233225         *
    234226         * @param array  $args  URL parameters for the link.
    235227         * @param string $label Link text.
     
    415407         * Displays a categories drop-down for filtering on the Posts list table.
    416408         *
    417409         * @since 4.6.0
    418          * @access protected
    419410         *
    420411         * @global int $cat Currently selected category.
    421412         *
     
    826817         * Handles the checkbox column output.
    827818         *
    828819         * @since 4.3.0
    829          * @access public
    830820         *
    831821         * @param WP_Post $post The current WP_Post object.
    832822         */
     
    851841
    852842        /**
    853843         * @since 4.3.0
    854          * @access protected
    855844         *
    856845         * @param WP_Post $post
    857846         * @param string  $classes
     
    869858         * Handles the title column output.
    870859         *
    871860         * @since 4.3.0
    872          * @access public
    873861         *
    874862         * @global string $mode List table view mode.
    875863         *
     
    966954         * Handles the post date column output.
    967955         *
    968956         * @since 4.3.0
    969          * @access public
    970957         *
    971958         * @global string $mode List table view mode.
    972959         *
     
    10471034         * Handles the comments column output.
    10481035         *
    10491036         * @since 4.3.0
    1050          * @access public
    10511037         *
    10521038         * @param WP_Post $post The current WP_Post object.
    10531039         */
     
    10671053         * Handles the post author column output.
    10681054         *
    10691055         * @since 4.3.0
    1070          * @access public
    10711056         *
    10721057         * @param WP_Post $post The current WP_Post object.
    10731058         */
     
    10831068         * Handles the default column output.
    10841069         *
    10851070         * @since 4.3.0
    1086          * @access public
    10871071         *
    10881072         * @param WP_Post $post        The current WP_Post object.
    10891073         * @param string  $column_name The current column name.
     
    12091193         * Gets the name of the default primary column.
    12101194         *
    12111195         * @since 4.3.0
    1212          * @access protected
    12131196         *
    12141197         * @return string Name of the default primary column, in this case, 'title'.
    12151198         */
     
    12211204         * Generates and displays row action links.
    12221205         *
    12231206         * @since 4.3.0
    1224          * @access protected
    12251207         *
    12261208         * @param object $post        Post being acted upon.
    12271209         * @param string $column_name Current column name.
  • src/wp-admin/includes/class-wp-press-this.php

     
    2727         * Constructor.
    2828         *
    2929         * @since 4.2.0
    30          * @access public
    3130         */
    3231        public function __construct() {}
    3332
     
    3534         * App and site settings data, including i18n strings for the client-side.
    3635         *
    3736         * @since 4.2.0
    38          * @access public
    3937         *
    4038         * @return array Site settings.
    4139         */
     
    5654         * Get the source's images and save them locally, for posterity, unless we can't.
    5755         *
    5856         * @since 4.2.0
    59          * @access public
    6057         *
    6158         * @param int    $post_id Post ID.
    6259         * @param string $content Optional. Current expected markup for Press This. Expects slashed. Default empty.
     
    9996         * Ajax handler for saving the post as draft or published.
    10097         *
    10198         * @since 4.2.0
    102          * @access public
    10399         */
    104100        public function save_post() {
    105101                if ( empty( $_POST['post_ID'] ) || ! $post_id = (int) $_POST['post_ID'] ) {
     
    210206         * Ajax handler for adding a new category.
    211207         *
    212208         * @since 4.2.0
    213          * @access public
    214209         */
    215210        public function add_category() {
    216211                if ( false === wp_verify_nonce( $_POST['new_cat_nonce'], 'add-category' ) ) {
     
    279274         * Downloads the source's HTML via server-side call for the given URL.
    280275         *
    281276         * @since 4.2.0
    282          * @access public
    283277         *
    284278         * @param string $url URL to scan.
    285279         * @return string Source's HTML sanitized markup
     
    562556         * Fetches and parses _meta, _images, and _links data from the source.
    563557         *
    564558         * @since 4.2.0
    565          * @access public
    566559         *
    567560         * @param string $url  URL to scan.
    568561         * @param array  $data Optional. Existing data array if you have one. Default empty array.
     
    672665         * Handles backward-compat with the legacy version of Press This by supporting its query string params.
    673666         *
    674667         * @since 4.2.0
    675          * @access public
    676668         *
    677669         * @return array
    678670         */
     
    798790         * Adds another stylesheet inside TinyMCE.
    799791         *
    800792         * @since 4.2.0
    801          * @access public
    802793         *
    803794         * @param string $styles URL to editor stylesheet.
    804795         * @return string Possibly modified stylesheets list.
     
    820811         * Outputs the post format selection HTML.
    821812         *
    822813         * @since 4.2.0
    823          * @access public
    824814         *
    825815         * @param WP_Post $post Post object.
    826816         */
     
    868858         * Outputs the categories HTML.
    869859         *
    870860         * @since 4.2.0
    871          * @access public
    872861         *
    873862         * @param WP_Post $post Post object.
    874863         */
     
    926915         * Outputs the tags HTML.
    927916         *
    928917         * @since 4.2.0
    929          * @access public
    930918         *
    931919         * @param WP_Post $post Post object.
    932920         */
     
    977965         * Get a list of embeds with no duplicates.
    978966         *
    979967         * @since 4.2.0
    980          * @access public
    981968         *
    982969         * @param array $data The site's data.
    983970         * @return array Embeds selected to be available.
     
    1010997         * Get a list of images with no duplicates.
    1011998         *
    1012999         * @since 4.2.0
    1013          * @access public
    10141000         *
    10151001         * @param array $data The site's data.
    10161002         * @return array
     
    10441030         * Gets the source page's canonical link, based on passed location and meta data.
    10451031         *
    10461032         * @since 4.2.0
    1047          * @access public
    10481033         *
    10491034         * @param array $data The site's data.
    10501035         * @return string Discovered canonical URL, or empty
     
    10751060         * Gets the source page's site name, based on passed meta data.
    10761061         *
    10771062         * @since 4.2.0
    1078          * @access public
    10791063         *
    10801064         * @param array $data The site's data.
    10811065         * @return string Discovered site name, or empty
     
    10981082         * Gets the source page's title, based on passed title and meta data.
    10991083         *
    11001084         * @since 4.2.0
    1101          * @access public
    11021085         *
    11031086         * @param array $data The site's data.
    11041087         * @return string Discovered page title, or empty
     
    11271110         * Features a blockquoted excerpt, as well as content attribution, if any.
    11281111         *
    11291112         * @since 4.2.0
    1130          * @access public
    11311113         *
    11321114         * @param array $data The site's data.
    11331115         * @return string Discovered content, or empty
     
    12121194         * Serves the app's base HTML, which in turns calls the load script.
    12131195         *
    12141196         * @since 4.2.0
    1215          * @access public
    12161197         *
    12171198         * @global WP_Locale $wp_locale
    12181199         * @global bool      $is_IE
  • src/wp-admin/includes/class-wp-screen.php

     
    1818         *
    1919         * @since 3.3.0
    2020         * @var string
    21          * @access public
    2221         */
    2322        public $action;
    2423
     
    2827         *
    2928         * @since 3.3.0
    3029         * @var string
    31          * @access public
    3230         */
    3331        public $base;
    3432
     
    3735         *
    3836         * @since 3.4.0
    3937         * @var int
    40          * @access private
    4138         */
    4239        private $columns = 0;
    4340
     
    4643         *
    4744         * @since 3.3.0
    4845         * @var string
    49          * @access public
    5046         */
    5147        public $id;
    5248
     
    5551         *
    5652         * @since 3.5.0
    5753         * @var string
    58          * @access protected
    5954         */
    6055        protected $in_admin;
    6156
     
    6762         * @since 3.3.0
    6863         * @deprecated 3.5.0
    6964         * @var bool
    70          * @access public
    7165         */
    7266        public $is_network;
    7367
     
    7973         * @since 3.3.0
    8074         * @deprecated 3.5.0
    8175         * @var bool
    82          * @access public
    8376         */
    8477        public $is_user;
    8578
     
    9083         *
    9184         * @since 3.3.0
    9285         * @var string
    93          * @access public
    9486         */
    9587        public $parent_base;
    9688
     
    10092         *
    10193         * @since 3.3.0
    10294         * @var string
    103          * @access public
    10495         */
    10596        public $parent_file;
    10697
     
    111102         *
    112103         * @since 3.3.0
    113104         * @var string
    114          * @access public
    115105         */
    116106        public $post_type;
    117107
     
    120110         * The 'edit-tags.php?taxonomy=category' screen has a taxonomy of 'category'.
    121111         * @since 3.3.0
    122112         * @var string
    123          * @access public
    124113         */
    125114        public $taxonomy;
    126115
     
    129118         *
    130119         * @since 3.3.0
    131120         * @var array
    132          * @access private
    133121         */
    134122        private $_help_tabs = array();
    135123
     
    138126         *
    139127         * @since 3.3.0
    140128         * @var string
    141          * @access private
    142129         */
    143130        private $_help_sidebar = '';
    144131
     
    146133         * The accessible hidden headings and text associated with the screen, if any.
    147134         *
    148135         * @since 4.4.0
    149          * @access private
    150136         * @var array
    151137         */
    152138        private $_screen_reader_content = array();
     
    155141         * Stores old string-based help.
    156142         *
    157143         * @static
    158          * @access private
    159144         *
    160145         * @var array
    161146         */
     
    166151         *
    167152         * @since 3.3.0
    168153         * @var array
    169          * @access private
    170154         */
    171155        private $_options = array();
    172156
     
    176160         * @since 3.3.0
    177161         *
    178162         * @static
    179          * @access private
    180163         *
    181164         * @var array
    182165         */
     
    187170         *
    188171         * @since 3.3.0
    189172         * @var bool
    190          * @access private
    191173         */
    192174        private $_show_screen_options;
    193175
     
    196178         *
    197179         * @since 3.3.0
    198180         * @var string
    199          * @access private
    200181         */
    201182        private $_screen_settings;
    202183
     
    204185         * Fetches a screen object.
    205186         *
    206187         * @since 3.3.0
    207          * @access public
    208188         *
    209189         * @static
    210190         *
     
    400380         * Constructor
    401381         *
    402382         * @since 3.3.0
    403          * @access private
    404383         */
    405384        private function __construct() {}
    406385
  • src/wp-admin/includes/class-wp-site-icon.php

     
    1818         * The minimum size of the site icon.
    1919         *
    2020         * @since 4.3.0
    21          * @access public
    2221         * @var int
    2322         */
    2423        public $min_size  = 512;
     
    2726         * The size to which to crop the image so that we can display it in the UI nicely.
    2827         *
    2928         * @since 4.3.0
    30          * @access public
    3129         * @var int
    3230         */
    3331        public $page_crop = 512;
     
    3634         * List of site icon sizes.
    3735         *
    3836         * @since 4.3.0
    39          * @access public
    4037         * @var array
    4138         */
    4239        public $site_icon_sizes = array(
     
    7067         * Registers actions and filters.
    7168         *
    7269         * @since 4.3.0
    73          * @access public
    7470         */
    7571        public function __construct() {
    7672                add_action( 'delete_attachment', array( $this, 'delete_attachment_data' ) );
     
    110106         * Inserts an attachment.
    111107         *
    112108         * @since 4.3.0
    113          * @access public
    114109         *
    115110         * @param array  $object Attachment object.
    116111         * @param string $file   File path of the attached image.
     
    139134         * Adds additional sizes to be made when creating the site_icon images.
    140135         *
    141136         * @since 4.3.0
    142          * @access public
    143137         *
    144138         * @param array $sizes List of additional sizes.
    145139         * @return array Additional image sizes.
     
    184178         * Adds Site Icon sizes to the array of image sizes on demand.
    185179         *
    186180         * @since 4.3.0
    187          * @access public
    188181         *
    189182         * @param array $sizes List of image sizes.
    190183         * @return array List of intermediate image sizes.
     
    203196         * Deletes the Site Icon when the image file is deleted.
    204197         *
    205198         * @since 4.3.0
    206          * @access public
    207199         *
    208200         * @param int $post_id Attachment ID.
    209201         */
     
    219211         * Adds custom image sizes when meta data for an image is requested, that happens to be used as Site Icon.
    220212         *
    221213         * @since 4.3.0
    222          * @access public
    223214         *
    224215         * @param null|array|string $value    The value get_metadata() should return a single metadata value, or an
    225216         *                                    array of values.
  • src/wp-admin/includes/class-wp-terms-list-table.php

     
    2525         * Constructor.
    2626         *
    2727         * @since 3.1.0
    28          * @access public
    2928         *
    3029         * @see WP_List_Table::__construct() for more information on default arguments.
    3130         *
     
    7271        }
    7372
    7473        /**
    75          * @access public
    7674         */
    7775        public function prepare_items() {
    7876                $tags_per_page = $this->get_items_per_page( 'edit_' . $this->screen->taxonomy . '_per_page' );
     
    139137        }
    140138
    141139        /**
    142          * @access public
    143140         */
    144141        public function no_items() {
    145142                echo get_taxonomy( $this->screen->taxonomy )->labels->not_found;
     
    206203        }
    207204
    208205        /**
    209          * @access public
    210206         */
    211207        public function display_rows_or_placeholder() {
    212208                $taxonomy = $this->screen->taxonomy;
     
    399395         * Gets the name of the default primary column.
    400396         *
    401397         * @since 4.3.0
    402          * @access protected
    403398         *
    404399         * @return string Name of the default primary column, in this case, 'name'.
    405400         */
     
    411406         * Generates and displays row action links.
    412407         *
    413408         * @since 4.3.0
    414          * @access protected
    415409         *
    416410         * @param WP_Term $tag         Tag being acted upon.
    417411         * @param string  $column_name Current column name.
  • src/wp-admin/includes/class-wp-theme-install-list-table.php

     
    154154        }
    155155
    156156        /**
    157          * @access public
    158157         */
    159158        public function no_items() {
    160159                _e( 'No themes match your request.' );
     
    180179        }
    181180
    182181        /**
    183          * @access public
    184182         */
    185183        public function display() {
    186184                wp_nonce_field( "fetch-list-" . get_class( $this ), '_ajax_fetch_list_nonce' );
     
    209207        }
    210208
    211209        /**
    212          * @access public
    213210         */
    214211        public function display_rows() {
    215212                $themes = $this->items;
     
    227224         * Prints a theme from the WordPress.org API.
    228225         *
    229226         * @since 3.1.0
    230          * @access public
    231227         *
    232228         * @global array $themes_allowedtags
    233229         *
     
    436432         * Send required variables to JavaScript land
    437433         *
    438434         * @since 3.4.0
    439          * @access public
    440435         *
    441436         * @global string $tab  Current tab within Themes->Install screen
    442437         * @global string $type Type of search.
     
    452447         * Check to see if the theme is already installed.
    453448         *
    454449         * @since 3.4.0
    455          * @access private
    456450         *
    457451         * @param object $theme - A WordPress.org Theme API object.
    458452         * @return string Theme status.
  • src/wp-admin/includes/class-wp-themes-list-table.php

     
    2424         * Constructor.
    2525         *
    2626         * @since 3.1.0
    27          * @access public
    2827         *
    2928         * @see WP_List_Table::__construct() for more information on default arguments.
    3029         *
     
    4746        }
    4847
    4948        /**
    50          * @access public
    5149         */
    5250        public function prepare_items() {
    5351                $themes = wp_get_themes( array( 'allowed' => true ) );
     
    8381        }
    8482
    8583        /**
    86          * @access public
    8784         */
    8885        public function no_items() {
    8986                if ( $this->search_terms || $this->features ) {
     
    130127        }
    131128
    132129        /**
    133          * @access public
    134130         */
    135131        public function display() {
    136132                wp_nonce_field( "fetch-list-" . get_class( $this ), '_ajax_fetch_list_nonce' );
     
    154150        }
    155151
    156152        /**
    157          * @access public
    158153         */
    159154        public function display_rows_or_placeholder() {
    160155                if ( $this->has_items() ) {
     
    167162        }
    168163
    169164        /**
    170          * @access public
    171165         */
    172166        public function display_rows() {
    173167                $themes = $this->items;
     
    286280         * Send required variables to JavaScript land
    287281         *
    288282         * @since 3.4.0
    289          * @access public
    290283         *
    291284         * @param array $extra_args
    292285         */
  • src/wp-admin/includes/class-wp-upgrader-skin.php

     
    2323         * Holds the result of an upgrade.
    2424         *
    2525         * @since 2.8.0
    26          * @access public
    2726         * @var string|bool|WP_Error
    2827         */
    2928        public $result = false;
    3029        public $options = array();
    3130
    3231        /**
    33          * @access public
    3432         *
    3533         * @param array $args
    3634         */
     
    4038        }
    4139
    4240        /**
    43          * @access public
    4441         *
    4542         * @param WP_Upgrader $upgrader
    4643         */
     
    5148        }
    5249
    5350        /**
    54          * @access public
    5551         */
    5652        public function add_strings() {
    5753        }
     
    6056         * Sets the result of an upgrade.
    6157         *
    6258         * @since 2.8.0
    63          * @access public
    6459         *
    6560         * @param string|bool|WP_Error $result The result of an upgrade.
    6661         */
     
    7469         *
    7570         * @since 2.8.0
    7671         * @since 4.6.0 The `$context` parameter default changed from `false` to an empty string.
    77          * @access public
    7872         *
    7973         * @see request_filesystem_credentials()
    8074         *
     
    10094        }
    10195
    10296        /**
    103          * @access public
    10497         */
    10598        public function header() {
    10699                if ( $this->done_header ) {
     
    112105        }
    113106
    114107        /**
    115          * @access public
    116108         */
    117109        public function footer() {
    118110                if ( $this->done_footer ) {
     
    123115        }
    124116
    125117        /**
    126          * @access public
    127118         *
    128119         * @param string|WP_Error $errors
    129120         */
     
    143134        }
    144135
    145136        /**
    146          * @access public
    147137         *
    148138         * @param string $string
    149139         */
     
    166156        }
    167157
    168158        /**
    169          * @access public
    170159         */
    171160        public function before() {}
    172161
    173162        /**
    174          * @access public
    175163         */
    176164        public function after() {}
    177165
     
    179167         * Output JavaScript that calls function to decrement the update counts.
    180168         *
    181169         * @since 3.9.0
    182          * @access protected
    183170         *
    184171         * @param string $type Type of update count to decrement. Likely values include 'plugin',
    185172         *                     'theme', 'translation', etc.
     
    207194        }
    208195
    209196        /**
    210          * @access public
    211197         */
    212198        public function bulk_header() {}
    213199
    214200        /**
    215          * @access public
    216201         */
    217202        public function bulk_footer() {}
    218203}
  • src/wp-admin/includes/class-wp-upgrader.php

     
    5454         * The error/notification strings used to update the user on the progress.
    5555         *
    5656         * @since 2.8.0
    57          * @access public
    5857         * @var array $strings
    5958         */
    6059        public $strings = array();
     
    6362         * The upgrader skin being used.
    6463         *
    6564         * @since 2.8.0
    66          * @access public
    6765         * @var Automatic_Upgrader_Skin|WP_Upgrader_Skin $skin
    6866         */
    6967        public $skin = null;
     
    7775         * it.
    7876         *
    7977         * @since 2.8.0
    80          * @access public
    8178         *
    8279         * @var WP_Error|array $result {
    8380         *      @type string $source             The full path to the source the files were installed from.
     
    10097         * Set by the bulk update methods.
    10198         *
    10299         * @since 3.0.0
    103          * @access public
    104100         * @var int $update_count
    105101         */
    106102        public $update_count = 0;
     
    111107         * Used by the bulk update methods, and incremented for each update.
    112108         *
    113109         * @since 3.0.0
    114          * @access public
    115110         * @var int
    116111         */
    117112        public $update_current = 0;
     
    120115         * Construct the upgrader with a skin.
    121116         *
    122117         * @since 2.8.0
    123          * @access public
    124118         *
    125119         * @param WP_Upgrader_Skin $skin The upgrader skin to use. Default is a WP_Upgrader_Skin.
    126120         *                               instance.
     
    139133         * and also add the generic strings to `WP_Upgrader::$strings`.
    140134         *
    141135         * @since 2.8.0
    142          * @access public
    143136         */
    144137        public function init() {
    145138                $this->skin->set_upgrader($this);
     
    150143         * Add the generic strings to WP_Upgrader::$strings.
    151144         *
    152145         * @since 2.8.0
    153          * @access public
    154146         */
    155147        public function generic_strings() {
    156148                $this->strings['bad_request'] = __('Invalid data provided.');
     
    179171         * Connect to the filesystem.
    180172         *
    181173         * @since 2.8.0
    182          * @access public
    183174         *
    184175         * @global WP_Filesystem_Base $wp_filesystem Subclass
    185176         *
     
    243234         * Download a package.
    244235         *
    245236         * @since 2.8.0
    246          * @access public
    247237         *
    248238         * @param string $package The URI of the package. If this is the full path to an
    249239         *                        existing local file, it will be returned untouched.
     
    286276         * Unpack a compressed package file.
    287277         *
    288278         * @since 2.8.0
    289          * @access public
    290279         *
    291280         * @global WP_Filesystem_Base $wp_filesystem Subclass
    292281         *
     
    338327         * Clears the directory where this item is going to be installed into.
    339328         *
    340329         * @since 4.3.0
    341          * @access public
    342330         *
    343331         * @global WP_Filesystem_Base $wp_filesystem Subclass
    344332         *
     
    402390         * clear out the destination folder if it already exists.
    403391         *
    404392         * @since 2.8.0
    405          * @access public
    406393         *
    407394         * @global WP_Filesystem_Base $wp_filesystem Subclass
    408395         * @global array              $wp_theme_directories
     
    610597         * install it in the destination folder.
    611598         *
    612599         * @since 2.8.0
    613          * @access public
    614600         *
    615601         * @param array $options {
    616602         *     Array or string of arguments for upgrading/installing a package.
     
    802788         * Creates/deletes the maintenance file to enable/disable maintenance mode.
    803789         *
    804790         * @since 2.8.0
    805          * @access public
    806791         *
    807792         * @global WP_Filesystem_Base $wp_filesystem Subclass
    808793         *
  • src/wp-admin/includes/class-wp-users-list-table.php

     
    2121         * Site ID to generate the Users list table for.
    2222         *
    2323         * @since 3.1.0
    24          * @access public
    2524         * @var int
    2625         */
    2726        public $site_id;
     
    3029         * Whether or not the current Users list table is for Multisite.
    3130         *
    3231         * @since 3.1.0
    33          * @access public
    3432         * @var bool
    3533         */
    3634        public $is_site_users;
     
    3937         * Constructor.
    4038         *
    4139         * @since 3.1.0
    42          * @access public
    4340         *
    4441         * @see WP_List_Table::__construct() for more information on default arguments.
    4542         *
     
    6259         * Check the current user's permissions.
    6360         *
    6461         * @since 3.1.0
    65          * @access public
    6662         *
    6763         * @return bool
    6864         */
     
    7773         * Prepare the users list for display.
    7874         *
    7975         * @since 3.1.0
    80          * @access public
    8176         *
    8277         * @global string $role
    8378         * @global string $usersearch
     
    149144         * Output 'no users' message.
    150145         *
    151146         * @since 3.1.0
    152          * @access public
    153147         */
    154148        public function no_items() {
    155149                _e( 'No users found.' );
     
    163157         * Filtersing of the user table.
    164158         *
    165159         * @since  3.1.0
    166          * @access protected
    167160         *
    168161         * @global string $role
    169162         *
     
    229222         * Retrieve an associative array of bulk actions available on this table.
    230223         *
    231224         * @since  3.1.0
    232          * @access protected
    233225         *
    234226         * @return array Array of bulk actions.
    235227         */
     
    251243         * Output the controls to allow user roles to be changed in bulk.
    252244         *
    253245         * @since 3.1.0
    254          * @access protected
    255246         *
    256247         * @param string $which Whether this is being invoked above ("top")
    257248         *                      or below the table ("bottom").
     
    302293         * the role change drop-down.
    303294         *
    304295         * @since  3.1.0
    305          * @access public
    306296         *
    307297         * @return string The bulk action required.
    308298         */
     
    319309         * Get a list of columns for the list table.
    320310         *
    321311         * @since  3.1.0
    322          * @access public
    323312         *
    324313         * @return array Array in which the key is the ID of the column,
    325314         *               and the value is the description.
     
    344333         * Get a list of sortable columns for the list table.
    345334         *
    346335         * @since 3.1.0
    347          * @access protected
    348336         *
    349337         * @return array Array of sortable columns.
    350338         */
     
    361349         * Generate the list table rows.
    362350         *
    363351         * @since 3.1.0
    364          * @access public
    365352         */
    366353        public function display_rows() {
    367354                // Query the post counts for this page
     
    379366         * @since 3.1.0
    380367         * @since 4.2.0 The `$style` parameter was deprecated.
    381368         * @since 4.4.0 The `$role` parameter was deprecated.
    382          * @access public
    383369         *
    384370         * @param WP_User $user_object The current user object.
    385371         * @param string  $style       Deprecated. Not used.
     
    548534         * Gets the name of the default primary column.
    549535         *
    550536         * @since 4.3.0
    551          * @access protected
    552537         *
    553538         * @return string Name of the default primary column, in this case, 'username'.
    554539         */
     
    560545         * Returns an array of user roles for a given user object.
    561546         *
    562547         * @since 4.4.0
    563          * @access protected
    564548         *
    565549         * @param WP_User $user_object The WP_User object.
    566550         * @return array An array of user roles.