Automattic / jetpack

sync/class.jetpack-sync-functions.php

Doc Comments +7 added lines

@@ -148,6 +148,7 @@ 
 	 * Helper function that is used when getting home or siteurl values. Decides
 	 * whether to get the raw or filtered value.
 	 *
+	 * @param string $url_type
 	 * @return string
 	 */
 	public static function get_raw_or_filtered_url( $url_type ) {
@@ -197,6 +198,9 @@ 
 		return self::get_protocol_normalized_url( 'main_network_site_url', network_site_url() );
 	}
 
+	/**
+	 * @param string $callable
+	 */
 	public static function get_protocol_normalized_url( $callable, $new_value ) {
 		$option_key = self::HTTPS_CHECK_OPTION_PREFIX . $callable;
 
@@ -236,6 +240,9 @@ 
 		return $value;
 	}
 
+	/**
+	 * @param string $url_function
+	 */
 	public static function normalize_www_in_url( $option, $url_function ) {
 		$url        = wp_parse_url( call_user_func( $url_function ) );
 		$option_url = wp_parse_url( get_option( $option ) );

modules/sitemaps/sitemap-buffer-image.php

Doc Comments +3 added lines

@@ -16,6 +16,9 @@
  */
 class Jetpack_Sitemap_Buffer_Image extends Jetpack_Sitemap_Buffer {
 
+	/**
+	 * @param integer $byte_limit
+	 */
 	public function __construct( $item_limit, $byte_limit, $time = '1970-01-01 00:00:00' ) {
 		parent::__construct( $item_limit, $byte_limit, $time );
 

modules/sitemaps/sitemap-buffer-master.php

Doc Comments +3 added lines

@@ -16,6 +16,9 @@
  */
 class Jetpack_Sitemap_Buffer_Master extends Jetpack_Sitemap_Buffer {
 
+	/**
+	 * @param integer $byte_limit
+	 */
 	public function __construct( $item_limit, $byte_limit, $time = '1970-01-01 00:00:00' ) {
 		parent::__construct( $item_limit, $byte_limit, $time );
 

modules/sitemaps/sitemap-buffer-news.php

Doc Comments +3 added lines

@@ -16,6 +16,9 @@
  */
 class Jetpack_Sitemap_Buffer_News extends Jetpack_Sitemap_Buffer {
 
+	/**
+	 * @param integer $byte_limit
+	 */
 	public function __construct( $item_limit, $byte_limit, $time = '1970-01-01 00:00:00' ) {
 		parent::__construct( $item_limit, $byte_limit, $time );
 

modules/sitemaps/sitemap-buffer-page.php

Doc Comments +3 added lines

@@ -16,6 +16,9 @@
  */
 class Jetpack_Sitemap_Buffer_Page extends Jetpack_Sitemap_Buffer {
 
+	/**
+	 * @param integer $byte_limit
+	 */
 	public function __construct( $item_limit, $byte_limit, $time = '1970-01-01 00:00:00' ) {
 		parent::__construct( $item_limit, $byte_limit, $time );
 

modules/sitemaps/sitemap-buffer-video.php

Doc Comments +3 added lines

@@ -16,6 +16,9 @@
  */
 class Jetpack_Sitemap_Buffer_Video extends Jetpack_Sitemap_Buffer {
 
+	/**
+	 * @param integer $byte_limit
+	 */
 	public function __construct( $item_limit, $byte_limit, $time = '1970-01-01 00:00:00' ) {
 		parent::__construct( $item_limit, $byte_limit, $time );
 

modules/sitemaps/sitemap-buffer.php

Doc Comments +3 added lines, -3 removed lines

@@ -136,7 +136,7 @@ 
 	 *
 	 * @param string $item The item to be added.
 	 *
-	 * @return bool True if the append succeeded, False if not.
+	 * @return boolean|null True if the append succeeded, False if not.
 	 */
 	public function try_to_add_item( $item ) {
 		_deprecated_function(
@@ -155,7 +155,7 @@ 
 	 *
 	 * @since 5.3.0
 	 *
-	 * @param array $array The item to be added.
+	 * @param string $array The item to be added.
 	 *
 	 * @return bool True if the append succeeded, False if not.
 	 */
@@ -280,7 +280,7 @@ 
 	 * @param DOMElement $parent (optional) an element to which new children should be added.
 	 * @param DOMDocument $root (optional) the parent document.
 	 *
-	 * @return string|DOMDocument The rendered XML string or an object if root element is specified.
+	 * @return null|DOMNode The rendered XML string or an object if root element is specified.
 	 */
 	protected function array_to_xml_string( $array, $parent = null, $root = null ) {
 		$return_string = false;

class.jetpack.php

Doc Comments +44 added lines, -17 removed lines

@@ -941,7 +941,7 @@ 
 	}
 	/**
 	 * Does the network allow admins to add new users.
-	 * @return boolian
+	 * @return boolean
 	 */
 	static function network_add_new_users( $option = null ) {
 		return (bool) get_site_option( 'add_new_users' );
@@ -1046,7 +1046,7 @@ 
 	 * database which could be set to anything as opposed to what this function returns.
 	 * @param  bool  $option
 	 *
-	 * @return boolean
+	 * @return string
 	 */
 	public function is_main_network_option( $option ) {
 		// return '1' or ''
@@ -1057,7 +1057,7 @@ 
 	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
 	 *
 	 * @param  string  $option
-	 * @return boolean
+	 * @return string
 	 */
 	public function is_multisite( $option ) {
 		return (string) (bool) is_multisite();
@@ -1119,7 +1119,7 @@ 
 
 	/**
 	 * Returns true if the site has file write access false otherwise.
-	 * @return string ( '1' | '0' )
+	 * @return integer ( '1' | '0' )
 	 **/
 	public static function file_system_write_access() {
 		if ( ! function_exists( 'get_filesystem_method' ) ) {
@@ -1358,6 +1358,7 @@ 
 	 * @access public
 	 * @static
 	 *
+	 * @param string $feature
 	 * @return bool True if plan supports feature, false if not
 	 */
 	public static function active_plan_supports( $feature ) {
@@ -1894,6 +1895,7 @@ 
 	 * @param int $user_id
 	 * @param string $token
 	 * return bool
+	 * @param boolean $is_master_user
 	 */
 	public static function update_user_token( $user_id, $token, $is_master_user ) {
 		// not designed for concurrent updates
@@ -2288,6 +2290,7 @@ 
 
 	/**
 	 * Like core's get_file_data implementation, but caches the result.
+	 * @param string $file
 	 */
 	public static function get_file_data( $file, $headers ) {
 		//Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
@@ -2333,7 +2336,7 @@ 
 	 *
 	 * @param string $tag Tag as it appears in each module heading.
 	 *
-	 * @return mixed
+	 * @return string
 	 */
 	public static function translate_module_tag( $tag ) {
 		return jetpack_get_module_i18n_tag( $tag );
@@ -2346,7 +2349,7 @@ 
 	 *
 	 * @param array $modules
 	 *
-	 * @return string|void
+	 * @return string
 	 */
 	public static function get_translated_modules( $modules ) {
 		foreach ( $modules as $index => $module ) {
@@ -2436,8 +2439,8 @@ 
 	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
 	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
 	 *
-	 * @param $string
-	 * @return mixed
+	 * @param string $string
+	 * @return string|null
 	 */
 	public static function alias_directories( $string ) {
 		// ABSPATH has a trailing slash.
@@ -2692,6 +2695,9 @@ 
 		return self::update_active_modules( $new );
 	}
 
+	/**
+	 * @param string $module
+	 */
 	public static function enable_module_configurable( $module ) {
 		$module = Jetpack::get_module_slug( $module );
 		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
@@ -2702,21 +2708,33 @@ 
 		return Jetpack::admin_url( array( 'page' => 'jetpack', 'configure' => $module ) );
 	}
 
+	/**
+	 * @param string $module
+	 */
 	public static function module_configuration_load( $module, $method ) {
 		$module = Jetpack::get_module_slug( $module );
 		add_action( 'jetpack_module_configuration_load_' . $module, $method );
 	}
 
+	/**
+	 * @param string $module
+	 */
 	public static function module_configuration_head( $module, $method ) {
 		$module = Jetpack::get_module_slug( $module );
 		add_action( 'jetpack_module_configuration_head_' . $module, $method );
 	}
 
+	/**
+	 * @param string $module
+	 */
 	public static function module_configuration_screen( $module, $method ) {
 		$module = Jetpack::get_module_slug( $module );
 		add_action( 'jetpack_module_configuration_screen_' . $module, $method );
 	}
 
+	/**
+	 * @param string $module
+	 */
 	public static function module_configuration_activation_screen( $module, $method ) {
 		$module = Jetpack::get_module_slug( $module );
 		add_action( 'display_activate_module_setting_' . $module, $method );
@@ -2724,6 +2742,9 @@ 
 
 /* Installation */
 
+	/**
+	 * @param string $message
+	 */
 	public static function bail_on_activation( $message, $deactivate = true ) {
 ?>
 <!doctype html>
@@ -3423,7 +3444,7 @@ 
 	 * Add help to the Jetpack page
 	 *
 	 * @since Jetpack (1.2.3)
-	 * @return false if not the Jetpack page
+	 * @return false|null if not the Jetpack page
 	 */
 	function admin_help() {
 		$current_screen = get_current_screen();
@@ -4438,6 +4459,7 @@ 
 	/**
 	 * Returns the requested Jetpack API URL
 	 *
+	 * @param string $relative_url
 	 * @return string
 	 */
 	public static function api_url( $relative_url ) {
@@ -4582,7 +4604,8 @@ 
 	 * Note these tokens are unique per call, NOT static per site for connecting.
 	 *
 	 * @since 2.6
-	 * @return array
+	 * @param string $action
+	 * @return boolean
 	 */
 	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
 		if ( ! $user_id ) {
@@ -5061,7 +5084,6 @@ 
 	/**
 	 * Report authentication status to the WP REST API.
 	 *
-	 * @param  WP_Error|mixed $result Error from another authentication handler, null if we should handle it, or another value if not
 	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
 	 */
 	public function wp_rest_authentication_errors( $value ) {
@@ -5071,6 +5093,10 @@ 
 		return $this->rest_authentication_status;
 	}
 
+	/**
+	 * @param integer $timestamp
+	 * @param string $nonce
+	 */
 	function add_nonce( $timestamp, $nonce ) {
 		global $wpdb;
 		static $nonces_used_this_request = array();
@@ -5216,6 +5242,7 @@ 
 	 * @param string $key
 	 * @param string $value
 	 * @param bool $restate private
+	 * @return string
 	 */
 	public static function state( $key = null, $value = null, $restate = false ) {
 		static $state = array();
@@ -5272,6 +5299,9 @@ 
 		Jetpack::state( null, null, true );
 	}
 
+	/**
+	 * @param string $file
+	 */
 	public static function check_privacy( $file ) {
 		static $is_site_publicly_accessible = null;
 
@@ -5867,9 +5897,7 @@ 
 	 *
 	 * Attached to `style_loader_src` filter.
 	 *
-	 * @param string $tag The tag that would link to the external asset.
 	 * @param string $handle The registered handle of the script in question.
-	 * @param string $href The url of the asset in question.
 	 */
 	public static function set_suffix_on_min( $src, $handle ) {
 		if ( false === strpos( $src, '.min.css' ) ) {
@@ -6038,8 +6066,8 @@ 
 	 *  - Absolute URLs             `http://domain.com/feh.png`
 	 *  - Domain root relative URLs `/feh.png`
 	 *
-	 * @param $css string: The raw CSS -- should be read in directly from the file.
-	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
+	 * @param string $css string: The raw CSS -- should be read in directly from the file.
+	 * @param string $css_file_url : The URL that the file can be accessed at, for calculating paths from.
 	 *
 	 * @return mixed|string
 	 */
@@ -6330,7 +6358,7 @@ 
 	 *
 	 * @param string $option_name
 	 *
-	 * @return bool
+	 * @return false|null
 	 */
 	public static function jumpstart_has_updated_module_option( $option_name = '' ) {
 		// Bail if Jump Start has already been dismissed
@@ -6421,7 +6449,6 @@ 
 	}
 
 	/**
-	 * @param mixed $result Value for the user's option
 	 * @return mixed
 	 */
 	function get_user_option_meta_box_order_dashboard( $sorted ) {

3rd-party/qtranslate-x.php

Doc Comments +1 added lines, -1 removed lines

@@ -8,7 +8,7 @@
  * @param string $url_orig Original URL.
  * @param array $url_info  Pieces of original URL.
  *
- * @return bool
+ * @return false|string
  */
 function jetpack_no_qtranslate_rest_url_redirect( $url_lang, $url_orig, $url_info ) {
 	if ( false !== strpos( $url_info['wp-path'], 'wp-json/jetpack' ) ) {