From 3866a8cf58cfd7c22a808dd2b510c0d7cf699fd2 Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Mon, 5 Oct 2015 02:35:25 +0000 Subject: [PATCH] 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. Built from https://develop.svn.wordpress.org/trunk@34822 git-svn-id: http://core.svn.wordpress.org/trunk@34787 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-admin/includes/deprecated.php | 28 +++++++++------------------- wp-includes/version.php | 2 +- 2 files changed, 10 insertions(+), 20 deletions(-) diff --git a/wp-admin/includes/deprecated.php b/wp-admin/includes/deprecated.php index 1ddcef978f..b984d6df92 100644 --- a/wp-admin/includes/deprecated.php +++ b/wp-admin/includes/deprecated.php @@ -507,14 +507,12 @@ class WP_User_Search { } /** - * {@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; @@ -547,14 +545,12 @@ class WP_User_Search { } /** - * {@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; $this->results = $wpdb->get_col("SELECT DISTINCT($wpdb->users.ID)" . $this->query_from . $this->query_where . $this->query_orderby . $this->query_limit); @@ -566,9 +562,7 @@ class WP_User_Search { } /** - * {@internal Missing Short Description}} - * - * {@internal Missing Long Description}} + * Prepares variables for use in templates. * * @since 2.1.0 * @access public @@ -576,14 +570,12 @@ class WP_User_Search { function prepare_vars_for_template_usage() {} /** - * {@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(); if ( ! empty($this->search_term) ) @@ -610,16 +602,14 @@ class WP_User_Search { } /** - * {@internal Missing Short Description}} - * - * {@internal Missing Long Description}} + * Retrieves the user search query results. * * @since 2.1.0 * @access public * * @return array */ - function get_results() { + public function get_results() { return (array) $this->results; } diff --git a/wp-includes/version.php b/wp-includes/version.php index 557e4533e2..49ea66b2a2 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -4,7 +4,7 @@ * * @global string $wp_version */ -$wp_version = '4.4-alpha-34821'; +$wp_version = '4.4-alpha-34822'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.