gravityview / GravityView

includes/widgets/search-widget/class-search-widget.php

Doc Comments +7 added lines, -7 removed lines

@@ -246,7 +246,7 @@ 
 	/**
 	 * Add admin script to the no-conflict scripts whitelist
 	 * @param array $allowed Scripts allowed in no-conflict mode
-	 * @return array Scripts allowed in no-conflict mode, plus the search widget script
+	 * @return string[] Scripts allowed in no-conflict mode, plus the search widget script
 	 */
 	public function register_no_conflict( $allowed ) {
 		$allowed[] = 'gravityview_searchwidget_admin';
@@ -420,6 +420,7 @@ 
 	 * Display hidden fields to add support for sites using Default permalink structure
 	 *
 	 * @since 1.8
+	 * @param GravityView_Widget_Search $object
 	 * @return array Search fields, modified if not using permalinks
 	 */
 	public function add_no_permalink_fields( $search_fields, $object, $widget_args = array() ) {
@@ -729,7 +730,6 @@ 
 	 * Dropin for the legacy flat filters when \GF_Query is available.
 	 *
 	 * @param \GF_Query $query The current query object reference
-	 * @param \GV\View $this The current view object
 	 * @param \GV\Request $request The request object
 	 */
 	public function gf_query_filter( &$query, $view, $request ) {
@@ -1428,7 +1428,7 @@ 
 	/**
 	 * Get the label for a search form field
 	 * @param  array $field      Field setting as sent by the GV configuration - has `field`, `input` (input type), and `label` keys
-	 * @param  array $form_field Form field data, as fetched by `gravityview_get_field()`
+	 * @param  GF_Field|null $form_field Form field data, as fetched by `gravityview_get_field()`
 	 * @return string             Label for the search form
 	 */
 	private static function get_field_label( $field, $form_field = array() ) {
@@ -1486,7 +1486,7 @@ 
 	 * @param array $field
 	 * @param \GV\Context $context
 	 *
-	 * @return array
+	 * @return GV\View
 	 */
 	private function get_search_filter_details( $field, $context ) {
 
@@ -1634,7 +1634,7 @@ 
 	/**
 	 * Require the datepicker script for the frontend GV script
 	 * @param array $js_dependencies Array of existing required scripts for the fe-views.js script
-	 * @return array Array required scripts, with `jquery-ui-datepicker` added
+	 * @return string[] Array required scripts, with `jquery-ui-datepicker` added
 	 */
 	public function add_datepicker_js_dependency( $js_dependencies ) {
 
@@ -1646,7 +1646,7 @@ 
 	/**
 	 * Modify the array passed to wp_localize_script()
 	 *
-	 * @param array $js_localization The data padded to the Javascript file
+	 * @param array $localizations The data padded to the Javascript file
 	 * @param array $view_data View data array with View settings
 	 *
 	 * @return array
@@ -1826,7 +1826,7 @@ 
 	 *
 	 * @param array  $get     Where to look for the operator.
 	 * @param string $key     The filter key to look for.
-	 * @param array  $allowed The allowed operators (whitelist).
+	 * @param string[]  $allowed The allowed operators (whitelist).
 	 * @param string $default The default operator.
 	 *
 	 * @return string The operator.