Completed
Push — update/woo-analytics-enqueue ( 2a82d5...d184ac )
by Jeremy
07:21
created
class.jetpack.php 1 patch
Doc Comments   +38 added lines, -16 removed lines patch added patch discarded remove patch
@@ -735,6 +735,9 @@  discard block
 block discarded – undo
735 735
 		add_action( 'script_loader_tag', array( $this, 'script_add_async' ), 10, 3 );
736 736
 	}
737 737
 
738
+	/**
739
+	 * @param boolean $is_active
740
+	 */
738 741
 	function setup_xmlrpc_handlers( $request_params, $is_active, $is_signed, Jetpack_XMLRPC_Server $xmlrpc_server = null ) {
739 742
 		if ( ! isset( $request_params['for'] ) || 'jetpack' != $request_params['for'] ) {
740 743
 			return false;
@@ -815,7 +818,7 @@  discard block
 block discarded – undo
815 818
 	 * This is ported over from the manage module, which has been deprecated and baked in here.
816 819
 	 *
817 820
 	 * @param $domains
818
-	 * @return array
821
+	 * @return string[]
819 822
 	 */
820 823
 	function allow_wpcom_domain( $domains ) {
821 824
 		if ( empty( $domains ) ) {
@@ -1311,7 +1314,7 @@  discard block
 block discarded – undo
1311 1314
 	}
1312 1315
 	/**
1313 1316
 	 * Does the network allow admins to add new users.
1314
-	 * @return boolian
1317
+	 * @return boolean
1315 1318
 	 */
1316 1319
 	static function network_add_new_users( $option = null ) {
1317 1320
 		return (bool) get_site_option( 'add_new_users' );
@@ -1416,7 +1419,7 @@  discard block
 block discarded – undo
1416 1419
 	 * database which could be set to anything as opposed to what this function returns.
1417 1420
 	 * @param  bool  $option
1418 1421
 	 *
1419
-	 * @return boolean
1422
+	 * @return string
1420 1423
 	 */
1421 1424
 	public function is_main_network_option( $option ) {
1422 1425
 		// return '1' or ''
@@ -1427,7 +1430,7 @@  discard block
 block discarded – undo
1427 1430
 	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1428 1431
 	 *
1429 1432
 	 * @param  string  $option
1430
-	 * @return boolean
1433
+	 * @return string
1431 1434
 	 */
1432 1435
 	public function is_multisite( $option ) {
1433 1436
 		return (string) (bool) is_multisite();
@@ -1489,7 +1492,7 @@  discard block
 block discarded – undo
1489 1492
 
1490 1493
 	/**
1491 1494
 	 * Returns true if the site has file write access false otherwise.
1492
-	 * @return string ( '1' | '0' )
1495
+	 * @return integer ( '1' | '0' )
1493 1496
 	 **/
1494 1497
 	public static function file_system_write_access() {
1495 1498
 		if ( ! function_exists( 'get_filesystem_method' ) ) {
@@ -2217,6 +2220,7 @@  discard block
 block discarded – undo
2217 2220
 	 * @param int $user_id
2218 2221
 	 * @param string $token
2219 2222
 	 * return bool
2223
+	 * @param boolean $is_master_user
2220 2224
 	 */
2221 2225
 	public static function update_user_token( $user_id, $token, $is_master_user ) {
2222 2226
 		// not designed for concurrent updates
@@ -2661,7 +2665,7 @@  discard block
 block discarded – undo
2661 2665
 	 *
2662 2666
 	 * @param string $tag Tag as it appears in each module heading.
2663 2667
 	 *
2664
-	 * @return mixed
2668
+	 * @return string
2665 2669
 	 */
2666 2670
 	public static function translate_module_tag( $tag ) {
2667 2671
 		return jetpack_get_module_i18n_tag( $tag );
@@ -2833,8 +2837,8 @@  discard block
 block discarded – undo
2833 2837
 	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2834 2838
 	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2835 2839
 	 *
2836
-	 * @param $string
2837
-	 * @return mixed
2840
+	 * @param string $string
2841
+	 * @return string|null
2838 2842
 	 */
2839 2843
 	public static function alias_directories( $string ) {
2840 2844
 		// ABSPATH has a trailing slash.
@@ -3094,6 +3098,9 @@  discard block
 block discarded – undo
3094 3098
 		return self::update_active_modules( $new );
3095 3099
 	}
3096 3100
 
3101
+	/**
3102
+	 * @param string $module
3103
+	 */
3097 3104
 	public static function enable_module_configurable( $module ) {
3098 3105
 		$module = Jetpack::get_module_slug( $module );
3099 3106
 		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
@@ -3122,6 +3129,9 @@  discard block
 block discarded – undo
3122 3129
 	}
3123 3130
 
3124 3131
 /* Installation */
3132
+	/**
3133
+	 * @param string $message
3134
+	 */
3125 3135
 	public static function bail_on_activation( $message, $deactivate = true ) {
3126 3136
 ?>
3127 3137
 <!doctype html>
@@ -3856,7 +3866,7 @@  discard block
 block discarded – undo
3856 3866
 	 * Add help to the Jetpack page
3857 3867
 	 *
3858 3868
 	 * @since Jetpack (1.2.3)
3859
-	 * @return false if not the Jetpack page
3869
+	 * @return false|null if not the Jetpack page
3860 3870
 	 */
3861 3871
 	function admin_help() {
3862 3872
 		$current_screen = get_current_screen();
@@ -4718,6 +4728,9 @@  discard block
 block discarded – undo
4718 4728
 		return $url;
4719 4729
 	}
4720 4730
 
4731
+	/**
4732
+	 * @return string
4733
+	 */
4721 4734
 	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4722 4735
 		$actionurl = str_replace( '&amp;', '&', $actionurl );
4723 4736
 		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
@@ -4777,6 +4790,7 @@  discard block
 block discarded – undo
4777 4790
 	/**
4778 4791
 	 * Returns the requested Jetpack API URL
4779 4792
 	 *
4793
+	 * @param string $relative_url
4780 4794
 	 * @return string
4781 4795
 	 */
4782 4796
 	public static function api_url( $relative_url ) {
@@ -4972,6 +4986,7 @@  discard block
 block discarded – undo
4972 4986
 	 * Note these tokens are unique per call, NOT static per site for connecting.
4973 4987
 	 *
4974 4988
 	 * @since 2.6
4989
+	 * @param string $action
4975 4990
 	 * @return array
4976 4991
 	 */
4977 4992
 	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
@@ -5527,7 +5542,6 @@  discard block
 block discarded – undo
5527 5542
 	/**
5528 5543
 	 * Report authentication status to the WP REST API.
5529 5544
 	 *
5530
-	 * @param  WP_Error|mixed $result Error from another authentication handler, null if we should handle it, or another value if not
5531 5545
 	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5532 5546
 	 */
5533 5547
 	public function wp_rest_authentication_errors( $value ) {
@@ -5537,6 +5551,10 @@  discard block
 block discarded – undo
5537 5551
 		return $this->rest_authentication_status;
5538 5552
 	}
5539 5553
 
5554
+	/**
5555
+	 * @param integer $timestamp
5556
+	 * @param string $nonce
5557
+	 */
5540 5558
 	function add_nonce( $timestamp, $nonce ) {
5541 5559
 		global $wpdb;
5542 5560
 		static $nonces_used_this_request = array();
@@ -5682,6 +5700,7 @@  discard block
 block discarded – undo
5682 5700
 	 * @param string $key
5683 5701
 	 * @param string $value
5684 5702
 	 * @param bool $restate private
5703
+	 * @return string
5685 5704
 	 */
5686 5705
 	public static function state( $key = null, $value = null, $restate = false ) {
5687 5706
 		static $state = array();
@@ -5738,6 +5757,9 @@  discard block
 block discarded – undo
5738 5757
 		Jetpack::state( null, null, true );
5739 5758
 	}
5740 5759
 
5760
+	/**
5761
+	 * @param string $file
5762
+	 */
5741 5763
 	public static function check_privacy( $file ) {
5742 5764
 		static $is_site_publicly_accessible = null;
5743 5765
 
@@ -5820,6 +5842,9 @@  discard block
 block discarded – undo
5820 5842
 		}
5821 5843
 	}
5822 5844
 
5845
+	/**
5846
+	 * @param string $url
5847
+	 */
5823 5848
 	public static function staticize_subdomain( $url ) {
5824 5849
 
5825 5850
 		// Extract hostname from URL
@@ -6375,9 +6400,7 @@  discard block
 block discarded – undo
6375 6400
 	 *
6376 6401
 	 * Attached to `style_loader_src` filter.
6377 6402
 	 *
6378
-	 * @param string $tag The tag that would link to the external asset.
6379 6403
 	 * @param string $handle The registered handle of the script in question.
6380
-	 * @param string $href The url of the asset in question.
6381 6404
 	 */
6382 6405
 	public static function set_suffix_on_min( $src, $handle ) {
6383 6406
 		if ( false === strpos( $src, '.min.css' ) ) {
@@ -6564,8 +6587,8 @@  discard block
 block discarded – undo
6564 6587
 	 *  - Absolute URLs             `http://domain.com/feh.png`
6565 6588
 	 *  - Domain root relative URLs `/feh.png`
6566 6589
 	 *
6567
-	 * @param $css string: The raw CSS -- should be read in directly from the file.
6568
-	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6590
+	 * @param string $css string: The raw CSS -- should be read in directly from the file.
6591
+	 * @param string $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6569 6592
 	 *
6570 6593
 	 * @return mixed|string
6571 6594
 	 */
@@ -6826,7 +6849,7 @@  discard block
 block discarded – undo
6826 6849
 	/**
6827 6850
 	 * Stores and prints out domains to prefetch for page speed optimization.
6828 6851
 	 *
6829
-	 * @param mixed $new_urls
6852
+	 * @param string[] $new_urls
6830 6853
 	 */
6831 6854
 	public static function dns_prefetch( $new_urls = null ) {
6832 6855
 		static $prefetch_urls = array();
@@ -6882,7 +6905,6 @@  discard block
 block discarded – undo
6882 6905
 	}
6883 6906
 
6884 6907
 	/**
6885
-	 * @param mixed $result Value for the user's option
6886 6908
 	 * @return mixed
6887 6909
 	 */
6888 6910
 	function get_user_option_meta_box_order_dashboard( $sorted ) {
Please login to merge, or discard this patch.