PHPCS fixes

Author: ajaydsouza

includes/main.php

@@ -445,3 +445,77 @@ function wzkb_cache_get_key( $attr ) {
 
 	return $meta_key;
 }
+
+/**
+ * Get a hierarchical list of WZ Knowledge Base sections.
+ *
+ * @param  int   $term_id Term ID.
+ * @param  int   $level   Level of the loop.
+ * @param  array $args    Array or arguments.
+ * @return string HTML output with the categories.
+ */
+function wzkb_categories_list( $term_id, $level = 0, $args = array() ) {
+
+	$defaults = array(
+		'depth'          => 0,  // Depth of nesting.
+		'before_li_item' => '', // Before list item - just after <li>.
+		'after_li_item'  => '', // Before list item - just before </li>.
+	);
+
+	// Parse incomming $args into an array and merge it with $defaults.
+	$args = wp_parse_args( $args, $defaults );
+
+	// Get Knowledge Base Sections.
+	$sections = get_terms(
+		'wzkb_category',
+		array(
+			'orderby'    => 'slug',
+			'hide_empty' => wzkb_get_option( 'show_empty_sections' ) ? 0 : 1,
+			'parent'     => $term_id,
+		)
+	);
+
+	$output = '';
+
+	if ( ! empty( $sections ) && ! is_wp_error( $sections ) ) {
+
+		$output .= '<ul class="wzkb_terms_widget wzkb_term_' . $term_id . ' wzkb_ul_level_' . $level . '">';
+
+		++$level;
+
+		foreach ( $sections as $term ) {
+
+			$term_link = get_term_link( $term );
+
+			// If there was an error, continue to the next term.
+			if ( is_wp_error( $term_link ) ) {
+				continue;
+			}
+
+			$output .= '<li class="wzkb_cat_' . $term->term_id . '">' . $args['before_li_item'];
+			$output .= '<a href="' . esc_url( $term_link ) . '" title="' . esc_attr( $term->name ) . '" >' . $term->name . '</a>';
+			$output .= wzkb_categories_list( $term->term_id, $level, $args );
+			$output .= $args['after_li_item'] . '</li>';
+
+			// Exit the loop if we are at the depth.
+			if ( 0 < $args['depth'] && $level >= $args['depth'] ) {
+				break;
+			}
+		}
+		$output .= '</ul>';
+	}
+
+	return $output;
+}
+
+/**
+ * Initialise the widget.
+ *
+ * @since 1.9.0
+ */
+function register_wzkb_widgets() {
+	register_widget( 'WZKB_Breadcrumb_Widget' );
+	register_widget( 'WZKB_Sections_Widget' );
+	register_widget( 'WZKB_Articles_Widget' );
+}
+add_action( 'widgets_init', 'register_wzkb_widgets' );

includes/search.php

@@ -20,10 +20,10 @@
  *
  * @since 1.1.0
  *
- * @param  boolean $echo Default to echo and not return the form.
+ * @param  boolean $echo_output Default to echo and not return the form.
  * @return string|null   String when retrieving, null when displaying or if searchform.php exists.
  */
-function wzkb_get_search_form( $echo = true ) {
+function wzkb_get_search_form( $echo_output = true ) {
 
 	$form = '
     <form role="search" method="get" class="wzkb-search-form" action="' . esc_url( home_url( '/' ) ) . '">
@@ -49,7 +49,7 @@ function wzkb_get_search_form( $echo = true ) {
 		$result = $form;
 	}
 
-	if ( $echo ) {
+	if ( $echo_output ) {
 		echo $result; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
 	} else {
 		return $result;

includes/widgets/class-wzkb-breadcrumb-widget.php

@@ -161,16 +161,3 @@ public function widget( $args, $instance ) {
 		echo $output; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
 	} // Ending function widget.
 }
-
-
-/**
- * Initialise the widget.
- *
- * @since 1.9.0
- */
-function register_wzkb_widgets() {
-	register_widget( 'WZKB_Breadcrumb_Widget' );
-	register_widget( 'WZKB_Sections_Widget' );
-	register_widget( 'WZKB_Articles_Widget' );
-}
-add_action( 'widgets_init', 'register_wzkb_widgets' );

includes/widgets/class-wzkb-sections-widget.php

@@ -184,65 +184,3 @@ public function widget( $args, $instance ) {
 		echo $output; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
 	} // Ending function widget.
 }
-
-/**
- * Get a hierarchical list of WZ Knowledge Base sections.
- *
- * @param  int   $term_id Term ID.
- * @param  int   $level   Level of the loop.
- * @param  array $args    Array or arguments.
- * @return string HTML output with the categories.
- */
-function wzkb_categories_list( $term_id, $level = 0, $args = array() ) {
-
-	$defaults = array(
-		'depth'          => 0,  // Depth of nesting.
-		'before_li_item' => '', // Before list item - just after <li>.
-		'after_li_item'  => '', // Before list item - just before </li>.
-	);
-
-	// Parse incomming $args into an array and merge it with $defaults.
-	$args = wp_parse_args( $args, $defaults );
-
-	// Get Knowledge Base Sections.
-	$sections = get_terms(
-		'wzkb_category',
-		array(
-			'orderby'    => 'slug',
-			'hide_empty' => wzkb_get_option( 'show_empty_sections' ) ? 0 : 1,
-			'parent'     => $term_id,
-		)
-	);
-
-	$output = '';
-
-	if ( ! empty( $sections ) && ! is_wp_error( $sections ) ) {
-
-		$output .= '<ul class="wzkb_terms_widget wzkb_term_' . $term_id . ' wzkb_ul_level_' . $level . '">';
-
-		++$level;
-
-		foreach ( $sections as $term ) {
-
-			$term_link = get_term_link( $term );
-
-			// If there was an error, continue to the next term.
-			if ( is_wp_error( $term_link ) ) {
-				continue;
-			}
-
-			$output .= '<li class="wzkb_cat_' . $term->term_id . '">' . $args['before_li_item'];
-			$output .= '<a href="' . esc_url( $term_link ) . '" title="' . esc_attr( $term->name ) . '" >' . $term->name . '</a>';
-			$output .= wzkb_categories_list( $term->term_id, $level, $args );
-			$output .= $args['after_li_item'] . '</li>';
-
-			// Exit the loop if we are at the depth.
-			if ( 0 < $args['depth'] && $level >= $args['depth'] ) {
-				break;
-			}
-		}
-		$output .= '</ul>';
-	}
-
-	return $output;
-}