Completed
Push — update/user-tos-package ( 4fee76...3b2612 )
by
unknown
23:24 queued 16:11
created
class.jetpack.php 1 patch
Doc Comments   +39 added lines, -17 removed lines patch added patch discarded remove patch
@@ -781,7 +781,7 @@  discard block
 block discarded – undo
781 781
 	 * This is ported over from the manage module, which has been deprecated and baked in here.
782 782
 	 *
783 783
 	 * @param $domains
784
-	 * @return array
784
+	 * @return string[]
785 785
 	 */
786 786
 	function allow_wpcom_domain( $domains ) {
787 787
 		if ( empty( $domains ) ) {
@@ -1247,7 +1247,7 @@  discard block
 block discarded – undo
1247 1247
 	/**
1248 1248
 	 * Does the network allow admins to add new users.
1249 1249
 	 *
1250
-	 * @return boolian
1250
+	 * @return boolean
1251 1251
 	 */
1252 1252
 	static function network_add_new_users( $option = null ) {
1253 1253
 		return (bool) get_site_option( 'add_new_users' );
@@ -1357,7 +1357,7 @@  discard block
 block discarded – undo
1357 1357
 	 *
1358 1358
 	 * @param  bool $option
1359 1359
 	 *
1360
-	 * @return boolean
1360
+	 * @return string
1361 1361
 	 */
1362 1362
 	public function is_main_network_option( $option ) {
1363 1363
 		// return '1' or ''
@@ -1368,7 +1368,7 @@  discard block
 block discarded – undo
1368 1368
 	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1369 1369
 	 *
1370 1370
 	 * @param  string $option
1371
-	 * @return boolean
1371
+	 * @return string
1372 1372
 	 */
1373 1373
 	public function is_multisite( $option ) {
1374 1374
 		return (string) (bool) is_multisite();
@@ -1431,7 +1431,7 @@  discard block
 block discarded – undo
1431 1431
 	/**
1432 1432
 	 * Returns true if the site has file write access false otherwise.
1433 1433
 	 *
1434
-	 * @return string ( '1' | '0' )
1434
+	 * @return integer ( '1' | '0' )
1435 1435
 	 **/
1436 1436
 	public static function file_system_write_access() {
1437 1437
 		if ( ! function_exists( 'get_filesystem_method' ) ) {
@@ -2177,6 +2177,7 @@  discard block
 block discarded – undo
2177 2177
 	 * @param int    $user_id
2178 2178
 	 * @param string $token
2179 2179
 	 * return bool
2180
+	 * @param boolean $is_master_user
2180 2181
 	 */
2181 2182
 	public static function update_user_token( $user_id, $token, $is_master_user ) {
2182 2183
 		// not designed for concurrent updates
@@ -2630,7 +2631,7 @@  discard block
 block discarded – undo
2630 2631
 	 *
2631 2632
 	 * @param string $tag Tag as it appears in each module heading.
2632 2633
 	 *
2633
-	 * @return mixed
2634
+	 * @return string
2634 2635
 	 */
2635 2636
 	public static function translate_module_tag( $tag ) {
2636 2637
 		return jetpack_get_module_i18n_tag( $tag );
@@ -2802,8 +2803,8 @@  discard block
 block discarded – undo
2802 2803
 	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2803 2804
 	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2804 2805
 	 *
2805
-	 * @param $string
2806
-	 * @return mixed
2806
+	 * @param string $string
2807
+	 * @return string|null
2807 2808
 	 */
2808 2809
 	public static function alias_directories( $string ) {
2809 2810
 		// ABSPATH has a trailing slash.
@@ -2814,6 +2815,10 @@  discard block
 block discarded – undo
2814 2815
 		return $string;
2815 2816
 	}
2816 2817
 
2818
+	/**
2819
+	 * @param boolean $redirect
2820
+	 * @param boolean $send_state_messages
2821
+	 */
2817 2822
 	public static function activate_default_modules(
2818 2823
 		$min_version = false,
2819 2824
 		$max_version = false,
@@ -3096,6 +3101,9 @@  discard block
 block discarded – undo
3096 3101
 		return self::update_active_modules( $new );
3097 3102
 	}
3098 3103
 
3104
+	/**
3105
+	 * @param string $module
3106
+	 */
3099 3107
 	public static function enable_module_configurable( $module ) {
3100 3108
 		$module = self::get_module_slug( $module );
3101 3109
 		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
@@ -3124,6 +3132,10 @@  discard block
 block discarded – undo
3124 3132
 	}
3125 3133
 
3126 3134
 	/* Installation */
3135
+
3136
+	/**
3137
+	 * @param string $message
3138
+	 */
3127 3139
 	public static function bail_on_activation( $message, $deactivate = true ) {
3128 3140
 		?>
3129 3141
 <!doctype html>
@@ -3887,7 +3899,7 @@  discard block
 block discarded – undo
3887 3899
 	 * Add help to the Jetpack page
3888 3900
 	 *
3889 3901
 	 * @since Jetpack (1.2.3)
3890
-	 * @return false if not the Jetpack page
3902
+	 * @return false|null if not the Jetpack page
3891 3903
 	 */
3892 3904
 	function admin_help() {
3893 3905
 		$current_screen = get_current_screen();
@@ -4684,6 +4696,9 @@  discard block
 block discarded – undo
4684 4696
 		return $raw ? esc_url_raw( $url ) : esc_url( $url );
4685 4697
 	}
4686 4698
 
4699
+	/**
4700
+	 * @return string
4701
+	 */
4687 4702
 	public static function build_authorize_url( $redirect = false, $iframe = false ) {
4688 4703
 		if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) {
4689 4704
 			$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
@@ -4832,6 +4847,9 @@  discard block
 block discarded – undo
4832 4847
 		return $url;
4833 4848
 	}
4834 4849
 
4850
+	/**
4851
+	 * @return string
4852
+	 */
4835 4853
 	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4836 4854
 		$actionurl = str_replace( '&amp;', '&', $actionurl );
4837 4855
 		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
@@ -5128,7 +5146,8 @@  discard block
 block discarded – undo
5128 5146
 	 * Note these tokens are unique per call, NOT static per site for connecting.
5129 5147
 	 *
5130 5148
 	 * @since 2.6
5131
-	 * @return array
5149
+	 * @param string $action
5150
+	 * @return boolean
5132 5151
 	 */
5133 5152
 	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
5134 5153
 		if ( false === $user_id ) {
@@ -5420,7 +5439,6 @@  discard block
 block discarded – undo
5420 5439
 	/**
5421 5440
 	 * Report authentication status to the WP REST API.
5422 5441
 	 *
5423
-	 * @param  WP_Error|mixed $result Error from another authentication handler, null if we should handle it, or another value if not
5424 5442
 	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5425 5443
 	 */
5426 5444
 	public function wp_rest_authentication_errors( $value ) {
@@ -5522,6 +5540,7 @@  discard block
 block discarded – undo
5522 5540
 	 * @param string $key
5523 5541
 	 * @param string $value
5524 5542
 	 * @param bool   $restate private
5543
+	 * @return string
5525 5544
 	 */
5526 5545
 	public static function state( $key = null, $value = null, $restate = false ) {
5527 5546
 		static $state = array();
@@ -5580,6 +5599,9 @@  discard block
 block discarded – undo
5580 5599
 		self::state( null, null, true );
5581 5600
 	}
5582 5601
 
5602
+	/**
5603
+	 * @param string $file
5604
+	 */
5583 5605
 	public static function check_privacy( $file ) {
5584 5606
 		static $is_site_publicly_accessible = null;
5585 5607
 
@@ -5660,6 +5682,9 @@  discard block
 block discarded – undo
5660 5682
 		}
5661 5683
 	}
5662 5684
 
5685
+	/**
5686
+	 * @param string $url
5687
+	 */
5663 5688
 	public static function staticize_subdomain( $url ) {
5664 5689
 
5665 5690
 		// Extract hostname from URL
@@ -6225,9 +6250,7 @@  discard block
 block discarded – undo
6225 6250
 	 *
6226 6251
 	 * Attached to `style_loader_src` filter.
6227 6252
 	 *
6228
-	 * @param string $tag The tag that would link to the external asset.
6229 6253
 	 * @param string $handle The registered handle of the script in question.
6230
-	 * @param string $href The url of the asset in question.
6231 6254
 	 */
6232 6255
 	public static function set_suffix_on_min( $src, $handle ) {
6233 6256
 		if ( false === strpos( $src, '.min.css' ) ) {
@@ -6415,8 +6438,8 @@  discard block
 block discarded – undo
6415 6438
 	 *  - Absolute URLs             `http://domain.com/feh.png`
6416 6439
 	 *  - Domain root relative URLs `/feh.png`
6417 6440
 	 *
6418
-	 * @param $css string: The raw CSS -- should be read in directly from the file.
6419
-	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6441
+	 * @param string $css string: The raw CSS -- should be read in directly from the file.
6442
+	 * @param string $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6420 6443
 	 *
6421 6444
 	 * @return mixed|string
6422 6445
 	 */
@@ -6677,7 +6700,7 @@  discard block
 block discarded – undo
6677 6700
 	/**
6678 6701
 	 * Stores and prints out domains to prefetch for page speed optimization.
6679 6702
 	 *
6680
-	 * @param mixed $new_urls
6703
+	 * @param string[] $new_urls
6681 6704
 	 */
6682 6705
 	public static function dns_prefetch( $new_urls = null ) {
6683 6706
 		static $prefetch_urls = array();
@@ -6734,7 +6757,6 @@  discard block
 block discarded – undo
6734 6757
 	}
6735 6758
 
6736 6759
 	/**
6737
-	 * @param mixed $result Value for the user's option
6738 6760
 	 * @return mixed
6739 6761
 	 */
6740 6762
 	function get_user_option_meta_box_order_dashboard( $sorted ) {
Please login to merge, or discard this patch.