Make WordPress Core

Changeset 55123


Ignore:
Timestamp:
01/24/2023 12:55:14 PM (15 months ago)
Author:
audrasjb
Message:

Docs: Various improvements in ms-blogs.php function descriptions, as per docblocks standards.

See #56792.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/ms-blogs.php

    r55092 r55123  
    1313
    1414/**
    15  * Update the last_updated field for the current site.
     15 * Updates the last_updated field for the current site.
    1616 *
    1717 * @since MU (3.0.0)
     
    3232
    3333/**
    34  * Get a full blog URL, given a blog ID.
     34 * Gets a full blog URL, given a blog ID.
    3535 *
    3636 * @since MU (3.0.0)
     
    5353
    5454/**
    55  * Get a full blog URL, given a blog name.
    56  *
    57  * @since MU (3.0.0)
    58  *
    59  * @param string $blogname The (subdomain or directory) name
     55 * Gets a full blog URL, given a blog name.
     56 *
     57 * @since MU (3.0.0)
     58 *
     59 * @param string $blogname Name of the subdomain or directory.
    6060 * @return string
    6161 */
     
    114114
    115115/**
    116  * Retrieve the details for a blog from the blogs table and blog options.
     116 * Retrieves the details for a blog from the blogs table and blog options.
    117117 *
    118118 * @since MU (3.0.0)
     
    274274
    275275/**
    276  * Clear the blog details cache.
     276 * Clears the blog details cache.
    277277 *
    278278 * @since MU (3.0.0)
     
    290290
    291291/**
    292  * Update the details for a blog. Updates the blogs table for a given blog ID.
     292 * Updates the details for a blog and the blogs table for a given blog ID.
    293293 *
    294294 * @since MU (3.0.0)
     
    338338
    339339/**
    340  * Retrieve option value for a given blog id based on name of option.
     340 * Retrieves option value for a given blog id based on name of option.
    341341 *
    342342 * If the option does not exist or does not have a value, then the return value
     
    383383
    384384/**
    385  * Add a new option for a given blog ID.
     385 * Adds a new option for a given blog ID.
    386386 *
    387387 * You do not need to serialize values. If the value needs to be serialized, then
     
    447447
    448448/**
    449  * Update an option for a particular blog.
     449 * Updates an option for a particular blog.
    450450 *
    451451 * @since MU (3.0.0)
     
    476476
    477477/**
    478  * Switch the current blog.
     478 * Switches the current blog.
    479479 *
    480480 * This function is useful if you need to pull posts, or other information,
     
    589589
    590590/**
    591  * Restore the current blog, after calling switch_to_blog().
     591 * Restores the current blog, after calling switch_to_blog().
    592592 *
    593593 * @see switch_to_blog()
     
    702702
    703703/**
    704  * Determines if switch_to_blog() is in effect
     704 * Determines if switch_to_blog() is in effect.
    705705 *
    706706 * @since 3.5.0
     
    715715
    716716/**
    717  * Check if a particular blog is archived.
     717 * Checks if a particular blog is archived.
    718718 *
    719719 * @since MU (3.0.0)
     
    727727
    728728/**
    729  * Update the 'archived' status of a particular blog.
     729 * Updates the 'archived' status of a particular blog.
    730730 *
    731731 * @since MU (3.0.0)
     
    741741
    742742/**
    743  * Update a blog details field.
     743 * Updates a blog details field.
    744744 *
    745745 * @since MU (3.0.0)
     
    782782
    783783/**
    784  * Get a blog details field.
     784 * Gets a blog details field.
    785785 *
    786786 * @since MU (3.0.0)
     
    804804
    805805/**
    806  * Get a list of most recently updated blogs.
     806 * Gets a list of most recently updated blogs.
    807807 *
    808808 * @since MU (3.0.0)
     
    918918
    919919/**
    920  * Count number of sites grouped by site status.
     920 * Counts number of sites grouped by site status.
    921921 *
    922922 * @since 5.3.0
Note: See TracChangeset for help on using the changeset viewer.