Changeset 25372

Timestamp:

09/12/2013 03:43:48 AM (12 years ago)

Author:

SergeyBiryukov

Message:

Inline documentation for hooks in wp-admin/options.php.

props siobhyb.
see #25229.

File:

• trunk/src/wp-admin/options.php (modified) (2 diffs)

trunk/src/wp-admin/options.php

@@ -30 +30 @@
     $option_page = 'options';
 else
+
+    /** 
+     * Filter the capability required when using the Settings API. 
+     * 
+     * By default, the options groups for all registered settings require the manage_options capability. 
+     * This filter is required to change the capability required for a certain options page. 
+     * 
+     * @since 3.2.0
+     * 
+     * @param string $capability The capability used for the page, which is manage_options by default. 
+     */
     $capability = apply_filters( "option_page_capability_{$option_page}", $capability );
 
@@ -96 +107 @@
     $whitelist_options['general'][] = 'new_admin_email';
     $whitelist_options['general'][] = 'WPLANG';
-
+    
+    /**
+     * Toggle post-by-email functionality.
+     *
+     * @since 3.0.0
+     *
+     * @param bool True or false, based on whether post-by-email configuration is enabled or not.
+     */
     if ( apply_filters( 'enable_post_by_email_configuration', true ) )
         $whitelist_options['writing'] = array_merge($whitelist_options['writing'], $mail_options);
 }
 
+/**
+ * Filter the options white list. 
+ * 
+ * @since 2.7.0
+ *
+ * @param array White list options.
+ */
 $whitelist_options = apply_filters( 'whitelist_options', $whitelist_options );