Automattic /
jetpack
| Conditions | 25 |
| Paths | 770 |
| Total Lines | 128 |
| Lines | 7 |
| Ratio | 5.47 % |
| Changes | 0 | ||
Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.
For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.
Commonly applied refactorings include:
If many parameters/temporary variables are present:
| 1 | <?php |
||
| 32 | function soundcloud_shortcode( $atts, $content = null ) { |
||
| 33 | global $wp_embed; |
||
| 34 | |||
| 35 | // Custom shortcode options. |
||
| 36 | $shortcode_options = array_merge( |
||
| 37 | array( 'url' => trim( $content ) ), |
||
| 38 | is_array( $atts ) ? $atts : array() |
||
| 39 | ); |
||
| 40 | |||
| 41 | // The "url" option is required. |
||
| 42 | View Code Duplication | if ( empty( $shortcode_options['url'] ) ) { |
|
| 43 | if ( current_user_can( 'edit_posts' ) ) { |
||
| 44 | return esc_html__( 'Please specify a Soundcloud URL.', 'jetpack' ); |
||
| 45 | } else { |
||
| 46 | return '<!-- Missing Soundcloud URL -->'; |
||
| 47 | } |
||
| 48 | } |
||
| 49 | |||
| 50 | // Turn shortcode option "param" (param=value¶m2=value) into array of params. |
||
| 51 | $shortcode_params = array(); |
||
| 52 | if ( isset( $shortcode_options['params'] ) ) { |
||
| 53 | parse_str( html_entity_decode( $shortcode_options['params'] ), $shortcode_params ); |
||
| 54 | $shortcode_options = array_merge( |
||
| 55 | $shortcode_options, |
||
| 56 | $shortcode_params |
||
| 57 | ); |
||
| 58 | unset( $shortcode_options['params'] ); |
||
| 59 | } |
||
| 60 | |||
| 61 | $options = shortcode_atts( |
||
| 62 | // This list used to include an 'iframe' option. We don't include it anymore as we don't support the Flash player anymore. |
||
| 63 | array( |
||
| 64 | 'url' => '', |
||
| 65 | 'width' => soundcloud_get_option( 'player_width' ), |
||
| 66 | 'height' => soundcloud_url_has_tracklist( $shortcode_options['url'] ) ? soundcloud_get_option( 'player_height_multi' ) : soundcloud_get_option( 'player_height' ), |
||
| 67 | 'auto_play' => soundcloud_get_option( 'auto_play' ), |
||
| 68 | 'hide_related' => false, |
||
| 69 | 'visual' => false, |
||
| 70 | 'show_comments' => soundcloud_get_option( 'show_comments' ), |
||
| 71 | 'color' => soundcloud_get_option( 'color' ), |
||
| 72 | 'show_user' => false, |
||
| 73 | 'show_reposts' => false, |
||
| 74 | ), |
||
| 75 | $shortcode_options, |
||
| 76 | 'soundcloud' |
||
| 77 | ); |
||
| 78 | |||
| 79 | // "width" needs to be an integer. |
||
| 80 | if ( ! empty( $options['width'] ) && ! preg_match( '/^\d+$/', $options['width'] ) ) { |
||
| 81 | // set to 0 so oEmbed will use the default 100% and WordPress themes will leave it alone. |
||
| 82 | $options['width'] = 0; |
||
| 83 | } |
||
| 84 | // Set default width if not defined. |
||
| 85 | $width = ! empty( $options['width'] ) ? absint( $options['width'] ) : '100%'; |
||
| 86 | |||
| 87 | // Set default height if not defined. |
||
| 88 | if ( |
||
| 89 | empty( $options['height'] ) |
||
| 90 | || ( |
||
| 91 | // "height" needs to be an integer. |
||
| 92 | ! empty( $options['height'] ) |
||
| 93 | && ! preg_match( '/^\d+$/', $options['height'] ) |
||
| 94 | ) |
||
| 95 | ) { |
||
| 96 | if ( |
||
| 97 | soundcloud_url_has_tracklist( $options['url'] ) |
||
| 98 | || 'true' === $options['visual'] |
||
| 99 | ) { |
||
| 100 | $height = 450; |
||
| 101 | } else { |
||
| 102 | $height = 166; |
||
| 103 | } |
||
| 104 | } else { |
||
| 105 | $height = absint( $options['height'] ); |
||
| 106 | } |
||
| 107 | |||
| 108 | // Set visual to false when displaying the smallest player. |
||
| 109 | if ( '20' === $options['height'] ) { |
||
| 110 | $options['visual'] = false; |
||
| 111 | } |
||
| 112 | |||
| 113 | if ( |
||
| 114 | class_exists( 'Jetpack_AMP_Support' ) |
||
| 115 | && Jetpack_AMP_Support::is_amp_request() |
||
| 116 | && ! empty( $options['url'] ) |
||
| 117 | && 'api.soundcloud.com' !== wp_parse_url( $options['url'], PHP_URL_HOST ) |
||
| 118 | ) { |
||
| 119 | // Defer to oEmbed if an oEmbeddable URL is provided. |
||
| 120 | return $wp_embed->shortcode( $options, $options['url'] ); |
||
| 121 | } |
||
| 122 | |||
| 123 | // Build our list of Soundcloud parameters. |
||
| 124 | $query_args = array( |
||
| 125 | 'url' => rawurlencode( $options['url'] ), |
||
| 126 | ); |
||
| 127 | |||
| 128 | // Add our options, if they are set to true or false. |
||
| 129 | foreach ( $options as $name => $value ) { |
||
| 130 | if ( 'true' === $value ) { |
||
| 131 | $query_args[ $name ] = 'true'; |
||
| 132 | } |
||
| 133 | |||
| 134 | if ( 'false' === $value || false === $value ) { |
||
| 135 | $query_args[ $name ] = 'false'; |
||
| 136 | } |
||
| 137 | } |
||
| 138 | |||
| 139 | // Add the color parameter if it was specified and is a valid color. |
||
| 140 | if ( ! empty( $options['color'] ) ) { |
||
| 141 | $color = sanitize_hex_color_no_hash( $options['color'] ); |
||
| 142 | if ( ! empty( $color ) ) { |
||
| 143 | $query_args['color'] = $color; |
||
| 144 | } |
||
| 145 | } |
||
| 146 | |||
| 147 | // Build final embed URL. |
||
| 148 | $url = add_query_arg( |
||
| 149 | $query_args, |
||
| 150 | 'https://w.soundcloud.com/player/' |
||
| 151 | ); |
||
| 152 | |||
| 153 | return sprintf( |
||
| 154 | '<iframe width="%1$s" height="%2$d" scrolling="no" frameborder="no" src="%3$s"></iframe>', |
||
| 155 | esc_attr( $width ), |
||
| 156 | esc_attr( $height ), |
||
| 157 | $url |
||
| 158 | ); |
||
| 159 | } |
||
| 160 | add_shortcode( 'soundcloud', 'soundcloud_shortcode' ); |
||
| 253 |
This check looks for
@paramannotations where the type inferred by our type inference engine differs from the declared type.It makes a suggestion as to what type it considers more descriptive.
Most often this is a case of a parameter that can be null in addition to its declared types.