Changeset 25627 for trunk/src/wp-content/themes/twentyten/functions.php

Timestamp:

09/25/2013 05:03:34 PM (11 years ago)

Author:

lancewillett

Message:

Twenty Ten: update code comments to reflect WP inline docs standards. Props DrewAPicture, closes #25256.

File:

• trunk/src/wp-content/themes/twentyten/functions.php (modified) (21 diffs)

trunk/src/wp-content/themes/twentyten/functions.php

@@ -53 +53 @@
 if ( ! function_exists( 'twentyten_setup' ) ):
 /**
- * Sets up theme defaults and registers support for various WordPress features.
+ * Set up theme defaults and registers support for various WordPress features.
  *
  * Note that this function is hooked into the after_setup_theme hook, which runs
@@ -62 +62 @@
  * functions.php file.
  *
- * @uses add_theme_support() To add support for post thumbnails, custom headers and backgrounds, and automatic feed links.
- * @uses register_nav_menus() To add support for navigation menus.
- * @uses add_editor_style() To style the visual editor.
- * @uses load_theme_textdomain() For translation/localization support.
+ * @uses add_theme_support()        To add support for post thumbnails, custom headers and backgrounds, and automatic feed links.
+ * @uses register_nav_menus()       To add support for navigation menus.
+ * @uses add_editor_style()         To style the visual editor.
+ * @uses load_theme_textdomain()    For translation/localization support.
  * @uses register_default_headers() To register the default custom header images provided with the theme.
- * @uses set_post_thumbnail_size() To set a custom post thumbnail size.
+ * @uses set_post_thumbnail_size()  To set a custom post thumbnail size.
  *
  * @since Twenty Ten 1.0
@@ -85 +85 @@
     add_theme_support( 'automatic-feed-links' );
 
-    // Make theme available for translation
-    // Translations can be filed in the /languages/ directory
+    /**
+     * Make theme available for translation.
+     * Translations can be filed in the /languages/ directory
+     */
     load_theme_textdomain( 'twentyten', get_template_directory() . '/languages' );
 
@@ -103 +105 @@
 
     $custom_header_support = array(
-        // The default image to use.
-        // The %s is a placeholder for the theme template directory URI.
+        /**
+         * The default image to use.
+         * The %s is a placeholder for the theme template directory URI.
+         */
         'default-image' => '%s/images/headers/path.jpg',
         // The height and width of our custom header.
+        /**
+         * Filter the Twenty Ten default header image width.
+         *
+         * @since Twenty Ten 1.0
+         *
+         * @param int The default header image width in pixels. Default 940.
+         */
         'width' => apply_filters( 'twentyten_header_image_width', 940 ),
+        /**
+         * Filter the Twenty Ten defaul header image height.
+         *
+         * @since Twenty Ten 1.0
+         *
+         * @param int The default header image height in pixels. Default 198.
+         */
         'height' => apply_filters( 'twentyten_header_image_height', 198 ),
         // Support flexible heights.
@@ -130 +148 @@
     }
 
-    // We'll be using post thumbnails for custom header images on posts and pages.
-    // We want them to be 940 pixels wide by 198 pixels tall.
-    // Larger images will be auto-cropped to fit, smaller ones will be ignored. See header.php.
+    /**
+     * We'll be using post thumbnails for custom header images on posts and pages.
+     * We want them to be 940 pixels wide by 198 pixels tall.
+     * Larger images will be auto-cropped to fit, smaller ones will be ignored. See header.php.
+     */
     set_post_thumbnail_size( $custom_header_support['width'], $custom_header_support['height'], true );
 
@@ -193 +213 @@
 if ( ! function_exists( 'twentyten_admin_header_style' ) ) :
 /**
- * Styles the header image displayed on the Appearance > Header admin panel.
+ * Style the header image displayed on the Appearance > Header admin panel.
  *
  * Referenced via add_custom_image_header() in twentyten_setup().
@@ -217 +237 @@
 
 /**
- * Get our wp_nav_menu() fallback, wp_page_menu(), to show a home link.
+ * Show a home link for our wp_nav_menu() fallback, wp_page_menu().
  *
  * To override this in a child theme, remove the filter and optionally add
@@ -223 +243 @@
  *
  * @since Twenty Ten 1.0
+ *
+ * @param array $args An optional array of arguments. @see wp_page_menu()
  */
 function twentyten_page_menu_args( $args ) {
@@ -232 +254 @@
 
 /**
- * Sets the post excerpt length to 40 characters.
+ * Set the post excerpt length to 40 characters.
  *
  * To override this length in a child theme, remove the filter and add your own
@@ -238 +260 @@
  *
  * @since Twenty Ten 1.0
- * @return int
+ *
+ * @param int $length The number of excerpt characters.
+ * @return int The filtered number of excerpt characters.
  */
 function twentyten_excerpt_length( $length ) {
@@ -247 +271 @@
 if ( ! function_exists( 'twentyten_continue_reading_link' ) ) :
 /**
- * Returns a "Continue Reading" link for excerpts
- *
- * @since Twenty Ten 1.0
- * @return string "Continue Reading" link
+ * Return a "Continue Reading" link for excerpts.
+ *
+ * @since Twenty Ten 1.0
+ *
+ * @return string "Continue Reading" link.
  */
 function twentyten_continue_reading_link() {
@@ -258 +283 @@
 
 /**
- * Replaces "[...]" (appended to automatically generated excerpts) with an ellipsis and twentyten_continue_reading_link().
+ * Replace "[...]" with an ellipsis and twentyten_continue_reading_link().
+ *
+ * "[...]" is appended to automatically generated excerpts.
  *
  * To override this in a child theme, remove the filter and add your own
@@ -264 +291 @@
  *
  * @since Twenty Ten 1.0
- * @return string An ellipsis
+ *
+ * @param string $more The Read More text.
+ * @return string An ellipsis.
  */
 function twentyten_auto_excerpt_more( $more ) {
@@ -272 +301 @@
 
 /**
- * Adds a pretty "Continue Reading" link to custom post excerpts.
+ * Add a pretty "Continue Reading" link to custom post excerpts.
  *
  * To override this link in a child theme, remove the filter and add your own
@@ -278 +307 @@
  *
  * @since Twenty Ten 1.0
- * @return string Excerpt with a pretty "Continue Reading" link
+ *
+ * @param string $output The "Coninue Reading" link.
+ * @return string Excerpt with a pretty "Continue Reading" link.
  */
 function twentyten_custom_excerpt_more( $output ) {
@@ -326 +357 @@
  *
  * @since Twenty Ten 1.0
+ *
+ * @param object $comment The comment object.
+ * @param array  $args    An array of arguments. @see get_comment_reply_link()
+ * @param int    $depth   The depth of the comment.
  */
 function twentyten_comment( $comment, $args, $depth ) {
@@ -377 +412 @@
  *
  * @since Twenty Ten 1.0
- * @uses register_sidebar
+ *
+ * @uses register_sidebar()
  */
 function twentyten_widgets_init() {
@@ -450 +486 @@
 
 /**
- * Removes the default styles that are packaged with the Recent Comments widget.
+ * Remove the default styles that are packaged with the Recent Comments widget.
  *
  * To override this in a child theme, remove the filter and optionally add your own
@@ -468 +504 @@
 if ( ! function_exists( 'twentyten_posted_on' ) ) :
 /**
- * Prints HTML with meta information for the current post-date/time and author.
+ * Print HTML with meta information for the current post-date/time and author.
  *
  * @since Twenty Ten 1.0
@@ -491 +527 @@
 if ( ! function_exists( 'twentyten_posted_in' ) ) :
 /**
- * Prints HTML with meta information for the current post (category, tags and permalink).
+ * Print HTML with meta information for the current post (category, tags and permalink).
  *
  * @since Twenty Ten 1.0
@@ -517 +553 @@
 
 /**
- * Retrieves the IDs for images in a gallery.
- *
- * @uses get_post_galleries() first, if available. Falls back to shortcode parsing,
- * then as last option uses a get_posts() call.
+ * Retrieve the IDs for images in a gallery.
+ *
+ * @uses get_post_galleries() First, if available. Falls back to shortcode parsing,
+ *                            then as last option uses a get_posts() call.
  *
  * @since Twenty Ten 1.6.