@@ -869,7 +869,7 @@ |
||
869 | 869 | /** |
870 | 870 | * Returns an attachment field friendly name, based on a field name that is passed in |
871 | 871 | * |
872 | - * @param $field |
|
872 | + * @param string $field |
|
873 | 873 | * |
874 | 874 | * @return string |
875 | 875 | */ |
@@ -85,7 +85,7 @@ discard block |
||
85 | 85 | /** |
86 | 86 | * private function to load a gallery by the slug. |
87 | 87 | * Will be used when loading gallery shortcodes |
88 | - * @param $slug |
|
88 | + * @param string $slug |
|
89 | 89 | */ |
90 | 90 | private function load_by_slug( $slug ) { |
91 | 91 | if ( ! empty( $slug ) ) { |
@@ -105,7 +105,7 @@ discard block |
||
105 | 105 | |
106 | 106 | /** |
107 | 107 | * Static function to build a dynamic gallery that does not exist in the database |
108 | - * @param $template |
|
108 | + * @param string $template |
|
109 | 109 | * @param $attachment_ids |
110 | 110 | * |
111 | 111 | * @return FooGallery |
@@ -294,7 +294,7 @@ discard block |
||
294 | 294 | /** |
295 | 295 | * @deprecated 1.3.0 This is now moved into the datasource implementation |
296 | 296 | * |
297 | - * @return int|mixed|string |
|
297 | + * @return integer |
|
298 | 298 | */ |
299 | 299 | public function find_featured_attachment_id() { |
300 | 300 | _deprecated_function( __FUNCTION__, '1.3.0' ); |
@@ -278,6 +278,11 @@ |
||
278 | 278 | return $options; |
279 | 279 | } |
280 | 280 | |
281 | + /** |
|
282 | + * @param string $setting_id |
|
283 | + * @param string $argument_name |
|
284 | + * @param string $default_value |
|
285 | + */ |
|
281 | 286 | private function get_foogallery_argument( $gallery, $setting_id, $argument_name, $default_value ) { |
282 | 287 | global $current_foogallery_arguments; |
283 | 288 |
@@ -79,8 +79,6 @@ discard block |
||
79 | 79 | * |
80 | 80 | * @param FooGalleryAttachment $foogallery_attachment |
81 | 81 | * @param array $args |
82 | - * @param bool $output_image |
|
83 | - * @param bool $output_closing_tag |
|
84 | 82 | * |
85 | 83 | * @return string |
86 | 84 | */ |
@@ -227,6 +225,9 @@ discard block |
||
227 | 225 | return apply_filters( 'foogallery_attachment_html_caption', $html, $foogallery_attachment, $args ); |
228 | 226 | } |
229 | 227 | |
228 | +/** |
|
229 | + * @param FooGalleryAttachment $foogallery_attachment |
|
230 | + */ |
|
230 | 231 | function foogallery_attachment_html_item_opening($foogallery_attachment, $args = array() ) { |
231 | 232 | |
232 | 233 | $classes[] = 'fg-item'; |
@@ -18,6 +18,9 @@ |
||
18 | 18 | */ |
19 | 19 | class FS_Customizer_Support_Section extends WP_Customize_Section { |
20 | 20 | |
21 | + /** |
|
22 | + * @param string $id |
|
23 | + */ |
|
21 | 24 | function __construct( $manager, $id, $args = array() ) { |
22 | 25 | $manager->register_section_type( 'FS_Customizer_Support_Section' ); |
23 | 26 |
@@ -38,16 +38,25 @@ discard block |
||
38 | 38 | include_once fs_get_template_path( $path ); |
39 | 39 | } |
40 | 40 | |
41 | + /** |
|
42 | + * @param string $path |
|
43 | + */ |
|
41 | 44 | function fs_require_template( $path, &$params = null ) { |
42 | 45 | $VARS = &$params; |
43 | 46 | require fs_get_template_path( $path ); |
44 | 47 | } |
45 | 48 | |
49 | + /** |
|
50 | + * @param string $path |
|
51 | + */ |
|
46 | 52 | function fs_require_once_template( $path, &$params = null ) { |
47 | 53 | $VARS = &$params; |
48 | 54 | require_once fs_get_template_path( $path ); |
49 | 55 | } |
50 | 56 | |
57 | + /** |
|
58 | + * @param string $path |
|
59 | + */ |
|
51 | 60 | function fs_get_template( $path, &$params = null ) { |
52 | 61 | ob_start(); |
53 | 62 | |
@@ -91,10 +100,18 @@ discard block |
||
91 | 100 | return $asset_url; |
92 | 101 | } |
93 | 102 | |
103 | + /** |
|
104 | + * @param string $handle |
|
105 | + * @param string $path |
|
106 | + */ |
|
94 | 107 | function fs_enqueue_local_style( $handle, $path, $deps = array(), $ver = false, $media = 'all' ) { |
95 | 108 | wp_enqueue_style( $handle, fs_asset_url( WP_FS__DIR_CSS . '/' . trim( $path, '/' ) ), $deps, $ver, $media ); |
96 | 109 | } |
97 | 110 | |
111 | + /** |
|
112 | + * @param string $handle |
|
113 | + * @param string $path |
|
114 | + */ |
|
98 | 115 | function fs_enqueue_local_script( $handle, $path, $deps = array(), $ver = false, $in_footer = 'all' ) { |
99 | 116 | wp_enqueue_script( $handle, fs_asset_url( WP_FS__DIR_JS . '/' . trim( $path, '/' ) ), $deps, $ver, $in_footer ); |
100 | 117 | } |
@@ -134,6 +151,9 @@ discard block |
||
134 | 151 | return $value; |
135 | 152 | } |
136 | 153 | |
154 | + /** |
|
155 | + * @param string $key |
|
156 | + */ |
|
137 | 157 | function fs_request_has( $key ) { |
138 | 158 | return isset( $_REQUEST[ $key ] ); |
139 | 159 | } |
@@ -178,6 +198,9 @@ discard block |
||
178 | 198 | return false; |
179 | 199 | } |
180 | 200 | |
201 | + /** |
|
202 | + * @param string $action |
|
203 | + */ |
|
181 | 204 | function fs_request_is_action( $action, $action_key = 'action' ) { |
182 | 205 | return ( strtolower( $action ) === fs_get_action( $action_key ) ); |
183 | 206 | } |
@@ -216,6 +239,9 @@ discard block |
||
216 | 239 | return true; |
217 | 240 | } |
218 | 241 | |
242 | + /** |
|
243 | + * @param string $page_slug |
|
244 | + */ |
|
219 | 245 | function fs_is_plugin_page( $page_slug ) { |
220 | 246 | return ( is_admin() && $page_slug === fs_request_get( 'page' ) ); |
221 | 247 | } |
@@ -357,7 +383,7 @@ discard block |
||
357 | 383 | * @since ~1.1.3 |
358 | 384 | * |
359 | 385 | * @param string $actionurl URL to add nonce action. |
360 | - * @param int|string $action Optional. Nonce action name. Default -1. |
|
386 | + * @param integer $action Optional. Nonce action name. Default -1. |
|
361 | 387 | * @param string $name Optional. Nonce name. Default '_wpnonce'. |
362 | 388 | * |
363 | 389 | * @return string Escaped URL with nonce action added. |
@@ -50,7 +50,7 @@ discard block |
||
50 | 50 | * @param bool $exit If true, exit after redirect (Since 1.2.1.5). |
51 | 51 | * @param int $status Status code to use. |
52 | 52 | * |
53 | - * @return bool False if $location is not set |
|
53 | + * @return null|boolean False if $location is not set |
|
54 | 54 | */ |
55 | 55 | function fs_redirect( $location, $exit = true, $status = 302 ) { |
56 | 56 | global $is_IIS; |
@@ -478,7 +478,7 @@ discard block |
||
478 | 478 | * @param string $tag The name of the filter hook. |
479 | 479 | * @param mixed $value The value on which the filters hooked to `$tag` are applied on. |
480 | 480 | * |
481 | - * @return mixed The filtered value after all hooked functions are applied to it. |
|
481 | + * @return string|boolean The filtered value after all hooked functions are applied to it. |
|
482 | 482 | * |
483 | 483 | * @uses apply_filters() |
484 | 484 | */ |
@@ -121,6 +121,10 @@ discard block |
||
121 | 121 | return self::$_instances[ $key ]; |
122 | 122 | } |
123 | 123 | |
124 | + /** |
|
125 | + * @param string $module_type |
|
126 | + * @param string $module_unique_affix |
|
127 | + */ |
|
124 | 128 | protected function __construct( $module_id, $module_type, $module_unique_affix ) { |
125 | 129 | $this->_logger = FS_Logger::get_logger( WP_FS__SLUG . '_' . $module_id . '_admin_menu', WP_FS__DEBUG_SDK, WP_FS__ECHO_DEBUG_SDK ); |
126 | 130 | |
@@ -133,10 +137,16 @@ discard block |
||
133 | 137 | |
134 | 138 | #region Helpers |
135 | 139 | |
140 | + /** |
|
141 | + * @param string $key |
|
142 | + */ |
|
136 | 143 | private function get_option( &$options, $key, $default = false ) { |
137 | 144 | return ! empty( $options[ $key ] ) ? $options[ $key ] : $default; |
138 | 145 | } |
139 | 146 | |
147 | + /** |
|
148 | + * @param string $key |
|
149 | + */ |
|
140 | 150 | private function get_bool_option( &$options, $key, $default = false ) { |
141 | 151 | return isset( $options[ $key ] ) && is_bool( $options[ $key ] ) ? $options[ $key ] : $default; |
142 | 152 | } |
@@ -81,6 +81,10 @@ discard block |
||
81 | 81 | return self::$_instances[ $key ]; |
82 | 82 | } |
83 | 83 | |
84 | + /** |
|
85 | + * @param string $id |
|
86 | + * @param string $secondary_id |
|
87 | + */ |
|
84 | 88 | protected function __construct( $id, $secondary_id ) { |
85 | 89 | $this->_logger = FS_Logger::get_logger( WP_FS__SLUG . '_' . $secondary_id . '_' . $id, WP_FS__DEBUG_SDK, WP_FS__ECHO_DEBUG_SDK ); |
86 | 90 | |
@@ -205,7 +209,7 @@ discard block |
||
205 | 209 | * @since 1.0.7 |
206 | 210 | * |
207 | 211 | * @param string $key |
208 | - * @param mixed $default |
|
212 | + * @param false|null $default |
|
209 | 213 | * |
210 | 214 | * @return bool|\FS_Plugin |
211 | 215 | */ |