WordPress.org

Make WordPress Core

Changeset 34822


Ignore:
Timestamp:
10/05/2015 02:34:47 AM (4 years ago)
Author:
DrewAPicture
Message:

Docs: Add missing method summaries for the deprecated WP_User_Search class, including prepare_query(), query(), prepare_vars_for_template_usage(), do_paging(), and get_results().

See #32246.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/deprecated.php

    r34821 r34822  
    508508
    509509    /**
    510      * {@internal Missing Short Description}}
    511      *
    512      * {@internal Missing Long Description}}
     510     * Prepares the user search query (legacy).
    513511     *
    514512     * @since 2.1.0
    515513     * @access public
    516514     */
    517     function prepare_query() {
     515    public function prepare_query() {
    518516        global $wpdb;
    519517        $this->first_user = ($this->page - 1) * $this->users_per_page;
     
    548546
    549547    /**
    550      * {@internal Missing Short Description}}
    551      *
    552      * {@internal Missing Long Description}}
     548     * Executes the user search query.
    553549     *
    554550     * @since 2.1.0
    555551     * @access public
    556552     */
    557     function query() {
     553    public function query() {
    558554        global $wpdb;
    559555
     
    567563
    568564    /**
    569      * {@internal Missing Short Description}}
    570      *
    571      * {@internal Missing Long Description}}
     565     * Prepares variables for use in templates.
    572566     *
    573567     * @since 2.1.0
     
    577571
    578572    /**
    579      * {@internal Missing Short Description}}
    580      *
    581      * {@internal Missing Long Description}}
     573     * Handles paging for the user search query.
    582574     *
    583575     * @since 2.1.0
    584576     * @access public
    585577     */
    586     function do_paging() {
     578    public function do_paging() {
    587579        if ( $this->total_users_for_query > $this->users_per_page ) { // have to page the results
    588580            $args = array();
     
    611603
    612604    /**
    613      * {@internal Missing Short Description}}
    614      *
    615      * {@internal Missing Long Description}}
     605     * Retrieves the user search query results.
    616606     *
    617607     * @since 2.1.0
     
    620610     * @return array
    621611     */
    622     function get_results() {
     612    public function get_results() {
    623613        return (array) $this->results;
    624614    }
Note: See TracChangeset for help on using the changeset viewer.