Changeset 1641 for sites/trunk/global.wordpress.org/public_html/wp-content/themes/rosetta/functions.php

Timestamp:

05/30/2015 10:26:47 PM (10 years ago)

Author:

ocean90

Message:

Rosetta Theme: Enhancements

• Move sidebar code to its own files.
• Show blog section on front page only when show_on_front is posts.
• Add some inline docs.

props ramiy.
fixes #1057, #1051.
see #1049.

File:

• sites/trunk/global.wordpress.org/public_html/wp-content/themes/rosetta/functions.php (modified) (7 diffs)

sites/trunk/global.wordpress.org/public_html/wp-content/themes/rosetta/functions.php

@@ -33 +33 @@
 add_action( 'after_setup_theme', 'rosetta_after_setup_theme' );
 
+/**
+ * Prints a hint, which explains that that support questions belong
+ * to the forums, on top of the comment form.
+ */
 function rosetta_comment_form_support_hint() {
     printf(
@@ -42 +46 @@
 add_action( 'comment_form_top', 'rosetta_comment_form_support_hint' );
 
+/**
+ * Show a home link for our wp_nav_menu() fallback, wp_page_menu().
+ *
+ * @param array $args An optional array of arguments.
+ * @return array The filtered array of arguments.
+ */
 function rosetta_wp_page_menu_args( $args ) {
     $args['show_home'] = true;
@@ -48 +58 @@
 add_filter( 'wp_page_menu_args', 'rosetta_wp_page_menu_args' );
 
+/**
+ * The nav menu supports only top level menu items.
+ */
 function rosetta_admin_footer_nav_menus() {
     echo '<script> wpNavMenu.options.globalMaxDepth = 0; </script>';
@@ -53 +66 @@
 add_action( 'admin_footer-nav-menus.php', 'rosetta_admin_footer_nav_menus' );
 
+/**
+ * Extend the default WordPress body classes.
+ *
+ * @param array $classes A list of existing body class values.
+ * @return array The filtered body class list.
+ */
 function rosetta_body_class( $classes ) {
     $classes[] = 'wporg-responsive';
@@ -60 +79 @@
 add_filter( 'body_class', 'rosetta_body_class' );
 
+/**
+ * Checks if locale provides a custom stylesheet.
+ *
+ * @return boolean True if file exists, false if not.
+ */
 function is_locale_css() {
     global $rosetta;
@@ -65 +89 @@
 }
 
+/**
+ * Returns URL to locale's custom stylesheet.
+ *
+ * @return string URL to custom stylesheet.
+ */
 function get_locale_css_url() {
     global $rosetta;
@@ -70 +99 @@
 }
 
-// Makes final space a non-breaking one, to prevent orphaned word.
+/**
+ * Makes final space a non-breaking one, to prevent orphaned word.
+ *
+ * @param string $string
+ * @return string
+ */
 function rosetta_orphan_control( $string ) {
     return substr_replace( $string, '&nbsp;', strrpos( $string, ' ' ), 1 );