Make WordPress Core


Ignore:
Timestamp:
02/21/2023 04:37:03 PM (21 months ago)
Author:
SergeyBiryukov
Message:

Docs: Document default values for optional parameters in various DocBlocks.

Props paulkevan, costdev, audrasjb, SergeyBiryukov.
See #56792.

File:
1 edited

Legend:

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

    r55161 r55398  
    331331 *
    332332 * @param string $domain Website domain.
    333  * @param string $path   Optional. Not required for subdomain installations.
     333 * @param string $path   Optional. Not required for subdomain installations. Default '/'.
    334334 * @return int 0 if no blog found, otherwise the ID of the matching blog.
    335335 */
     
    607607 * @param string         $blog_title The blog title provided by the user.
    608608 * @param WP_User|string $user       Optional. The user object to check against the new site name.
     609 *                                   Default empty string.
    609610 * @return array {
    610611 *     Array of domain, path, blog name, blog title, user and error messages.
     
    13551356 *                           the new site. Default empty array.
    13561357 * @param int    $network_id Optional. Network ID. Only relevant on multi-network installations.
     1358 *                           Default 1.
    13571359 * @return int|WP_Error Returns WP_Error object on failure, the new site ID on success.
    13581360 */
     
    15401542 * @param string $domain     The domain to be checked.
    15411543 * @param string $path       The path to be checked.
    1542  * @param int    $network_id Optional. Network ID. Relevant only on multi-network installations.
     1544 * @param int    $network_id Optional. Network ID. Only relevant on multi-network installations.
     1545 *                           Default 1.
    15431546 * @return int|null The site ID if the site name exists, null otherwise.
    15441547 */
     
    15671570     * @param string   $domain     Domain to be checked.
    15681571     * @param string   $path       Path to be checked.
    1569      * @param int      $network_id Network ID. Relevant only on multi-network installations.
     1572     * @param int      $network_id Network ID. Only relevant on multi-network installations.
    15701573     */
    15711574    return apply_filters( 'domain_exists', $result, $domain, $path, $network_id );
Note: See TracChangeset for help on using the changeset viewer.