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.

future/includes/class-gv-shortcode-gventry.php

Doc Comments -1 removed lines

@@ -18,7 +18,6 @@
 	/**
 	 * Process and output the [gventry] shortcode.
 	 *
-	 * @param array $passed_atts The attributes passed.
 	 * @param string $content The content inside the shortcode.
 	 * @param string $tag The shortcode tag.
 	 *

future/includes/class-gv-shortcode-gvfield.php

Doc Comments -1 removed lines

@@ -18,7 +18,6 @@
 	/**
 	 * Process and output the [gvfield] shortcode.
 	 *
-	 * @param array $passed_atts The attributes passed.
 	 * @param string $content The content inside the shortcode.
 	 * @param string $tag The shortcode tag.
 	 *

future/includes/class-gv-widget.php

Doc Comments +1 added lines, -1 removed lines

@@ -393,7 +393,7 @@
 	 * @internal
 	 * @since 2.0
 	 *
-	 * @return \GV\Widget|null The widget implementation from configuration or none.
+	 * @return Widget The widget implementation from configuration or none.
 	 */
 	public static function from_configuration( $configuration ) {
 		$registered_widgets = self::registered();

future/includes/class-gv-shortcode-gvlogic.php

Doc Comments +2 added lines

@@ -262,6 +262,8 @@
 	/**
 	 * Process the attributes passed to the shortcode. Make sure they're valid
 	 *
+	 * @param string $content
+	 * @param string $tag
 	 * @return array Array of attributes parsed for the shortcode
 	 */
 	private function parse_atts( $atts, $content, $tag ) {

includes/extensions/entry-notes/class-gravityview-field-notes.php

Doc Comments +2 added lines, -2 removed lines

@@ -357,7 +357,7 @@ 
 	 *
 	 * @param array $file_paths List of template paths ordered
 	 *
-	 * @return array File paths with `./` and `./partials/` paths added
+	 * @return string[] File paths with `./` and `./partials/` paths added
 	 */
 	public function add_template_path( $file_paths ) {
 
@@ -549,7 +549,7 @@ 
 	 * @param array $entry
 	 * @param array $data Note details array
 	 *
-	 * @return int|WP_Error
+	 * @return integer
 	 */
 	private function add_note( $entry, $data ) {
 		global $current_user, $wpdb;

includes/class-data.php

Doc Comments +1 added lines

@@ -143,6 +143,7 @@
 	/**
 	 * @deprecated
 	 * @see \GV\View_Collection::get()
+	 * @param integer|null $view_id
 	 */
 	function get_view( $view_id, $atts = NULL ) {
 		if ( ! $view = $this->views->get( $view_id ) ) {

includes/class-gravityview-entry-list.php

Doc Comments +2 added lines, -2 removed lines

@@ -87,13 +87,13 @@
 	 * @since 2.0 Added $template_context parameter
 	 * @since 2.7.2 Added $view_id parameter
 	 *
-	 * @param array|GV\Entry[] $entries
+	 * @param GV\Entry[] $entries
 	 * @param int $post_id
 	 * @param array $form
 	 * @param string $link_format
 	 * @param string $after_link
 	 * @param \GV\Template_Context $template_context The context
-	 * @param int|null $view_id View to link to when displaying on a page with multiple Views
+	 * @param integer $view_id View to link to when displaying on a page with multiple Views
 	 */
 	function __construct( $entries = array(), $post_id = 0, $form = array(), $link_format = '', $after_link = '', $context = '', $template_context = null, $view_id = 0 ) {
 		$this->entries = $entries;

includes/wordpress-widgets/class-gravityview-recent-entries-widget.php

Doc Comments +1 added lines, -1 removed lines

@@ -176,7 +176,7 @@
 	 * @param  array $instance Settings for the current widget
 	 * @param  string $form_id Form ID int, as string
 	 *
-	 * @return array|GV\Entry[] $entries Multidimensional array of Gravity Forms entries or GravityView Entry objects
+	 * @return GV\Entry[] $entries Multidimensional array of Gravity Forms entries or GravityView Entry objects
 	 */
 	private function get_entries( $instance, $form_id ) {