Changeset 36250 for trunk/src/wp-admin/includes/schema.php

Timestamp:

01/10/2016 01:25:44 AM (9 years ago)

Author:

johnbillion

Message:

Docs: Various docblock corrections.

See #32246

File:

• trunk/src/wp-admin/includes/schema.php (modified) (1 diff)

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

@@ -889 +889 @@
  * @global WP_Rewrite $wp_rewrite
  *
- * @param int $network_id ID of network to populate.
+ * @param int    $network_id        ID of network to populate.
+ * @param string $domain            The domain name for the network (eg. "example.com").
+ * @param string $email             Email address for the network administrator.
+ * @param string $site_name         The name of the network.
+ * @param string $path              Optional. The path to append to the network's domain name. Default '/'.
+ * @param bool   $subdomain_install Optional. Whether the network is a subdomain install or a subdirectory install.
+ *                                  Default false, meaning the network is a subdirectory install.
  * @return bool|WP_Error True on success, or WP_Error on warning (with the install otherwise successful,
  *                       so the error code must be checked) or failure.