Changeset 25829 for trunk/src/wp-admin/options-discussion.php

Timestamp:

10/17/2013 05:59:54 AM (11 years ago)

Author:

DrewAPicture

Message:

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

Props siobhyb, ericlewis.
Fixes #25453.

File:

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

trunk/src/wp-admin/options-discussion.php

@@ -6 +6 @@
  * @subpackage Administration
  */
-
 /** WordPress Administration Bootstrap */
 require_once( dirname( __FILE__ ) . '/admin.php' );
@@ -78 +77 @@
 <input name="thread_comments" type="checkbox" id="thread_comments" value="1" <?php checked('1', get_option('thread_comments')); ?> />
 <?php
-
+/**
+ * Filter the maximum depth of threaded/nested comments.
+ *
+ * @since 2.7.0.
+ *
+ * @param int $10 The maximum depth of threaded comments. Default 10.
+ */
 $maxdeep = (int) apply_filters( 'thread_comments_depth_max', 10 );
 
@@ -220 +225 @@
     'retro' => __('Retro (Generated)')
 );
-$avatar_defaults = apply_filters('avatar_defaults', $avatar_defaults);
+/**
+ * Filter the default avatars.
+ *
+ * Avatars are stored in key/value pairs, where the key is option value,
+ * and the name is the displayed avatar name.
+ *
+ * @since 2.6.0
+ *
+ * @param array $avatar_defaults Array of default avatars.
+ */
+$avatar_defaults = apply_filters( 'avatar_defaults', $avatar_defaults );
 $default = get_option('avatar_default');
 if ( empty($default) )
@@ -236 +251 @@
     $avatar_list .= '<br />';
 }
-echo apply_filters('default_avatar_select', $avatar_list);
+/**
+ * Filter the HTML output of the default avatar list.
+ *
+ * @since 2.6.0
+ *
+ * @param string $avatar_list HTML markup of the avatar list.
+ */
+echo apply_filters( 'default_avatar_select', $avatar_list );
 ?>