Changeset 34822 for trunk/src/wp-admin/includes/deprecated.php

Timestamp:

10/05/2015 02:34:47 AM (9 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:

• trunk/src/wp-admin/includes/deprecated.php (modified) (6 diffs)

trunk/src/wp-admin/includes/deprecated.php

@@ -508 +508 @@
 
     /**
-     * {@internal Missing Short Description}}
-     *
-     * {@internal Missing Long Description}}
+     * Prepares the user search query (legacy).
      *
      * @since 2.1.0
      * @access public
      */
-    function prepare_query() {
+    public function prepare_query() {
         global $wpdb;
         $this->first_user = ($this->page - 1) * $this->users_per_page;
@@ -548 +546 @@
 
     /**
-     * {@internal Missing Short Description}}
-     *
-     * {@internal Missing Long Description}}
+     * Executes the user search query.
      *
      * @since 2.1.0
      * @access public
      */
-    function query() {
+    public function query() {
         global $wpdb;
 
@@ -567 +563 @@
 
     /**
-     * {@internal Missing Short Description}}
-     *
-     * {@internal Missing Long Description}}
+     * Prepares variables for use in templates.
      *
      * @since 2.1.0
@@ -577 +571 @@
 
     /**
-     * {@internal Missing Short Description}}
-     *
-     * {@internal Missing Long Description}}
+     * Handles paging for the user search query.
      *
      * @since 2.1.0
      * @access public
      */
-    function do_paging() {
+    public function do_paging() {
         if ( $this->total_users_for_query > $this->users_per_page ) { // have to page the results
             $args = array();
@@ -611 +603 @@
 
     /**
-     * {@internal Missing Short Description}}
-     *
-     * {@internal Missing Long Description}}
+     * Retrieves the user search query results.
      *
      * @since 2.1.0
@@ -620 +610 @@
      * @return array
      */
-    function get_results() {
+    public function get_results() {
         return (array) $this->results;
     }