Changeset 25967

Timestamp:

10/28/2013 03:21:59 PM (13 years ago)

Author:

DrewAPicture

Message:

Inline documentation for hooks in wp-admin/network/settings.php.

Props ninio for the initial patches.
Fixes #25727.

File:

• trunk/src/wp-admin/network/settings.php (modified) (4 diffs)

trunk/src/wp-admin/network/settings.php

@@ -40 +40 @@
 
 if ( $_POST ) {
-        do_action( 'wpmuadminedit' , '' );
+        /** This action is documented in wp-admin/network/edit.php */
+        do_action( 'wpmuadminedit' );
 
         check_admin_referer( 'siteoptions' );
@@ -65 +66 @@
         }
 
-        // Update more options here
+        /**
+         * Fires after the network options are updated.
+         * 
+         * @since MU
+         */
         do_action( 'update_wpmu_options' );
 
@@ -286 +291 @@
                         <?php
                         $menu_perms = get_site_option( 'menu_items' );
+                        /**
+                         * Filter available network-wide administration menu options.
+                         *
+                         * Options returned to this filter are output as individual checkboxes that, when selected,
+                         * enable site administrator access to the specified administration menu in certain contexts.
+                         *
+                         * Adding options for specific menus here hinges on the appropriate checks and capabilities
+                         * being in place in the site dashboard on the other side. For instance, when the single
+                         * default option, 'plugins' is enabled, site administrators are granted access to the Plugins
+                         * screen in their individual sites' dashboards.
+                         *
+                         * @since MU
+                         * 
+                         * @param array $admin_menus The menu items available.
+                         */
                         $menu_items = apply_filters( 'mu_menu_items', array( 'plugins' => __( 'Plugins' ) ) );
                         foreach ( (array) $menu_items as $key => $val ) {
@@ -295 +315 @@
                 </table>
 
-                <?php do_action( 'wpmu_options' ); // Add more options here ?>
-
+                <?php 
+                /**
+                 * Fires at the end of the Network Settings form, before the submit button.
+                 *
+                 * @since MU
+                 */
+                do_action( 'wpmu_options' ); ?>
                 <?php submit_button(); ?>
         </form>