Docs: Add more complete documentation about expected values in the $meta parameter for wpmu_create_blog().

See #41017.


git-svn-id: https://develop.svn.wordpress.org/trunk@40930 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2017-06-25 05:47:27 +00:00
parent f6399c9950
commit f8788a84a2

View File

@ -1147,7 +1147,11 @@ function wpmu_create_user( $user_name, $password, $email ) {
* @param string $path The new site's path. * @param string $path The new site's path.
* @param string $title The new site's title. * @param string $title The new site's title.
* @param int $user_id The user ID of the new site's admin. * @param int $user_id The user ID of the new site's admin.
* @param array $meta Optional. Used to set initial site options. * @param array $meta Optional. Array of key=>value pairs used to set initial site options.
* If valid status keys are included ('public', 'archived', 'mature',
* 'spam', 'deleted', or 'lang_id') the given site status(es) will be
* updated. Otherwise, keys and values will be used to set options for
* the new site. Default empty array.
* @param int $site_id Optional. Only relevant on multi-network installs. * @param int $site_id Optional. Only relevant on multi-network installs.
* @return int|WP_Error Returns WP_Error object on failure, int $blog_id on success * @return int|WP_Error Returns WP_Error object on failure, int $blog_id on success
*/ */