Docs: Improve documentation for `get_last_updated()`.

Props atachibana.
Fixes #47861.

git-svn-id: https://develop.svn.wordpress.org/trunk@45780 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2019-08-11 16:17:16 +00:00
parent 26592196e0
commit 64eeedee46
1 changed files with 17 additions and 16 deletions

View File

@ -35,7 +35,7 @@ function wpmu_update_blogs_date() {
* *
* @since MU (3.0.0) * @since MU (3.0.0)
* *
* @param int $blog_id Blog ID * @param int $blog_id Blog ID.
* @return string Full URL of the blog if found. Empty string if not. * @return string Full URL of the blog if found. Empty string if not.
*/ */
function get_blogaddress_by_id( $blog_id ) { function get_blogaddress_by_id( $blog_id ) {
@ -286,7 +286,7 @@ function refresh_blog_details( $blog_id = 0 ) {
* *
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
* *
* @param int $blog_id Blog ID * @param int $blog_id Blog ID.
* @param array $details Array of details keyed by blogs table field names. * @param array $details Array of details keyed by blogs table field names.
* @return bool True if update succeeds, false otherwise. * @return bool True if update succeeds, false otherwise.
*/ */
@ -660,8 +660,8 @@ function ms_is_switched() {
* *
* @since MU (3.0.0) * @since MU (3.0.0)
* *
* @param int $id The blog id * @param int $id Blog ID.
* @return string Whether the blog is archived or not * @return string Whether the blog is archived or not.
*/ */
function is_archived( $id ) { function is_archived( $id ) {
return get_blog_status( $id, 'archived' ); return get_blog_status( $id, 'archived' );
@ -672,8 +672,8 @@ function is_archived( $id ) {
* *
* @since MU (3.0.0) * @since MU (3.0.0)
* *
* @param int $id The blog id * @param int $id Blog ID.
* @param string $archived The new status * @param string $archived The new status.
* @return string $archived * @return string $archived
*/ */
function update_archived( $id, $archived ) { function update_archived( $id, $archived ) {
@ -689,10 +689,10 @@ function update_archived( $id, $archived ) {
* *
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
* *
* @param int $blog_id BLog ID * @param int $blog_id Blog ID.
* @param string $pref A field name * @param string $pref Field name.
* @param string $value Value for $pref * @param string $value Field value.
* @param null $deprecated * @param null $deprecated Not used.
* @return string|false $value * @return string|false $value
*/ */
function update_blog_status( $blog_id, $pref, $value, $deprecated = null ) { function update_blog_status( $blog_id, $pref, $value, $deprecated = null ) {
@ -727,8 +727,8 @@ function update_blog_status( $blog_id, $pref, $value, $deprecated = null ) {
* *
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
* *
* @param int $id The blog id * @param int $id Blog ID.
* @param string $pref A field name * @param string $pref Field name.
* @return bool|string|null $value * @return bool|string|null $value
*/ */
function get_blog_status( $id, $pref ) { function get_blog_status( $id, $pref ) {
@ -749,10 +749,11 @@ function get_blog_status( $id, $pref ) {
* *
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
* *
* @param mixed $deprecated Not used * @param mixed $deprecated Not used.
* @param int $start The offset * @param int $start Optional. Number of blogs to offset the query. Used to build LIMIT clause.
* @param int $quantity The maximum number of blogs to retrieve. Default is 40. * Can be used for pagination. Default 0.
* @return array The list of blogs * @param int $quantity Optional. The maximum number of blogs to retrieve. Default 40.
* @return array The list of blogs.
*/ */
function get_last_updated( $deprecated = '', $start = 0, $quantity = 40 ) { function get_last_updated( $deprecated = '', $start = 0, $quantity = 40 ) {
global $wpdb; global $wpdb;