Changeset 25938

Timestamp:

10/26/2013 08:28:34 PM (13 years ago)

Author:

DrewAPicture

Message:

Inline documentation for hooks in wp-admin/includes/schema.php.

Props johnafish, kpdesign.
Fixes #25498.

File:

• trunk/src/wp-admin/includes/schema.php (modified) (3 diffs)

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

@@ -331 +331 @@
 
         $guessurl = wp_guess_url();
-
-        do_action('populate_options');
+        /**
+         * Fires before creating WordPress options and populating their default values.
+         *
+         * @since 2.6.0
+         */
+        do_action( 'populate_options' );
 
         if ( ini_get('safe_mode') ) {
@@ -842 +846 @@
 
 /**
- * populate network settings
+ * Populate network settings.
  *
  * @since 3.0.0
  *
- * @param int $network_id id of network to populate
+ * @param int $network_id ID of network to populate.
  * @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.
+ *                       so the error code must be checked) or failure.
  */
 function populate_network( $network_id = 1, $domain = '', $email = '', $site_name = '', $path = '/', $subdomain_install = false ) {
@@ -946 +950 @@
          * @since 3.7.0
          *
-         * @param array $sitemeta Associative of meta keys and values to be inserted.
-         * @param int $network_id Network ID being created.
+         * @param array $sitemeta   Associative array of network meta keys and values to be inserted.
+         * @param int   $network_id ID of network to populate.
          */
         $sitemeta = apply_filters( 'populate_network_meta', $sitemeta, $network_id );