[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

/wp-includes/ -> media.php (source)

   1  <?php
   2  /**
   3   * WordPress API for media display.
   4   *
   5   * @package WordPress
   6   * @subpackage Media
   7   */
   8  
   9  /**
  10   * Retrieve additional image sizes.
  11   *
  12   * @since 4.7.0
  13   *
  14   * @global array $_wp_additional_image_sizes
  15   *
  16   * @return array Additional images size data.
  17   */
  18  function wp_get_additional_image_sizes() {
  19      global $_wp_additional_image_sizes;
  20  
  21      if ( ! $_wp_additional_image_sizes ) {
  22          $_wp_additional_image_sizes = array();
  23      }
  24  
  25      return $_wp_additional_image_sizes;
  26  }
  27  
  28  /**
  29   * Scale down the default size of an image.
  30   *
  31   * This is so that the image is a better fit for the editor and theme.
  32   *
  33   * The `$size` parameter accepts either an array or a string. The supported string
  34   * values are 'thumb' or 'thumbnail' for the given thumbnail size or defaults at
  35   * 128 width and 96 height in pixels. Also supported for the string value is
  36   * 'medium', 'medium_large' and 'full'. The 'full' isn't actually supported, but any value other
  37   * than the supported will result in the content_width size or 500 if that is
  38   * not set.
  39   *
  40   * Finally, there is a filter named {@see 'editor_max_image_size'}, that will be
  41   * called on the calculated array for width and height, respectively.
  42   *
  43   * @since 2.5.0
  44   *
  45   * @global int   $content_width
  46   *
  47   * @param int          $width   Width of the image in pixels.
  48   * @param int          $height  Height of the image in pixels.
  49   * @param string|int[] $size    Optional. Image size. Accepts any registered image size name, or an array
  50   *                              of width and height values in pixels (in that order). Default 'medium'.
  51   * @param string       $context Optional. Could be 'display' (like in a theme) or 'edit'
  52   *                              (like inserting into an editor). Default null.
  53   * @return int[] {
  54   *     An array of width and height values.
  55   *
  56   *     @type int $0 The maximum width in pixels.
  57   *     @type int $1 The maximum height in pixels.
  58   * }
  59   */
  60  function image_constrain_size_for_editor( $width, $height, $size = 'medium', $context = null ) {
  61      global $content_width;
  62  
  63      $_wp_additional_image_sizes = wp_get_additional_image_sizes();
  64  
  65      if ( ! $context ) {
  66          $context = is_admin() ? 'edit' : 'display';
  67      }
  68  
  69      if ( is_array( $size ) ) {
  70          $max_width  = $size[0];
  71          $max_height = $size[1];
  72      } elseif ( 'thumb' === $size || 'thumbnail' === $size ) {
  73          $max_width  = (int) get_option( 'thumbnail_size_w' );
  74          $max_height = (int) get_option( 'thumbnail_size_h' );
  75          // Last chance thumbnail size defaults.
  76          if ( ! $max_width && ! $max_height ) {
  77              $max_width  = 128;
  78              $max_height = 96;
  79          }
  80      } elseif ( 'medium' === $size ) {
  81          $max_width  = (int) get_option( 'medium_size_w' );
  82          $max_height = (int) get_option( 'medium_size_h' );
  83  
  84      } elseif ( 'medium_large' === $size ) {
  85          $max_width  = (int) get_option( 'medium_large_size_w' );
  86          $max_height = (int) get_option( 'medium_large_size_h' );
  87  
  88          if ( (int) $content_width > 0 ) {
  89              $max_width = min( (int) $content_width, $max_width );
  90          }
  91      } elseif ( 'large' === $size ) {
  92          /*
  93           * We're inserting a large size image into the editor. If it's a really
  94           * big image we'll scale it down to fit reasonably within the editor
  95           * itself, and within the theme's content width if it's known. The user
  96           * can resize it in the editor if they wish.
  97           */
  98          $max_width  = (int) get_option( 'large_size_w' );
  99          $max_height = (int) get_option( 'large_size_h' );
 100  
 101          if ( (int) $content_width > 0 ) {
 102              $max_width = min( (int) $content_width, $max_width );
 103          }
 104      } elseif ( ! empty( $_wp_additional_image_sizes ) && in_array( $size, array_keys( $_wp_additional_image_sizes ), true ) ) {
 105          $max_width  = (int) $_wp_additional_image_sizes[ $size ]['width'];
 106          $max_height = (int) $_wp_additional_image_sizes[ $size ]['height'];
 107          // Only in admin. Assume that theme authors know what they're doing.
 108          if ( (int) $content_width > 0 && 'edit' === $context ) {
 109              $max_width = min( (int) $content_width, $max_width );
 110          }
 111      } else { // $size === 'full' has no constraint.
 112          $max_width  = $width;
 113          $max_height = $height;
 114      }
 115  
 116      /**
 117       * Filters the maximum image size dimensions for the editor.
 118       *
 119       * @since 2.5.0
 120       *
 121       * @param int[]        $max_image_size {
 122       *     An array of width and height values.
 123       *
 124       *     @type int $0 The maximum width in pixels.
 125       *     @type int $1 The maximum height in pixels.
 126       * }
 127       * @param string|int[] $size     Requested image size. Can be any registered image size name, or
 128       *                               an array of width and height values in pixels (in that order).
 129       * @param string       $context  The context the image is being resized for.
 130       *                               Possible values are 'display' (like in a theme)
 131       *                               or 'edit' (like inserting into an editor).
 132       */
 133      list( $max_width, $max_height ) = apply_filters( 'editor_max_image_size', array( $max_width, $max_height ), $size, $context );
 134  
 135      return wp_constrain_dimensions( $width, $height, $max_width, $max_height );
 136  }
 137  
 138  /**
 139   * Retrieve width and height attributes using given width and height values.
 140   *
 141   * Both attributes are required in the sense that both parameters must have a
 142   * value, but are optional in that if you set them to false or null, then they
 143   * will not be added to the returned string.
 144   *
 145   * You can set the value using a string, but it will only take numeric values.
 146   * If you wish to put 'px' after the numbers, then it will be stripped out of
 147   * the return.
 148   *
 149   * @since 2.5.0
 150   *
 151   * @param int|string $width  Image width in pixels.
 152   * @param int|string $height Image height in pixels.
 153   * @return string HTML attributes for width and, or height.
 154   */
 155  function image_hwstring( $width, $height ) {
 156      $out = '';
 157      if ( $width ) {
 158          $out .= 'width="' . (int) $width . '" ';
 159      }
 160      if ( $height ) {
 161          $out .= 'height="' . (int) $height . '" ';
 162      }
 163      return $out;
 164  }
 165  
 166  /**
 167   * Scale an image to fit a particular size (such as 'thumb' or 'medium').
 168   *
 169   * The URL might be the original image, or it might be a resized version. This
 170   * function won't create a new resized copy, it will just return an already
 171   * resized one if it exists.
 172   *
 173   * A plugin may use the {@see 'image_downsize'} filter to hook into and offer image
 174   * resizing services for images. The hook must return an array with the same
 175   * elements that are normally returned from the function.
 176   *
 177   * @since 2.5.0
 178   *
 179   * @param int          $id   Attachment ID for image.
 180   * @param string|int[] $size Optional. Image size. Accepts any registered image size name, or an array
 181   *                           of width and height values in pixels (in that order). Default 'medium'.
 182   * @return array|false {
 183   *     Array of image data, or boolean false if no image is available.
 184   *
 185   *     @type string $0 Image source URL.
 186   *     @type int    $1 Image width in pixels.
 187   *     @type int    $2 Image height in pixels.
 188   *     @type bool   $3 Whether the image is a resized image.
 189   * }
 190   */
 191  function image_downsize( $id, $size = 'medium' ) {
 192      $is_image = wp_attachment_is_image( $id );
 193  
 194      /**
 195       * Filters whether to preempt the output of image_downsize().
 196       *
 197       * Returning a truthy value from the filter will effectively short-circuit
 198       * down-sizing the image, returning that value instead.
 199       *
 200       * @since 2.5.0
 201       *
 202       * @param bool|array   $downsize Whether to short-circuit the image downsize.
 203       * @param int          $id       Attachment ID for image.
 204       * @param string|int[] $size     Requested image size. Can be any registered image size name, or
 205       *                               an array of width and height values in pixels (in that order).
 206       */
 207      $out = apply_filters( 'image_downsize', false, $id, $size );
 208  
 209      if ( $out ) {
 210          return $out;
 211      }
 212  
 213      $img_url          = wp_get_attachment_url( $id );
 214      $meta             = wp_get_attachment_metadata( $id );
 215      $width            = 0;
 216      $height           = 0;
 217      $is_intermediate  = false;
 218      $img_url_basename = wp_basename( $img_url );
 219  
 220      // If the file isn't an image, attempt to replace its URL with a rendered image from its meta.
 221      // Otherwise, a non-image type could be returned.
 222      if ( ! $is_image ) {
 223          if ( ! empty( $meta['sizes']['full'] ) ) {
 224              $img_url          = str_replace( $img_url_basename, $meta['sizes']['full']['file'], $img_url );
 225              $img_url_basename = $meta['sizes']['full']['file'];
 226              $width            = $meta['sizes']['full']['width'];
 227              $height           = $meta['sizes']['full']['height'];
 228          } else {
 229              return false;
 230          }
 231      }
 232  
 233      // Try for a new style intermediate size.
 234      $intermediate = image_get_intermediate_size( $id, $size );
 235  
 236      if ( $intermediate ) {
 237          $img_url         = str_replace( $img_url_basename, $intermediate['file'], $img_url );
 238          $width           = $intermediate['width'];
 239          $height          = $intermediate['height'];
 240          $is_intermediate = true;
 241      } elseif ( 'thumbnail' === $size ) {
 242          // Fall back to the old thumbnail.
 243          $thumb_file = wp_get_attachment_thumb_file( $id );
 244          $info       = null;
 245  
 246          if ( $thumb_file ) {
 247              $info = @getimagesize( $thumb_file );
 248          }
 249  
 250          if ( $thumb_file && $info ) {
 251              $img_url         = str_replace( $img_url_basename, wp_basename( $thumb_file ), $img_url );
 252              $width           = $info[0];
 253              $height          = $info[1];
 254              $is_intermediate = true;
 255          }
 256      }
 257  
 258      if ( ! $width && ! $height && isset( $meta['width'], $meta['height'] ) ) {
 259          // Any other type: use the real image.
 260          $width  = $meta['width'];
 261          $height = $meta['height'];
 262      }
 263  
 264      if ( $img_url ) {
 265          // We have the actual image size, but might need to further constrain it if content_width is narrower.
 266          list( $width, $height ) = image_constrain_size_for_editor( $width, $height, $size );
 267  
 268          return array( $img_url, $width, $height, $is_intermediate );
 269      }
 270  
 271      return false;
 272  }
 273  
 274  /**
 275   * Register a new image size.
 276   *
 277   * @since 2.9.0
 278   *
 279   * @global array $_wp_additional_image_sizes Associative array of additional image sizes.
 280   *
 281   * @param string     $name   Image size identifier.
 282   * @param int        $width  Optional. Image width in pixels. Default 0.
 283   * @param int        $height Optional. Image height in pixels. Default 0.
 284   * @param bool|array $crop   Optional. Image cropping behavior. If false, the image will be scaled (default),
 285   *                           If true, image will be cropped to the specified dimensions using center positions.
 286   *                           If an array, the image will be cropped using the array to specify the crop location.
 287   *                           Array values must be in the format: array( x_crop_position, y_crop_position ) where:
 288   *                               - x_crop_position accepts: 'left', 'center', or 'right'.
 289   *                               - y_crop_position accepts: 'top', 'center', or 'bottom'.
 290   */
 291  function add_image_size( $name, $width = 0, $height = 0, $crop = false ) {
 292      global $_wp_additional_image_sizes;
 293  
 294      $_wp_additional_image_sizes[ $name ] = array(
 295          'width'  => absint( $width ),
 296          'height' => absint( $height ),
 297          'crop'   => $crop,
 298      );
 299  }
 300  
 301  /**
 302   * Check if an image size exists.
 303   *
 304   * @since 3.9.0
 305   *
 306   * @param string $name The image size to check.
 307   * @return bool True if the image size exists, false if not.
 308   */
 309  function has_image_size( $name ) {
 310      $sizes = wp_get_additional_image_sizes();
 311      return isset( $sizes[ $name ] );
 312  }
 313  
 314  /**
 315   * Remove a new image size.
 316   *
 317   * @since 3.9.0
 318   *
 319   * @global array $_wp_additional_image_sizes
 320   *
 321   * @param string $name The image size to remove.
 322   * @return bool True if the image size was successfully removed, false on failure.
 323   */
 324  function remove_image_size( $name ) {
 325      global $_wp_additional_image_sizes;
 326  
 327      if ( isset( $_wp_additional_image_sizes[ $name ] ) ) {
 328          unset( $_wp_additional_image_sizes[ $name ] );
 329          return true;
 330      }
 331  
 332      return false;
 333  }
 334  
 335  /**
 336   * Registers an image size for the post thumbnail.
 337   *
 338   * @since 2.9.0
 339   *
 340   * @see add_image_size() for details on cropping behavior.
 341   *
 342   * @param int        $width  Image width in pixels.
 343   * @param int        $height Image height in pixels.
 344   * @param bool|array $crop   Optional. Whether to crop images to specified width and height or resize.
 345   *                           An array can specify positioning of the crop area. Default false.
 346   */
 347  function set_post_thumbnail_size( $width = 0, $height = 0, $crop = false ) {
 348      add_image_size( 'post-thumbnail', $width, $height, $crop );
 349  }
 350  
 351  /**
 352   * Gets an img tag for an image attachment, scaling it down if requested.
 353   *
 354   * The {@see 'get_image_tag_class'} filter allows for changing the class name for the
 355   * image without having to use regular expressions on the HTML content. The
 356   * parameters are: what WordPress will use for the class, the Attachment ID,
 357   * image align value, and the size the image should be.
 358   *
 359   * The second filter, {@see 'get_image_tag'}, has the HTML content, which can then be
 360   * further manipulated by a plugin to change all attribute values and even HTML
 361   * content.
 362   *
 363   * @since 2.5.0
 364   *
 365   * @param int          $id    Attachment ID.
 366   * @param string       $alt   Image description for the alt attribute.
 367   * @param string       $title Image description for the title attribute.
 368   * @param string       $align Part of the class name for aligning the image.
 369   * @param string|int[] $size  Optional. Image size. Accepts any registered image size name, or an array of
 370   *                            width and height values in pixels (in that order). Default 'medium'.
 371   * @return string HTML IMG element for given image attachment
 372   */
 373  function get_image_tag( $id, $alt, $title, $align, $size = 'medium' ) {
 374  
 375      list( $img_src, $width, $height ) = image_downsize( $id, $size );
 376      $hwstring                         = image_hwstring( $width, $height );
 377  
 378      $title = $title ? 'title="' . esc_attr( $title ) . '" ' : '';
 379  
 380      $size_class = is_array( $size ) ? implode( 'x', $size ) : $size;
 381      $class      = 'align' . esc_attr( $align ) . ' size-' . esc_attr( $size_class ) . ' wp-image-' . $id;
 382  
 383      /**
 384       * Filters the value of the attachment's image tag class attribute.
 385       *
 386       * @since 2.6.0
 387       *
 388       * @param string       $class CSS class name or space-separated list of classes.
 389       * @param int          $id    Attachment ID.
 390       * @param string       $align Part of the class name for aligning the image.
 391       * @param string|int[] $size  Requested image size. Can be any registered image size name, or
 392       *                            an array of width and height values in pixels (in that order).
 393       */
 394      $class = apply_filters( 'get_image_tag_class', $class, $id, $align, $size );
 395  
 396      $html = '<img src="' . esc_attr( $img_src ) . '" alt="' . esc_attr( $alt ) . '" ' . $title . $hwstring . 'class="' . $class . '" />';
 397  
 398      /**
 399       * Filters the HTML content for the image tag.
 400       *
 401       * @since 2.6.0
 402       *
 403       * @param string       $html  HTML content for the image.
 404       * @param int          $id    Attachment ID.
 405       * @param string       $alt   Image description for the alt attribute.
 406       * @param string       $title Image description for the title attribute.
 407       * @param string       $align Part of the class name for aligning the image.
 408       * @param string|int[] $size  Requested image size. Can be any registered image size name, or
 409       *                            an array of width and height values in pixels (in that order).
 410       */
 411      return apply_filters( 'get_image_tag', $html, $id, $alt, $title, $align, $size );
 412  }
 413  
 414  /**
 415   * Calculates the new dimensions for a down-sampled image.
 416   *
 417   * If either width or height are empty, no constraint is applied on
 418   * that dimension.
 419   *
 420   * @since 2.5.0
 421   *
 422   * @param int $current_width  Current width of the image.
 423   * @param int $current_height Current height of the image.
 424   * @param int $max_width      Optional. Max width in pixels to constrain to. Default 0.
 425   * @param int $max_height     Optional. Max height in pixels to constrain to. Default 0.
 426   * @return int[] {
 427   *     An array of width and height values.
 428   *
 429   *     @type int $0 The width in pixels.
 430   *     @type int $1 The height in pixels.
 431   * }
 432   */
 433  function wp_constrain_dimensions( $current_width, $current_height, $max_width = 0, $max_height = 0 ) {
 434      if ( ! $max_width && ! $max_height ) {
 435          return array( $current_width, $current_height );
 436      }
 437  
 438      $width_ratio  = 1.0;
 439      $height_ratio = 1.0;
 440      $did_width    = false;
 441      $did_height   = false;
 442  
 443      if ( $max_width > 0 && $current_width > 0 && $current_width > $max_width ) {
 444          $width_ratio = $max_width / $current_width;
 445          $did_width   = true;
 446      }
 447  
 448      if ( $max_height > 0 && $current_height > 0 && $current_height > $max_height ) {
 449          $height_ratio = $max_height / $current_height;
 450          $did_height   = true;
 451      }
 452  
 453      // Calculate the larger/smaller ratios.
 454      $smaller_ratio = min( $width_ratio, $height_ratio );
 455      $larger_ratio  = max( $width_ratio, $height_ratio );
 456  
 457      if ( (int) round( $current_width * $larger_ratio ) > $max_width || (int) round( $current_height * $larger_ratio ) > $max_height ) {
 458          // The larger ratio is too big. It would result in an overflow.
 459          $ratio = $smaller_ratio;
 460      } else {
 461          // The larger ratio fits, and is likely to be a more "snug" fit.
 462          $ratio = $larger_ratio;
 463      }
 464  
 465      // Very small dimensions may result in 0, 1 should be the minimum.
 466      $w = max( 1, (int) round( $current_width * $ratio ) );
 467      $h = max( 1, (int) round( $current_height * $ratio ) );
 468  
 469      /*
 470       * Sometimes, due to rounding, we'll end up with a result like this:
 471       * 465x700 in a 177x177 box is 117x176... a pixel short.
 472       * We also have issues with recursive calls resulting in an ever-changing result.
 473       * Constraining to the result of a constraint should yield the original result.
 474       * Thus we look for dimensions that are one pixel shy of the max value and bump them up.
 475       */
 476  
 477      // Note: $did_width means it is possible $smaller_ratio == $width_ratio.
 478      if ( $did_width && $w === $max_width - 1 ) {
 479          $w = $max_width; // Round it up.
 480      }
 481  
 482      // Note: $did_height means it is possible $smaller_ratio == $height_ratio.
 483      if ( $did_height && $h === $max_height - 1 ) {
 484          $h = $max_height; // Round it up.
 485      }
 486  
 487      /**
 488       * Filters dimensions to constrain down-sampled images to.
 489       *
 490       * @since 4.1.0
 491       *
 492       * @param int[] $dimensions     {
 493       *     An array of width and height values.
 494       *
 495       *     @type int $0 The width in pixels.
 496       *     @type int $1 The height in pixels.
 497       * }
 498       * @param int   $current_width  The current width of the image.
 499       * @param int   $current_height The current height of the image.
 500       * @param int   $max_width      The maximum width permitted.
 501       * @param int   $max_height     The maximum height permitted.
 502       */
 503      return apply_filters( 'wp_constrain_dimensions', array( $w, $h ), $current_width, $current_height, $max_width, $max_height );
 504  }
 505  
 506  /**
 507   * Retrieves calculated resize dimensions for use in WP_Image_Editor.
 508   *
 509   * Calculates dimensions and coordinates for a resized image that fits
 510   * within a specified width and height.
 511   *
 512   * Cropping behavior is dependent on the value of $crop:
 513   * 1. If false (default), images will not be cropped.
 514   * 2. If an array in the form of array( x_crop_position, y_crop_position ):
 515   *    - x_crop_position accepts 'left' 'center', or 'right'.
 516   *    - y_crop_position accepts 'top', 'center', or 'bottom'.
 517   *    Images will be cropped to the specified dimensions within the defined crop area.
 518   * 3. If true, images will be cropped to the specified dimensions using center positions.
 519   *
 520   * @since 2.5.0
 521   *
 522   * @param int        $orig_w Original width in pixels.
 523   * @param int        $orig_h Original height in pixels.
 524   * @param int        $dest_w New width in pixels.
 525   * @param int        $dest_h New height in pixels.
 526   * @param bool|array $crop   Optional. Whether to crop image to specified width and height or resize.
 527   *                           An array can specify positioning of the crop area. Default false.
 528   * @return array|false Returned array matches parameters for `imagecopyresampled()`. False on failure.
 529   */
 530  function image_resize_dimensions( $orig_w, $orig_h, $dest_w, $dest_h, $crop = false ) {
 531  
 532      if ( $orig_w <= 0 || $orig_h <= 0 ) {
 533          return false;
 534      }
 535      // At least one of $dest_w or $dest_h must be specific.
 536      if ( $dest_w <= 0 && $dest_h <= 0 ) {
 537          return false;
 538      }
 539  
 540      /**
 541       * Filters whether to preempt calculating the image resize dimensions.
 542       *
 543       * Returning a non-null value from the filter will effectively short-circuit
 544       * image_resize_dimensions(), returning that value instead.
 545       *
 546       * @since 3.4.0
 547       *
 548       * @param null|mixed $null   Whether to preempt output of the resize dimensions.
 549       * @param int        $orig_w Original width in pixels.
 550       * @param int        $orig_h Original height in pixels.
 551       * @param int        $dest_w New width in pixels.
 552       * @param int        $dest_h New height in pixels.
 553       * @param bool|array $crop   Whether to crop image to specified width and height or resize.
 554       *                           An array can specify positioning of the crop area. Default false.
 555       */
 556      $output = apply_filters( 'image_resize_dimensions', null, $orig_w, $orig_h, $dest_w, $dest_h, $crop );
 557  
 558      if ( null !== $output ) {
 559          return $output;
 560      }
 561  
 562      // Stop if the destination size is larger than the original image dimensions.
 563      if ( empty( $dest_h ) ) {
 564          if ( $orig_w < $dest_w ) {
 565              return false;
 566          }
 567      } elseif ( empty( $dest_w ) ) {
 568          if ( $orig_h < $dest_h ) {
 569              return false;
 570          }
 571      } else {
 572          if ( $orig_w < $dest_w && $orig_h < $dest_h ) {
 573              return false;
 574          }
 575      }
 576  
 577      if ( $crop ) {
 578          /*
 579           * Crop the largest possible portion of the original image that we can size to $dest_w x $dest_h.
 580           * Note that the requested crop dimensions are used as a maximum bounding box for the original image.
 581           * If the original image's width or height is less than the requested width or height
 582           * only the greater one will be cropped.
 583           * For example when the original image is 600x300, and the requested crop dimensions are 400x400,
 584           * the resulting image will be 400x300.
 585           */
 586          $aspect_ratio = $orig_w / $orig_h;
 587          $new_w        = min( $dest_w, $orig_w );
 588          $new_h        = min( $dest_h, $orig_h );
 589  
 590          if ( ! $new_w ) {
 591              $new_w = (int) round( $new_h * $aspect_ratio );
 592          }
 593  
 594          if ( ! $new_h ) {
 595              $new_h = (int) round( $new_w / $aspect_ratio );
 596          }
 597  
 598          $size_ratio = max( $new_w / $orig_w, $new_h / $orig_h );
 599  
 600          $crop_w = round( $new_w / $size_ratio );
 601          $crop_h = round( $new_h / $size_ratio );
 602  
 603          if ( ! is_array( $crop ) || count( $crop ) !== 2 ) {
 604              $crop = array( 'center', 'center' );
 605          }
 606  
 607          list( $x, $y ) = $crop;
 608  
 609          if ( 'left' === $x ) {
 610              $s_x = 0;
 611          } elseif ( 'right' === $x ) {
 612              $s_x = $orig_w - $crop_w;
 613          } else {
 614              $s_x = floor( ( $orig_w - $crop_w ) / 2 );
 615          }
 616  
 617          if ( 'top' === $y ) {
 618              $s_y = 0;
 619          } elseif ( 'bottom' === $y ) {
 620              $s_y = $orig_h - $crop_h;
 621          } else {
 622              $s_y = floor( ( $orig_h - $crop_h ) / 2 );
 623          }
 624      } else {
 625          // Resize using $dest_w x $dest_h as a maximum bounding box.
 626          $crop_w = $orig_w;
 627          $crop_h = $orig_h;
 628  
 629          $s_x = 0;
 630          $s_y = 0;
 631  
 632          list( $new_w, $new_h ) = wp_constrain_dimensions( $orig_w, $orig_h, $dest_w, $dest_h );
 633      }
 634  
 635      if ( wp_fuzzy_number_match( $new_w, $orig_w ) && wp_fuzzy_number_match( $new_h, $orig_h ) ) {
 636          // The new size has virtually the same dimensions as the original image.
 637  
 638          /**
 639           * Filters whether to proceed with making an image sub-size with identical dimensions
 640           * with the original/source image. Differences of 1px may be due to rounding and are ignored.
 641           *
 642           * @since 5.3.0
 643           *
 644           * @param bool $proceed The filtered value.
 645           * @param int  $orig_w  Original image width.
 646           * @param int  $orig_h  Original image height.
 647           */
 648          $proceed = (bool) apply_filters( 'wp_image_resize_identical_dimensions', false, $orig_w, $orig_h );
 649  
 650          if ( ! $proceed ) {
 651              return false;
 652          }
 653      }
 654  
 655      // The return array matches the parameters to imagecopyresampled().
 656      // int dst_x, int dst_y, int src_x, int src_y, int dst_w, int dst_h, int src_w, int src_h
 657      return array( 0, 0, (int) $s_x, (int) $s_y, (int) $new_w, (int) $new_h, (int) $crop_w, (int) $crop_h );
 658  }
 659  
 660  /**
 661   * Resizes an image to make a thumbnail or intermediate size.
 662   *
 663   * The returned array has the file size, the image width, and image height. The
 664   * {@see 'image_make_intermediate_size'} filter can be used to hook in and change the
 665   * values of the returned array. The only parameter is the resized file path.
 666   *
 667   * @since 2.5.0
 668   *
 669   * @param string $file   File path.
 670   * @param int    $width  Image width.
 671   * @param int    $height Image height.
 672   * @param bool   $crop   Optional. Whether to crop image to specified width and height or resize.
 673   *                       Default false.
 674   * @return array|false Metadata array on success. False if no image was created.
 675   */
 676  function image_make_intermediate_size( $file, $width, $height, $crop = false ) {
 677      if ( $width || $height ) {
 678          $editor = wp_get_image_editor( $file );
 679  
 680          if ( is_wp_error( $editor ) || is_wp_error( $editor->resize( $width, $height, $crop ) ) ) {
 681              return false;
 682          }
 683  
 684          $resized_file = $editor->save();
 685  
 686          if ( ! is_wp_error( $resized_file ) && $resized_file ) {
 687              unset( $resized_file['path'] );
 688              return $resized_file;
 689          }
 690      }
 691      return false;
 692  }
 693  
 694  /**
 695   * Helper function to test if aspect ratios for two images match.
 696   *
 697   * @since 4.6.0
 698   *
 699   * @param int $source_width  Width of the first image in pixels.
 700   * @param int $source_height Height of the first image in pixels.
 701   * @param int $target_width  Width of the second image in pixels.
 702   * @param int $target_height Height of the second image in pixels.
 703   * @return bool True if aspect ratios match within 1px. False if not.
 704   */
 705  function wp_image_matches_ratio( $source_width, $source_height, $target_width, $target_height ) {
 706      /*
 707       * To test for varying crops, we constrain the dimensions of the larger image
 708       * to the dimensions of the smaller image and see if they match.
 709       */
 710      if ( $source_width > $target_width ) {
 711          $constrained_size = wp_constrain_dimensions( $source_width, $source_height, $target_width );
 712          $expected_size    = array( $target_width, $target_height );
 713      } else {
 714          $constrained_size = wp_constrain_dimensions( $target_width, $target_height, $source_width );
 715          $expected_size    = array( $source_width, $source_height );
 716      }
 717  
 718      // If the image dimensions are within 1px of the expected size, we consider it a match.
 719      $matched = ( wp_fuzzy_number_match( $constrained_size[0], $expected_size[0] ) && wp_fuzzy_number_match( $constrained_size[1], $expected_size[1] ) );
 720  
 721      return $matched;
 722  }
 723  
 724  /**
 725   * Retrieves the image's intermediate size (resized) path, width, and height.
 726   *
 727   * The $size parameter can be an array with the width and height respectively.
 728   * If the size matches the 'sizes' metadata array for width and height, then it
 729   * will be used. If there is no direct match, then the nearest image size larger
 730   * than the specified size will be used. If nothing is found, then the function
 731   * will break out and return false.
 732   *
 733   * The metadata 'sizes' is used for compatible sizes that can be used for the
 734   * parameter $size value.
 735   *
 736   * The url path will be given, when the $size parameter is a string.
 737   *
 738   * If you are passing an array for the $size, you should consider using
 739   * add_image_size() so that a cropped version is generated. It's much more
 740   * efficient than having to find the closest-sized image and then having the
 741   * browser scale down the image.
 742   *
 743   * @since 2.5.0
 744   *
 745   * @param int          $post_id Attachment ID.
 746   * @param string|int[] $size    Optional. Image size. Accepts any registered image size name, or an array
 747   *                              of width and height values in pixels (in that order). Default 'thumbnail'.
 748   * @return array|false {
 749   *     Array of file relative path, width, and height on success. Additionally includes absolute
 750   *     path and URL if registered size is passed to `$size` parameter. False on failure.
 751   *
 752   *     @type string $file   Path of image relative to uploads directory.
 753   *     @type int    $width  Width of image in pixels.
 754   *     @type int    $height Height of image in pixels.
 755   *     @type string $path   Absolute filesystem path of image.
 756   *     @type string $url    URL of image.
 757   * }
 758   */
 759  function image_get_intermediate_size( $post_id, $size = 'thumbnail' ) {
 760      $imagedata = wp_get_attachment_metadata( $post_id );
 761  
 762      if ( ! $size || ! is_array( $imagedata ) || empty( $imagedata['sizes'] ) ) {
 763          return false;
 764      }
 765  
 766      $data = array();
 767  
 768      // Find the best match when '$size' is an array.
 769      if ( is_array( $size ) ) {
 770          $candidates = array();
 771  
 772          if ( ! isset( $imagedata['file'] ) && isset( $imagedata['sizes']['full'] ) ) {
 773              $imagedata['height'] = $imagedata['sizes']['full']['height'];
 774              $imagedata['width']  = $imagedata['sizes']['full']['width'];
 775          }
 776  
 777          foreach ( $imagedata['sizes'] as $_size => $data ) {
 778              // If there's an exact match to an existing image size, short circuit.
 779              if ( (int) $data['width'] === (int) $size[0] && (int) $data['height'] === (int) $size[1] ) {
 780                  $candidates[ $data['width'] * $data['height'] ] = $data;
 781                  break;
 782              }
 783  
 784              // If it's not an exact match, consider larger sizes with the same aspect ratio.
 785              if ( $data['width'] >= $size[0] && $data['height'] >= $size[1] ) {
 786                  // If '0' is passed to either size, we test ratios against the original file.
 787                  if ( 0 === $size[0] || 0 === $size[1] ) {
 788                      $same_ratio = wp_image_matches_ratio( $data['width'], $data['height'], $imagedata['width'], $imagedata['height'] );
 789                  } else {
 790                      $same_ratio = wp_image_matches_ratio( $data['width'], $data['height'], $size[0], $size[1] );
 791                  }
 792  
 793                  if ( $same_ratio ) {
 794                      $candidates[ $data['width'] * $data['height'] ] = $data;
 795                  }
 796              }
 797          }
 798  
 799          if ( ! empty( $candidates ) ) {
 800              // Sort the array by size if we have more than one candidate.
 801              if ( 1 < count( $candidates ) ) {
 802                  ksort( $candidates );
 803              }
 804  
 805              $data = array_shift( $candidates );
 806              /*
 807              * When the size requested is smaller than the thumbnail dimensions, we
 808              * fall back to the thumbnail size to maintain backward compatibility with
 809              * pre 4.6 versions of WordPress.
 810              */
 811          } elseif ( ! empty( $imagedata['sizes']['thumbnail'] ) && $imagedata['sizes']['thumbnail']['width'] >= $size[0] && $imagedata['sizes']['thumbnail']['width'] >= $size[1] ) {
 812              $data = $imagedata['sizes']['thumbnail'];
 813          } else {
 814              return false;
 815          }
 816  
 817          // Constrain the width and height attributes to the requested values.
 818          list( $data['width'], $data['height'] ) = image_constrain_size_for_editor( $data['width'], $data['height'], $size );
 819  
 820      } elseif ( ! empty( $imagedata['sizes'][ $size ] ) ) {
 821          $data = $imagedata['sizes'][ $size ];
 822      }
 823  
 824      // If we still don't have a match at this point, return false.
 825      if ( empty( $data ) ) {
 826          return false;
 827      }
 828  
 829      // Include the full filesystem path of the intermediate file.
 830      if ( empty( $data['path'] ) && ! empty( $data['file'] ) && ! empty( $imagedata['file'] ) ) {
 831          $file_url     = wp_get_attachment_url( $post_id );
 832          $data['path'] = path_join( dirname( $imagedata['file'] ), $data['file'] );
 833          $data['url']  = path_join( dirname( $file_url ), $data['file'] );
 834      }
 835  
 836      /**
 837       * Filters the output of image_get_intermediate_size()
 838       *
 839       * @since 4.4.0
 840       *
 841       * @see image_get_intermediate_size()
 842       *
 843       * @param array        $data    Array of file relative path, width, and height on success. May also include
 844       *                              file absolute path and URL.
 845       * @param int          $post_id The ID of the image attachment.
 846       * @param string|int[] $size    Requested image size. Can be any registered image size name, or
 847       *                              an array of width and height values in pixels (in that order).
 848       */
 849      return apply_filters( 'image_get_intermediate_size', $data, $post_id, $size );
 850  }
 851  
 852  /**
 853   * Gets the available intermediate image size names.
 854   *
 855   * @since 3.0.0
 856   *
 857   * @return string[] An array of image size names.
 858   */
 859  function get_intermediate_image_sizes() {
 860      $default_sizes    = array( 'thumbnail', 'medium', 'medium_large', 'large' );
 861      $additional_sizes = wp_get_additional_image_sizes();
 862  
 863      if ( ! empty( $additional_sizes ) ) {
 864          $default_sizes = array_merge( $default_sizes, array_keys( $additional_sizes ) );
 865      }
 866  
 867      /**
 868       * Filters the list of intermediate image sizes.
 869       *
 870       * @since 2.5.0
 871       *
 872       * @param string[] $default_sizes An array of intermediate image size names. Defaults
 873       *                                are 'thumbnail', 'medium', 'medium_large', 'large'.
 874       */
 875      return apply_filters( 'intermediate_image_sizes', $default_sizes );
 876  }
 877  
 878  /**
 879   * Returns a normalized list of all currently registered image sub-sizes.
 880   *
 881   * @since 5.3.0
 882   * @uses wp_get_additional_image_sizes()
 883   * @uses get_intermediate_image_sizes()
 884   *
 885   * @return array Associative array of the registered image sub-sizes.
 886   */
 887  function wp_get_registered_image_subsizes() {
 888      $additional_sizes = wp_get_additional_image_sizes();
 889      $all_sizes        = array();
 890  
 891      foreach ( get_intermediate_image_sizes() as $size_name ) {
 892          $size_data = array(
 893              'width'  => 0,
 894              'height' => 0,
 895              'crop'   => false,
 896          );
 897  
 898          if ( isset( $additional_sizes[ $size_name ]['width'] ) ) {
 899              // For sizes added by plugins and themes.
 900              $size_data['width'] = (int) $additional_sizes[ $size_name ]['width'];
 901          } else {
 902              // For default sizes set in options.
 903              $size_data['width'] = (int) get_option( "{$size_name}_size_w" );
 904          }
 905  
 906          if ( isset( $additional_sizes[ $size_name ]['height'] ) ) {
 907              $size_data['height'] = (int) $additional_sizes[ $size_name ]['height'];
 908          } else {
 909              $size_data['height'] = (int) get_option( "{$size_name}_size_h" );
 910          }
 911  
 912          if ( empty( $size_data['width'] ) && empty( $size_data['height'] ) ) {
 913              // This size isn't set.
 914              continue;
 915          }
 916  
 917          if ( isset( $additional_sizes[ $size_name ]['crop'] ) ) {
 918              $size_data['crop'] = $additional_sizes[ $size_name ]['crop'];
 919          } else {
 920              $size_data['crop'] = get_option( "{$size_name}_crop" );
 921          }
 922  
 923          if ( ! is_array( $size_data['crop'] ) || empty( $size_data['crop'] ) ) {
 924              $size_data['crop'] = (bool) $size_data['crop'];
 925          }
 926  
 927          $all_sizes[ $size_name ] = $size_data;
 928      }
 929  
 930      return $all_sizes;
 931  }
 932  
 933  /**
 934   * Retrieves an image to represent an attachment.
 935   *
 936   * @since 2.5.0
 937   *
 938   * @param int          $attachment_id Image attachment ID.
 939   * @param string|int[] $size          Optional. Image size. Accepts any registered image size name, or an array of
 940   *                                    width and height values in pixels (in that order). Default 'thumbnail'.
 941   * @param bool         $icon          Optional. Whether the image should fall back to a mime type icon. Default false.
 942   * @return array|false {
 943   *     Array of image data, or boolean false if no image is available.
 944   *
 945   *     @type string $0 Image source URL.
 946   *     @type int    $1 Image width in pixels.
 947   *     @type int    $2 Image height in pixels.
 948   *     @type bool   $3 Whether the image is a resized image.
 949   * }
 950   */
 951  function wp_get_attachment_image_src( $attachment_id, $size = 'thumbnail', $icon = false ) {
 952      // Get a thumbnail or intermediate image if there is one.
 953      $image = image_downsize( $attachment_id, $size );
 954      if ( ! $image ) {
 955          $src = false;
 956  
 957          if ( $icon ) {
 958              $src = wp_mime_type_icon( $attachment_id );
 959  
 960              if ( $src ) {
 961                  /** This filter is documented in wp-includes/post.php */
 962                  $icon_dir = apply_filters( 'icon_dir', ABSPATH . WPINC . '/images/media' );
 963  
 964                  $src_file               = $icon_dir . '/' . wp_basename( $src );
 965                  list( $width, $height ) = @getimagesize( $src_file );
 966              }
 967          }
 968  
 969          if ( $src && $width && $height ) {
 970              $image = array( $src, $width, $height, false );
 971          }
 972      }
 973      /**
 974       * Filters the attachment image source result.
 975       *
 976       * @since 4.3.0
 977       *
 978       * @param array|false  $image         {
 979       *     Array of image data, or boolean false if no image is available.
 980       *
 981       *     @type string $0 Image source URL.
 982       *     @type int    $1 Image width in pixels.
 983       *     @type int    $2 Image height in pixels.
 984       *     @type bool   $3 Whether the image is a resized image.
 985       * }
 986       * @param int          $attachment_id Image attachment ID.
 987       * @param string|int[] $size          Requested image size. Can be any registered image size name, or
 988       *                                    an array of width and height values in pixels (in that order).
 989       * @param bool         $icon          Whether the image should be treated as an icon.
 990       */
 991      return apply_filters( 'wp_get_attachment_image_src', $image, $attachment_id, $size, $icon );
 992  }
 993  
 994  /**
 995   * Get an HTML img element representing an image attachment.
 996   *
 997   * While `$size` will accept an array, it is better to register a size with
 998   * add_image_size() so that a cropped version is generated. It's much more
 999   * efficient than having to find the closest-sized image and then having the
1000   * browser scale down the image.
1001   *
1002   * @since 2.5.0
1003   * @since 4.4.0 The `$srcset` and `$sizes` attributes were added.
1004   * @since 5.5.0 The `$loading` attribute was added.
1005   *
1006   * @param int          $attachment_id Image attachment ID.
1007   * @param string|int[] $size          Optional. Image size. Accepts any registered image size name, or an array
1008   *                                    of width and height values in pixels (in that order). Default 'thumbnail'.
1009   * @param bool         $icon          Optional. Whether the image should be treated as an icon. Default false.
1010   * @param string|array $attr {
1011   *     Optional. Attributes for the image markup.
1012   *
1013   *     @type string       $src     Image attachment URL.
1014   *     @type string       $class   CSS class name or space-separated list of classes.
1015   *                                 Default `attachment-$size_class size-$size_class`,
1016   *                                 where `$size_class` is the image size being requested.
1017   *     @type string       $alt     Image description for the alt attribute.
1018   *     @type string       $srcset  The 'srcset' attribute value.
1019   *     @type string       $sizes   The 'sizes' attribute value.
1020   *     @type string|false $loading The 'loading' attribute value. Passing a value of false
1021   *                                 will result in the attribute being omitted for the image.
1022   *                                 Defaults to 'lazy', depending on wp_lazy_loading_enabled().
1023   * }
1024   * @return string HTML img element or empty string on failure.
1025   */
1026  function wp_get_attachment_image( $attachment_id, $size = 'thumbnail', $icon = false, $attr = '' ) {
1027      $html  = '';
1028      $image = wp_get_attachment_image_src( $attachment_id, $size, $icon );
1029  
1030      if ( $image ) {
1031          list( $src, $width, $height ) = $image;
1032  
1033          $attachment = get_post( $attachment_id );
1034          $hwstring   = image_hwstring( $width, $height );
1035          $size_class = $size;
1036  
1037          if ( is_array( $size_class ) ) {
1038              $size_class = implode( 'x', $size_class );
1039          }
1040  
1041          $default_attr = array(
1042              'src'   => $src,
1043              'class' => "attachment-$size_class size-$size_class",
1044              'alt'   => trim( strip_tags( get_post_meta( $attachment_id, '_wp_attachment_image_alt', true ) ) ),
1045          );
1046  
1047          // Add `loading` attribute.
1048          if ( wp_lazy_loading_enabled( 'img', 'wp_get_attachment_image' ) ) {
1049              $default_attr['loading'] = 'lazy';
1050          }
1051  
1052          $attr = wp_parse_args( $attr, $default_attr );
1053  
1054          // If the default value of `lazy` for the `loading` attribute is overridden
1055          // to omit the attribute for this image, ensure it is not included.
1056          if ( array_key_exists( 'loading', $attr ) && ! $attr['loading'] ) {
1057              unset( $attr['loading'] );
1058          }
1059  
1060          // Generate 'srcset' and 'sizes' if not already present.
1061          if ( empty( $attr['srcset'] ) ) {
1062              $image_meta = wp_get_attachment_metadata( $attachment_id );
1063  
1064              if ( is_array( $image_meta ) ) {
1065                  $size_array = array( absint( $width ), absint( $height ) );
1066                  $srcset     = wp_calculate_image_srcset( $size_array, $src, $image_meta, $attachment_id );
1067                  $sizes      = wp_calculate_image_sizes( $size_array, $src, $image_meta, $attachment_id );
1068  
1069                  if ( $srcset && ( $sizes || ! empty( $attr['sizes'] ) ) ) {
1070                      $attr['srcset'] = $srcset;
1071  
1072                      if ( empty( $attr['sizes'] ) ) {
1073                          $attr['sizes'] = $sizes;
1074                      }
1075                  }
1076              }
1077          }
1078  
1079          /**
1080           * Filters the list of attachment image attributes.
1081           *
1082           * @since 2.8.0
1083           *
1084           * @param array        $attr       Array of attribute values for the image markup, keyed by attribute name.
1085           *                                 See wp_get_attachment_image().
1086           * @param WP_Post      $attachment Image attachment post.
1087           * @param string|int[] $size       Requested image size. Can be any registered image size name, or
1088           *                                 an array of width and height values in pixels (in that order).
1089           */
1090          $attr = apply_filters( 'wp_get_attachment_image_attributes', $attr, $attachment, $size );
1091  
1092          $attr = array_map( 'esc_attr', $attr );
1093          $html = rtrim( "<img $hwstring" );
1094  
1095          foreach ( $attr as $name => $value ) {
1096              $html .= " $name=" . '"' . $value . '"';
1097          }
1098  
1099          $html .= ' />';
1100      }
1101  
1102      /**
1103       * HTML img element representing an image attachment.
1104       *
1105       * @since 5.6.0
1106       *
1107       * @param string       $html          HTML img element or empty string on failure.
1108       * @param int          $attachment_id Image attachment ID.
1109       * @param string|int[] $size          Requested image size. Can be any registered image size name, or
1110       *                                    an array of width and height values in pixels (in that order).
1111       * @param bool         $icon          Whether the image should be treated as an icon.
1112       * @param array        $attr          Array of attribute values for the image markup, keyed by attribute name.
1113       *                                    See wp_get_attachment_image().
1114       */
1115      return apply_filters( 'wp_get_attachment_image', $html, $attachment_id, $size, $icon, $attr );
1116  }
1117  
1118  /**
1119   * Get the URL of an image attachment.
1120   *
1121   * @since 4.4.0
1122   *
1123   * @param int          $attachment_id Image attachment ID.
1124   * @param string|int[] $size          Optional. Image size. Accepts any registered image size name, or an array of
1125   *                                    width and height values in pixels (in that order). Default 'thumbnail'.
1126   * @param bool         $icon          Optional. Whether the image should be treated as an icon. Default false.
1127   * @return string|false Attachment URL or false if no image is available.
1128   */
1129  function wp_get_attachment_image_url( $attachment_id, $size = 'thumbnail', $icon = false ) {
1130      $image = wp_get_attachment_image_src( $attachment_id, $size, $icon );
1131      return isset( $image['0'] ) ? $image['0'] : false;
1132  }
1133  
1134  /**
1135   * Get the attachment path relative to the upload directory.
1136   *
1137   * @since 4.4.1
1138   * @access private
1139   *
1140   * @param string $file Attachment file name.
1141   * @return string Attachment path relative to the upload directory.
1142   */
1143  function _wp_get_attachment_relative_path( $file ) {
1144      $dirname = dirname( $file );
1145  
1146      if ( '.' === $dirname ) {
1147          return '';
1148      }
1149  
1150      if ( false !== strpos( $dirname, 'wp-content/uploads' ) ) {
1151          // Get the directory name relative to the upload directory (back compat for pre-2.7 uploads).
1152          $dirname = substr( $dirname, strpos( $dirname, 'wp-content/uploads' ) + 18 );
1153          $dirname = ltrim( $dirname, '/' );
1154      }
1155  
1156      return $dirname;
1157  }
1158  
1159  /**
1160   * Get the image size as array from its meta data.
1161   *
1162   * Used for responsive images.
1163   *
1164   * @since 4.4.0
1165   * @access private
1166   *
1167   * @param string $size_name  Image size. Accepts any registered image size name.
1168   * @param array  $image_meta The image meta data.
1169   * @return array|false {
1170   *     Array of width and height or false if the size isn't present in the meta data.
1171   *
1172   *     @type int $0 Image width.
1173   *     @type int $1 Image height.
1174   * }
1175   */
1176  function _wp_get_image_size_from_meta( $size_name, $image_meta ) {
1177      if ( 'full' === $size_name ) {
1178          return array(
1179              absint( $image_meta['width'] ),
1180              absint( $image_meta['height'] ),
1181          );
1182      } elseif ( ! empty( $image_meta['sizes'][ $size_name ] ) ) {
1183          return array(
1184              absint( $image_meta['sizes'][ $size_name ]['width'] ),
1185              absint( $image_meta['sizes'][ $size_name ]['height'] ),
1186          );
1187      }
1188  
1189      return false;
1190  }
1191  
1192  /**
1193   * Retrieves the value for an image attachment's 'srcset' attribute.
1194   *
1195   * @since 4.4.0
1196   *
1197   * @see wp_calculate_image_srcset()
1198   *
1199   * @param int          $attachment_id Image attachment ID.
1200   * @param string|int[] $size          Optional. Image size. Accepts any registered image size name, or an array of
1201   *                                    width and height values in pixels (in that order). Default 'medium'.
1202   * @param array        $image_meta    Optional. The image meta data as returned by 'wp_get_attachment_metadata()'.
1203   *                                    Default null.
1204   * @return string|bool A 'srcset' value string or false.
1205   */
1206  function wp_get_attachment_image_srcset( $attachment_id, $size = 'medium', $image_meta = null ) {
1207      $image = wp_get_attachment_image_src( $attachment_id, $size );
1208  
1209      if ( ! $image ) {
1210          return false;
1211      }
1212  
1213      if ( ! is_array( $image_meta ) ) {
1214          $image_meta = wp_get_attachment_metadata( $attachment_id );
1215      }
1216  
1217      $image_src  = $image[0];
1218      $size_array = array(
1219          absint( $image[1] ),
1220          absint( $image[2] ),
1221      );
1222  
1223      return wp_calculate_image_srcset( $size_array, $image_src, $image_meta, $attachment_id );
1224  }
1225  
1226  /**
1227   * A helper function to calculate the image sources to include in a 'srcset' attribute.
1228   *
1229   * @since 4.4.0
1230   *
1231   * @param int[]  $size_array    {
1232   *     An array of width and height values.
1233   *
1234   *     @type int $0 The width in pixels.
1235   *     @type int $1 The height in pixels.
1236   * }
1237   * @param string $image_src     The 'src' of the image.
1238   * @param array  $image_meta    The image meta data as returned by 'wp_get_attachment_metadata()'.
1239   * @param int    $attachment_id Optional. The image attachment ID. Default 0.
1240   * @return string|bool          The 'srcset' attribute value. False on error or when only one source exists.
1241   */
1242  function wp_calculate_image_srcset( $size_array, $image_src, $image_meta, $attachment_id = 0 ) {
1243      /**
1244       * Let plugins pre-filter the image meta to be able to fix inconsistencies in the stored data.
1245       *
1246       * @since 4.5.0
1247       *
1248       * @param array  $image_meta    The image meta data as returned by 'wp_get_attachment_metadata()'.
1249       * @param int[]  $size_array    {
1250       *     An array of requested width and height values.
1251       *
1252       *     @type int $0 The width in pixels.
1253       *     @type int $1 The height in pixels.
1254       * }
1255       * @param string $image_src     The 'src' of the image.
1256       * @param int    $attachment_id The image attachment ID or 0 if not supplied.
1257       */
1258      $image_meta = apply_filters( 'wp_calculate_image_srcset_meta', $image_meta, $size_array, $image_src, $attachment_id );
1259  
1260      if ( empty( $image_meta['sizes'] ) || ! isset( $image_meta['file'] ) || strlen( $image_meta['file'] ) < 4 ) {
1261          return false;
1262      }
1263  
1264      $image_sizes = $image_meta['sizes'];
1265  
1266      // Get the width and height of the image.
1267      $image_width  = (int) $size_array[0];
1268      $image_height = (int) $size_array[1];
1269  
1270      // Bail early if error/no width.
1271      if ( $image_width < 1 ) {
1272          return false;
1273      }
1274  
1275      $image_basename = wp_basename( $image_meta['file'] );
1276  
1277      /*
1278       * WordPress flattens animated GIFs into one frame when generating intermediate sizes.
1279       * To avoid hiding animation in user content, if src is a full size GIF, a srcset attribute is not generated.
1280       * If src is an intermediate size GIF, the full size is excluded from srcset to keep a flattened GIF from becoming animated.
1281       */
1282      if ( ! isset( $image_sizes['thumbnail']['mime-type'] ) || 'image/gif' !== $image_sizes['thumbnail']['mime-type'] ) {
1283          $image_sizes[] = array(
1284              'width'  => $image_meta['width'],
1285              'height' => $image_meta['height'],
1286              'file'   => $image_basename,
1287          );
1288      } elseif ( strpos( $image_src, $image_meta['file'] ) ) {
1289          return false;
1290      }
1291  
1292      // Retrieve the uploads sub-directory from the full size image.
1293      $dirname = _wp_get_attachment_relative_path( $image_meta['file'] );
1294  
1295      if ( $dirname ) {
1296          $dirname = trailingslashit( $dirname );
1297      }
1298  
1299      $upload_dir    = wp_get_upload_dir();
1300      $image_baseurl = trailingslashit( $upload_dir['baseurl'] ) . $dirname;
1301  
1302      /*
1303       * If currently on HTTPS, prefer HTTPS URLs when we know they're supported by the domain
1304       * (which is to say, when they share the domain name of the current request).
1305       */
1306      if ( is_ssl() && 'https' !== substr( $image_baseurl, 0, 5 ) && parse_url( $image_baseurl, PHP_URL_HOST ) === $_SERVER['HTTP_HOST'] ) {
1307          $image_baseurl = set_url_scheme( $image_baseurl, 'https' );
1308      }
1309  
1310      /*
1311       * Images that have been edited in WordPress after being uploaded will
1312       * contain a unique hash. Look for that hash and use it later to filter
1313       * out images that are leftovers from previous versions.
1314       */
1315      $image_edited = preg_match( '/-e[0-9]{13}/', wp_basename( $image_src ), $image_edit_hash );
1316  
1317      /**
1318       * Filters the maximum image width to be included in a 'srcset' attribute.
1319       *
1320       * @since 4.4.0
1321       *
1322       * @param int   $max_width  The maximum image width to be included in the 'srcset'. Default '2048'.
1323       * @param int[] $size_array {
1324       *     An array of requested width and height values.
1325       *
1326       *     @type int $0 The width in pixels.
1327       *     @type int $1 The height in pixels.
1328       * }
1329       */
1330      $max_srcset_image_width = apply_filters( 'max_srcset_image_width', 2048, $size_array );
1331  
1332      // Array to hold URL candidates.
1333      $sources = array();
1334  
1335      /**
1336       * To make sure the ID matches our image src, we will check to see if any sizes in our attachment
1337       * meta match our $image_src. If no matches are found we don't return a srcset to avoid serving
1338       * an incorrect image. See #35045.
1339       */
1340      $src_matched = false;
1341  
1342      /*
1343       * Loop through available images. Only use images that are resized
1344       * versions of the same edit.
1345       */
1346      foreach ( $image_sizes as $image ) {
1347          $is_src = false;
1348  
1349          // Check if image meta isn't corrupted.
1350          if ( ! is_array( $image ) ) {
1351              continue;
1352          }
1353  
1354          // If the file name is part of the `src`, we've confirmed a match.
1355          if ( ! $src_matched && false !== strpos( $image_src, $dirname . $image['file'] ) ) {
1356              $src_matched = true;
1357              $is_src      = true;
1358          }
1359  
1360          // Filter out images that are from previous edits.
1361          if ( $image_edited && ! strpos( $image['file'], $image_edit_hash[0] ) ) {
1362              continue;
1363          }
1364  
1365          /*
1366           * Filters out images that are wider than '$max_srcset_image_width' unless
1367           * that file is in the 'src' attribute.
1368           */
1369          if ( $max_srcset_image_width && $image['width'] > $max_srcset_image_width && ! $is_src ) {
1370              continue;
1371          }
1372  
1373          // If the image dimensions are within 1px of the expected size, use it.
1374          if ( wp_image_matches_ratio( $image_width, $image_height, $image['width'], $image['height'] ) ) {
1375              // Add the URL, descriptor, and value to the sources array to be returned.
1376              $source = array(
1377                  'url'        => $image_baseurl . $image['file'],
1378                  'descriptor' => 'w',
1379                  'value'      => $image['width'],
1380              );
1381  
1382              // The 'src' image has to be the first in the 'srcset', because of a bug in iOS8. See #35030.
1383              if ( $is_src ) {
1384                  $sources = array( $image['width'] => $source ) + $sources;
1385              } else {
1386                  $sources[ $image['width'] ] = $source;
1387              }
1388          }
1389      }
1390  
1391      /**
1392       * Filters an image's 'srcset' sources.
1393       *
1394       * @since 4.4.0
1395       *
1396       * @param array  $sources {
1397       *     One or more arrays of source data to include in the 'srcset'.
1398       *
1399       *     @type array $width {
1400       *         @type string $url        The URL of an image source.
1401       *         @type string $descriptor The descriptor type used in the image candidate string,
1402       *                                  either 'w' or 'x'.
1403       *         @type int    $value      The source width if paired with a 'w' descriptor, or a
1404       *                                  pixel density value if paired with an 'x' descriptor.
1405       *     }
1406       * }
1407       * @param array $size_array     {
1408       *     An array of requested width and height values.
1409       *
1410       *     @type int $0 The width in pixels.
1411       *     @type int $1 The height in pixels.
1412       * }
1413       * @param string $image_src     The 'src' of the image.
1414       * @param array  $image_meta    The image meta data as returned by 'wp_get_attachment_metadata()'.
1415       * @param int    $attachment_id Image attachment ID or 0.
1416       */
1417      $sources = apply_filters( 'wp_calculate_image_srcset', $sources, $size_array, $image_src, $image_meta, $attachment_id );
1418  
1419      // Only return a 'srcset' value if there is more than one source.
1420      if ( ! $src_matched || ! is_array( $sources ) || count( $sources ) < 2 ) {
1421          return false;
1422      }
1423  
1424      $srcset = '';
1425  
1426      foreach ( $sources as $source ) {
1427          $srcset .= str_replace( ' ', '%20', $source['url'] ) . ' ' . $source['value'] . $source['descriptor'] . ', ';
1428      }
1429  
1430      return rtrim( $srcset, ', ' );
1431  }
1432  
1433  /**
1434   * Retrieves the value for an image attachment's 'sizes' attribute.
1435   *
1436   * @since 4.4.0
1437   *
1438   * @see wp_calculate_image_sizes()
1439   *
1440   * @param int          $attachment_id Image attachment ID.
1441   * @param string|int[] $size          Optional. Image size. Accepts any registered image size name, or an array of
1442   *                                    width and height values in pixels (in that order). Default 'medium'.
1443   * @param array        $image_meta    Optional. The image meta data as returned by 'wp_get_attachment_metadata()'.
1444   *                                    Default null.
1445   * @return string|bool A valid source size value for use in a 'sizes' attribute or false.
1446   */
1447  function wp_get_attachment_image_sizes( $attachment_id, $size = 'medium', $image_meta = null ) {
1448      $image = wp_get_attachment_image_src( $attachment_id, $size );
1449  
1450      if ( ! $image ) {
1451          return false;
1452      }
1453  
1454      if ( ! is_array( $image_meta ) ) {
1455          $image_meta = wp_get_attachment_metadata( $attachment_id );
1456      }
1457  
1458      $image_src  = $image[0];
1459      $size_array = array(
1460          absint( $image[1] ),
1461          absint( $image[2] ),
1462      );
1463  
1464      return wp_calculate_image_sizes( $size_array, $image_src, $image_meta, $attachment_id );
1465  }
1466  
1467  /**
1468   * Creates a 'sizes' attribute value for an image.
1469   *
1470   * @since 4.4.0
1471   *
1472   * @param string|int[] $size          Image size. Accepts any registered image size name, or an array of
1473   *                                    width and height values in pixels (in that order).
1474   * @param string       $image_src     Optional. The URL to the image file. Default null.
1475   * @param array        $image_meta    Optional. The image meta data as returned by 'wp_get_attachment_metadata()'.
1476   *                                    Default null.
1477   * @param int          $attachment_id Optional. Image attachment ID. Either `$image_meta` or `$attachment_id`
1478   *                                    is needed when using the image size name as argument for `$size`. Default 0.
1479   * @return string|bool A valid source size value for use in a 'sizes' attribute or false.
1480   */
1481  function wp_calculate_image_sizes( $size, $image_src = null, $image_meta = null, $attachment_id = 0 ) {
1482      $width = 0;
1483  
1484      if ( is_array( $size ) ) {
1485          $width = absint( $size[0] );
1486      } elseif ( is_string( $size ) ) {
1487          if ( ! $image_meta && $attachment_id ) {
1488              $image_meta = wp_get_attachment_metadata( $attachment_id );
1489          }
1490  
1491          if ( is_array( $image_meta ) ) {
1492              $size_array = _wp_get_image_size_from_meta( $size, $image_meta );
1493              if ( $size_array ) {
1494                  $width = absint( $size_array[0] );
1495              }
1496          }
1497      }
1498  
1499      if ( ! $width ) {
1500          return false;
1501      }
1502  
1503      // Setup the default 'sizes' attribute.
1504      $sizes = sprintf( '(max-width: %1$dpx) 100vw, %1$dpx', $width );
1505  
1506      /**
1507       * Filters the output of 'wp_calculate_image_sizes()'.
1508       *
1509       * @since 4.4.0
1510       *
1511       * @param string       $sizes         A source size value for use in a 'sizes' attribute.
1512       * @param string|int[] $size          Requested image size. Can be any registered image size name, or
1513       *                                    an array of width and height values in pixels (in that order).
1514       * @param string|null  $image_src     The URL to the image file or null.
1515       * @param array|null   $image_meta    The image meta data as returned by wp_get_attachment_metadata() or null.
1516       * @param int          $attachment_id Image attachment ID of the original image or 0.
1517       */
1518      return apply_filters( 'wp_calculate_image_sizes', $sizes, $size, $image_src, $image_meta, $attachment_id );
1519  }
1520  
1521  /**
1522   * Determines if the image meta data is for the image source file.
1523   *
1524   * The image meta data is retrieved by attachment post ID. In some cases the post IDs may change.
1525   * For example when the website is exported and imported at another website. Then the
1526   * attachment post IDs that are in post_content for the exported website may not match
1527   * the same attachments at the new website.
1528   *
1529   * @since 5.5.0
1530   *
1531   * @param string $image_location The full path or URI to the image file.
1532   * @param array  $image_meta     The attachment meta data as returned by 'wp_get_attachment_metadata()'.
1533   * @param int    $attachment_id  Optional. The image attachment ID. Default 0.
1534   * @return bool Whether the image meta is for this image file.
1535   */
1536  function wp_image_file_matches_image_meta( $image_location, $image_meta, $attachment_id = 0 ) {
1537      $match = false;
1538  
1539      // Ensure the $image_meta is valid.
1540      if ( isset( $image_meta['file'] ) && strlen( $image_meta['file'] ) > 4 ) {
1541          // Remove quiery args if image URI.
1542          list( $image_location ) = explode( '?', $image_location );
1543  
1544          // Check if the relative image path from the image meta is at the end of $image_location.
1545          if ( strrpos( $image_location, $image_meta['file'] ) === strlen( $image_location ) - strlen( $image_meta['file'] ) ) {
1546              $match = true;
1547          } else {
1548              // Retrieve the uploads sub-directory from the full size image.
1549              $dirname = _wp_get_attachment_relative_path( $image_meta['file'] );
1550  
1551              if ( $dirname ) {
1552                  $dirname = trailingslashit( $dirname );
1553              }
1554  
1555              if ( ! empty( $image_meta['original_image'] ) ) {
1556                  $relative_path = $dirname . $image_meta['original_image'];
1557  
1558                  if ( strrpos( $image_location, $relative_path ) === strlen( $image_location ) - strlen( $relative_path ) ) {
1559                      $match = true;
1560                  }
1561              }
1562  
1563              if ( ! $match && ! empty( $image_meta['sizes'] ) ) {
1564                  foreach ( $image_meta['sizes'] as $image_size_data ) {
1565                      $relative_path = $dirname . $image_size_data['file'];
1566  
1567                      if ( strrpos( $image_location, $relative_path ) === strlen( $image_location ) - strlen( $relative_path ) ) {
1568                          $match = true;
1569                          break;
1570                      }
1571                  }
1572              }
1573          }
1574      }
1575  
1576      /**
1577       * Filters whether an image path or URI matches image meta.
1578       *
1579       * @since 5.5.0
1580       *
1581       * @param bool   $match          Whether the image relative path from the image meta
1582       *                               matches the end of the URI or path to the image file.
1583       * @param string $image_location Full path or URI to the tested image file.
1584       * @param array  $image_meta     The image meta data as returned by 'wp_get_attachment_metadata()'.
1585       * @param int    $attachment_id  The image attachment ID or 0 if not supplied.
1586       */
1587      return apply_filters( 'wp_image_file_matches_image_meta', $match, $image_location, $image_meta, $attachment_id );
1588  }
1589  
1590  /**
1591   * Determines an image's width and height dimensions based on the source file.
1592   *
1593   * @since 5.5.0
1594   *
1595   * @param string $image_src     The image source file.
1596   * @param array  $image_meta    The image meta data as returned by 'wp_get_attachment_metadata()'.
1597   * @param int    $attachment_id Optional. The image attachment ID. Default 0.
1598   * @return array|false Array with first element being the width and second element being the height,
1599   *                     or false if dimensions cannot be determined.
1600   */
1601  function wp_image_src_get_dimensions( $image_src, $image_meta, $attachment_id = 0 ) {
1602      if ( ! wp_image_file_matches_image_meta( $image_src, $image_meta, $attachment_id ) ) {
1603          return false;
1604      }
1605  
1606      // Is it a full size image?
1607      if ( strpos( $image_src, $image_meta['file'] ) !== false ) {
1608          return array(
1609              (int) $image_meta['width'],
1610              (int) $image_meta['height'],
1611          );
1612      }
1613  
1614      if ( ! empty( $image_meta['sizes'] ) ) {
1615          $src_filename = wp_basename( $image_src );
1616  
1617          foreach ( $image_meta['sizes'] as $image_size_data ) {
1618              if ( $src_filename === $image_size_data['file'] ) {
1619                  return array(
1620                      (int) $image_size_data['width'],
1621                      (int) $image_size_data['height'],
1622                  );
1623              }
1624          }
1625      }
1626  
1627      return false;
1628  }
1629  
1630  /**
1631   * Adds 'srcset' and 'sizes' attributes to an existing 'img' element.
1632   *
1633   * @since 4.4.0
1634   *
1635   * @see wp_calculate_image_srcset()
1636   * @see wp_calculate_image_sizes()
1637   *
1638   * @param string $image         An HTML 'img' element to be filtered.
1639   * @param array  $image_meta    The image meta data as returned by 'wp_get_attachment_metadata()'.
1640   * @param int    $attachment_id Image attachment ID.
1641   * @return string Converted 'img' element with 'srcset' and 'sizes' attributes added.
1642   */
1643  function wp_image_add_srcset_and_sizes( $image, $image_meta, $attachment_id ) {
1644      // Ensure the image meta exists.
1645      if ( empty( $image_meta['sizes'] ) ) {
1646          return $image;
1647      }
1648  
1649      $image_src         = preg_match( '/src="([^"]+)"/', $image, $match_src ) ? $match_src[1] : '';
1650      list( $image_src ) = explode( '?', $image_src );
1651  
1652      // Return early if we couldn't get the image source.
1653      if ( ! $image_src ) {
1654          return $image;
1655      }
1656  
1657      // Bail early if an image has been inserted and later edited.
1658      if ( preg_match( '/-e[0-9]{13}/', $image_meta['file'], $img_edit_hash ) &&
1659          strpos( wp_basename( $image_src ), $img_edit_hash[0] ) === false ) {
1660  
1661          return $image;
1662      }
1663  
1664      $width  = preg_match( '/ width="([0-9]+)"/', $image, $match_width ) ? (int) $match_width[1] : 0;
1665      $height = preg_match( '/ height="([0-9]+)"/', $image, $match_height ) ? (int) $match_height[1] : 0;
1666  
1667      if ( $width && $height ) {
1668          $size_array = array( $width, $height );
1669      } else {
1670          $size_array = wp_image_src_get_dimensions( $image_src, $image_meta, $attachment_id );
1671          if ( ! $size_array ) {
1672              return $image;
1673          }
1674      }
1675  
1676      $srcset = wp_calculate_image_srcset( $size_array, $image_src, $image_meta, $attachment_id );
1677  
1678      if ( $srcset ) {
1679          // Check if there is already a 'sizes' attribute.
1680          $sizes = strpos( $image, ' sizes=' );
1681  
1682          if ( ! $sizes ) {
1683              $sizes = wp_calculate_image_sizes( $size_array, $image_src, $image_meta, $attachment_id );
1684          }
1685      }
1686  
1687      if ( $srcset && $sizes ) {
1688          // Format the 'srcset' and 'sizes' string and escape attributes.
1689          $attr = sprintf( ' srcset="%s"', esc_attr( $srcset ) );
1690  
1691          if ( is_string( $sizes ) ) {
1692              $attr .= sprintf( ' sizes="%s"', esc_attr( $sizes ) );
1693          }
1694  
1695          // Add the srcset and sizes attributes to the image markup.
1696          return preg_replace( '/<img ([^>]+?)[\/ ]*>/', '<img $1' . $attr . ' />', $image );
1697      }
1698  
1699      return $image;
1700  }
1701  
1702  /**
1703   * Determines whether to add the `loading` attribute to the specified tag in the specified context.
1704   *
1705   * @since 5.5.0
1706   *
1707   * @param string $tag_name The tag name.
1708   * @param string $context  Additional context, like the current filter name
1709   *                         or the function name from where this was called.
1710   * @return bool Whether to add the attribute.
1711   */
1712  function wp_lazy_loading_enabled( $tag_name, $context ) {
1713      // By default add to all 'img' tags.
1714      // See https://html.spec.whatwg.org/multipage/embedded-content.html#attr-img-loading
1715      $default = ( 'img' === $tag_name );
1716  
1717      /**
1718       * Filters whether to add the `loading` attribute to the specified tag in the specified context.
1719       *
1720       * @since 5.5.0
1721       *
1722       * @param bool   $default  Default value.
1723       * @param string $tag_name The tag name.
1724       * @param string $context  Additional context, like the current filter name
1725       *                         or the function name from where this was called.
1726       */
1727      return (bool) apply_filters( 'wp_lazy_loading_enabled', $default, $tag_name, $context );
1728  }
1729  
1730  /**
1731   * Filters specific tags in post content and modifies their markup.
1732   *
1733   * Modifies HTML tags in post content to include new browser and HTML technologies
1734   * that may not have existed at the time of post creation. These modifications currently
1735   * include adding `srcset`, `sizes`, and `loading` attributes to `img` HTML tags.
1736   * Future similar optimizations should be added/expected here.
1737   *
1738   * @since 5.5.0
1739   *
1740   * @see wp_img_tag_add_width_and_height_attr()
1741   * @see wp_img_tag_add_srcset_and_sizes_attr()
1742   * @see wp_img_tag_add_loading_attr()
1743   *
1744   * @param string $content The HTML content to be filtered.
1745   * @param string $context Optional. Additional context to pass to the filters.
1746   *                        Defaults to `current_filter()` when not set.
1747   * @return string Converted content with images modified.
1748   */
1749  function wp_filter_content_tags( $content, $context = null ) {
1750      if ( null === $context ) {
1751          $context = current_filter();
1752      }
1753  
1754      $add_loading_attr = wp_lazy_loading_enabled( 'img', $context );
1755  
1756      if ( false === strpos( $content, '<img' ) ) {
1757          return $content;
1758      }
1759  
1760      if ( ! preg_match_all( '/<img\s[^>]+>/', $content, $matches ) ) {
1761          return $content;
1762      }
1763  
1764      // List of the unique `img` tags found in $content.
1765      $images = array();
1766  
1767      foreach ( $matches[0] as $image ) {
1768          if ( preg_match( '/wp-image-([0-9]+)/i', $image, $class_id ) ) {
1769              $attachment_id = absint( $class_id[1] );
1770  
1771              if ( $attachment_id ) {
1772                  // If exactly the same image tag is used more than once, overwrite it.
1773                  // All identical tags will be replaced later with 'str_replace()'.
1774                  $images[ $image ] = $attachment_id;
1775                  continue;
1776              }
1777          }
1778  
1779          $images[ $image ] = 0;
1780      }
1781  
1782      // Reduce the array to unique attachment IDs.
1783      $attachment_ids = array_unique( array_filter( array_values( $images ) ) );
1784  
1785      if ( count( $attachment_ids ) > 1 ) {
1786          /*
1787           * Warm the object cache with post and meta information for all found
1788           * images to avoid making individual database calls.
1789           */
1790          _prime_post_caches( $attachment_ids, false, true );
1791      }
1792  
1793      foreach ( $images as $image => $attachment_id ) {
1794          $filtered_image = $image;
1795  
1796          // Add 'width' and 'height' attributes if applicable.
1797          if ( $attachment_id > 0 && false === strpos( $filtered_image, ' width=' ) && false === strpos( $filtered_image, ' height=' ) ) {
1798              $filtered_image = wp_img_tag_add_width_and_height_attr( $filtered_image, $context, $attachment_id );
1799          }
1800  
1801          // Add 'srcset' and 'sizes' attributes if applicable.
1802          if ( $attachment_id > 0 && false === strpos( $filtered_image, ' srcset=' ) ) {
1803              $filtered_image = wp_img_tag_add_srcset_and_sizes_attr( $filtered_image, $context, $attachment_id );
1804          }
1805  
1806          // Add 'loading' attribute if applicable.
1807          if ( $add_loading_attr && false === strpos( $filtered_image, ' loading=' ) ) {
1808              $filtered_image = wp_img_tag_add_loading_attr( $filtered_image, $context );
1809          }
1810  
1811          if ( $filtered_image !== $image ) {
1812              $content = str_replace( $image, $filtered_image, $content );
1813          }
1814      }
1815  
1816      return $content;
1817  }
1818  
1819  /**
1820   * Adds `loading` attribute to an `img` HTML tag.
1821   *
1822   * @since 5.5.0
1823   *
1824   * @param string $image   The HTML `img` tag where the attribute should be added.
1825   * @param string $context Additional context to pass to the filters.
1826   * @return string Converted `img` tag with `loading` attribute added.
1827   */
1828  function wp_img_tag_add_loading_attr( $image, $context ) {
1829      /**
1830       * Filters the `loading` attribute value. Default `lazy`.
1831       *
1832       * Returning `false` or an empty string will not add the attribute.
1833       * Returning `true` will add the default value.
1834       *
1835       * @since 5.5.0
1836       *
1837       * @param string|bool $value   The `loading` attribute value. Returning a falsey value will result in
1838       *                             the attribute being omitted for the image. Default 'lazy'.
1839       * @param string      $image   The HTML `img` tag to be filtered.
1840       * @param string      $context Additional context about how the function was called or where the img tag is.
1841       */
1842      $value = apply_filters( 'wp_img_tag_add_loading_attr', 'lazy', $image, $context );
1843  
1844      if ( $value ) {
1845          if ( ! in_array( $value, array( 'lazy', 'eager' ), true ) ) {
1846              $value = 'lazy';
1847          }
1848  
1849          // Images should have source and dimension attributes for the `loading` attribute to be added.
1850          if ( false === strpos( $image, ' src="' ) || false === strpos( $image, ' width="' ) || false === strpos( $image, ' height="' ) ) {
1851              return $image;
1852          }
1853  
1854          return str_replace( '<img', '<img loading="' . esc_attr( $value ) . '"', $image );
1855      }
1856  
1857      return $image;
1858  }
1859  
1860  /**
1861   * Adds `width` and `height` attributes to an `img` HTML tag.
1862   *
1863   * @since 5.5.0
1864   *
1865   * @param string $image         The HTML `img` tag where the attribute should be added.
1866   * @param string $context       Additional context to pass to the filters.
1867   * @param int    $attachment_id Image attachment ID.
1868   * @return string Converted 'img' element with 'width' and 'height' attributes added.
1869   */
1870  function wp_img_tag_add_width_and_height_attr( $image, $context, $attachment_id ) {
1871      $image_src         = preg_match( '/src="([^"]+)"/', $image, $match_src ) ? $match_src[1] : '';
1872      list( $image_src ) = explode( '?', $image_src );
1873  
1874      // Return early if we couldn't get the image source.
1875      if ( ! $image_src ) {
1876          return $image;
1877      }
1878  
1879      /**
1880       * Filters whether to add the missing `width` and `height` HTML attributes to the img tag. Default `true`.
1881       *
1882       * Returning anything else than `true` will not add the attributes.
1883       *
1884       * @since 5.5.0
1885       *
1886       * @param bool   $value         The filtered value, defaults to `true`.
1887       * @param string $image         The HTML `img` tag where the attribute should be added.
1888       * @param string $context       Additional context about how the function was called or where the img tag is.
1889       * @param int    $attachment_id The image attachment ID.
1890       */
1891      $add = apply_filters( 'wp_img_tag_add_width_and_height_attr', true, $image, $context, $attachment_id );
1892  
1893      if ( true === $add ) {
1894          $image_meta = wp_get_attachment_metadata( $attachment_id );
1895          $size_array = wp_image_src_get_dimensions( $image_src, $image_meta, $attachment_id );
1896  
1897          if ( $size_array ) {
1898              $hw = trim( image_hwstring( $size_array[0], $size_array[1] ) );
1899              return str_replace( '<img', "<img {$hw}", $image );
1900          }
1901      }
1902  
1903      return $image;
1904  }
1905  
1906  /**
1907   * Adds `srcset` and `sizes` attributes to an existing `img` HTML tag.
1908   *
1909   * @since 5.5.0
1910   *
1911   * @param string $image         The HTML `img` tag where the attribute should be added.
1912   * @param string $context       Additional context to pass to the filters.
1913   * @param int    $attachment_id Image attachment ID.
1914   * @return string Converted 'img' element with 'loading' attribute added.
1915   */
1916  function wp_img_tag_add_srcset_and_sizes_attr( $image, $context, $attachment_id ) {
1917      /**
1918       * Filters whether to add the `srcset` and `sizes` HTML attributes to the img tag. Default `true`.
1919       *
1920       * Returning anything else than `true` will not add the attributes.
1921       *
1922       * @since 5.5.0
1923       *
1924       * @param bool   $value         The filtered value, defaults to `true`.
1925       * @param string $image         The HTML `img` tag where the attribute should be added.
1926       * @param string $context       Additional context about how the function was called or where the img tag is.
1927       * @param int    $attachment_id The image attachment ID.
1928       */
1929      $add = apply_filters( 'wp_img_tag_add_srcset_and_sizes_attr', true, $image, $context, $attachment_id );
1930  
1931      if ( true === $add ) {
1932          $image_meta = wp_get_attachment_metadata( $attachment_id );
1933          return wp_image_add_srcset_and_sizes( $image, $image_meta, $attachment_id );
1934      }
1935  
1936      return $image;
1937  }
1938  
1939  /**
1940   * Adds a 'wp-post-image' class to post thumbnails. Internal use only.
1941   *
1942   * Uses the {@see 'begin_fetch_post_thumbnail_html'} and {@see 'end_fetch_post_thumbnail_html'}
1943   * action hooks to dynamically add/remove itself so as to only filter post thumbnails.
1944   *
1945   * @ignore
1946   * @since 2.9.0
1947   *
1948   * @param string[] $attr Array of thumbnail attributes including src, class, alt, title, keyed by attribute name.
1949   * @return string[] Modified array of attributes including the new 'wp-post-image' class.
1950   */
1951  function _wp_post_thumbnail_class_filter( $attr ) {
1952      $attr['class'] .= ' wp-post-image';
1953      return $attr;
1954  }
1955  
1956  /**
1957   * Adds '_wp_post_thumbnail_class_filter' callback to the 'wp_get_attachment_image_attributes'
1958   * filter hook. Internal use only.
1959   *
1960   * @ignore
1961   * @since 2.9.0
1962   *
1963   * @param string[] $attr Array of thumbnail attributes including src, class, alt, title, keyed by attribute name.
1964   */
1965  function _wp_post_thumbnail_class_filter_add( $attr ) {
1966      add_filter( 'wp_get_attachment_image_attributes', '_wp_post_thumbnail_class_filter' );
1967  }
1968  
1969  /**
1970   * Removes the '_wp_post_thumbnail_class_filter' callback from the 'wp_get_attachment_image_attributes'
1971   * filter hook. Internal use only.
1972   *
1973   * @ignore
1974   * @since 2.9.0
1975   *
1976   * @param string[] $attr Array of thumbnail attributes including src, class, alt, title, keyed by attribute name.
1977   */
1978  function _wp_post_thumbnail_class_filter_remove( $attr ) {
1979      remove_filter( 'wp_get_attachment_image_attributes', '_wp_post_thumbnail_class_filter' );
1980  }
1981  
1982  add_shortcode( 'wp_caption', 'img_caption_shortcode' );
1983  add_shortcode( 'caption', 'img_caption_shortcode' );
1984  
1985  /**
1986   * Builds the Caption shortcode output.
1987   *
1988   * Allows a plugin to replace the content that would otherwise be returned. The
1989   * filter is {@see 'img_caption_shortcode'} and passes an empty string, the attr
1990   * parameter and the content parameter values.
1991   *
1992   * The supported attributes for the shortcode are 'id', 'caption_id', 'align',
1993   * 'width', 'caption', and 'class'.
1994   *
1995   * @since 2.6.0
1996   * @since 3.9.0 The `class` attribute was added.
1997   * @since 5.1.0 The `caption_id` attribute was added.
1998   *
1999   * @param array  $attr {
2000   *     Attributes of the caption shortcode.
2001   *
2002   *     @type string $id         ID of the image and caption container element, i.e. `<figure>` or `<div>`.
2003   *     @type string $caption_id ID of the caption element, i.e. `<figcaption>` or `<p>`.
2004   *     @type string $align      Class name that aligns the caption. Default 'alignnone'. Accepts 'alignleft',
2005   *                              'aligncenter', alignright', 'alignnone'.
2006   *     @type int    $width      The width of the caption, in pixels.
2007   *     @type string $caption    The caption text.
2008   *     @type string $class      Additional class name(s) added to the caption container.
2009   * }
2010   * @param string $content Shortcode content.
2011   * @return string HTML content to display the caption.
2012   */
2013  function img_caption_shortcode( $attr, $content = null ) {
2014      // New-style shortcode with the caption inside the shortcode with the link and image tags.
2015      if ( ! isset( $attr['caption'] ) ) {
2016          if ( preg_match( '#((?:<a [^>]+>\s*)?<img [^>]+>(?:\s*</a>)?)(.*)#is', $content, $matches ) ) {
2017              $content         = $matches[1];
2018              $attr['caption'] = trim( $matches[2] );
2019          }
2020      } elseif ( strpos( $attr['caption'], '<' ) !== false ) {
2021          $attr['caption'] = wp_kses( $attr['caption'], 'post' );
2022      }
2023  
2024      /**
2025       * Filters the default caption shortcode output.
2026       *
2027       * If the filtered output isn't empty, it will be used instead of generating
2028       * the default caption template.
2029       *
2030       * @since 2.6.0
2031       *
2032       * @see img_caption_shortcode()
2033       *
2034       * @param string $output  The caption output. Default empty.
2035       * @param array  $attr    Attributes of the caption shortcode.
2036       * @param string $content The image element, possibly wrapped in a hyperlink.
2037       */
2038      $output = apply_filters( 'img_caption_shortcode', '', $attr, $content );
2039  
2040      if ( ! empty( $output ) ) {
2041          return $output;
2042      }
2043  
2044      $atts = shortcode_atts(
2045          array(
2046              'id'         => '',
2047              'caption_id' => '',
2048              'align'      => 'alignnone',
2049              'width'      => '',
2050              'caption'    => '',
2051              'class'      => '',
2052          ),
2053          $attr,
2054          'caption'
2055      );
2056  
2057      $atts['width'] = (int) $atts['width'];
2058  
2059      if ( $atts['width'] < 1 || empty( $atts['caption'] ) ) {
2060          return $content;
2061      }
2062  
2063      $id          = '';
2064      $caption_id  = '';
2065      $describedby = '';
2066  
2067      if ( $atts['id'] ) {
2068          $atts['id'] = sanitize_html_class( $atts['id'] );
2069          $id         = 'id="' . esc_attr( $atts['id'] ) . '" ';
2070      }
2071  
2072      if ( $atts['caption_id'] ) {
2073          $atts['caption_id'] = sanitize_html_class( $atts['caption_id'] );
2074      } elseif ( $atts['id'] ) {
2075          $atts['caption_id'] = 'caption-' . str_replace( '_', '-', $atts['id'] );
2076      }
2077  
2078      if ( $atts['caption_id'] ) {
2079          $caption_id  = 'id="' . esc_attr( $atts['caption_id'] ) . '" ';
2080          $describedby = 'aria-describedby="' . esc_attr( $atts['caption_id'] ) . '" ';
2081      }
2082  
2083      $class = trim( 'wp-caption ' . $atts['align'] . ' ' . $atts['class'] );
2084  
2085      $html5 = current_theme_supports( 'html5', 'caption' );
2086      // HTML5 captions never added the extra 10px to the image width.
2087      $width = $html5 ? $atts['width'] : ( 10 + $atts['width'] );
2088  
2089      /**
2090       * Filters the width of an image's caption.
2091       *
2092       * By default, the caption is 10 pixels greater than the width of the image,
2093       * to prevent post content from running up against a floated image.
2094       *
2095       * @since 3.7.0
2096       *
2097       * @see img_caption_shortcode()
2098       *
2099       * @param int    $width    Width of the caption in pixels. To remove this inline style,
2100       *                         return zero.
2101       * @param array  $atts     Attributes of the caption shortcode.
2102       * @param string $content  The image element, possibly wrapped in a hyperlink.
2103       */
2104      $caption_width = apply_filters( 'img_caption_shortcode_width', $width, $atts, $content );
2105  
2106      $style = '';
2107  
2108      if ( $caption_width ) {
2109          $style = 'style="width: ' . (int) $caption_width . 'px" ';
2110      }
2111  
2112      if ( $html5 ) {
2113          $html = sprintf(
2114              '<figure %s%s%sclass="%s">%s%s</figure>',
2115              $id,
2116              $describedby,
2117              $style,
2118              esc_attr( $class ),
2119              do_shortcode( $content ),
2120              sprintf(
2121                  '<figcaption %sclass="wp-caption-text">%s</figcaption>',
2122                  $caption_id,
2123                  $atts['caption']
2124              )
2125          );
2126      } else {
2127          $html = sprintf(
2128              '<div %s%sclass="%s">%s%s</div>',
2129              $id,
2130              $style,
2131              esc_attr( $class ),
2132              str_replace( '<img ', '<img ' . $describedby, do_shortcode( $content ) ),
2133              sprintf(
2134                  '<p %sclass="wp-caption-text">%s</p>',
2135                  $caption_id,
2136                  $atts['caption']
2137              )
2138          );
2139      }
2140  
2141      return $html;
2142  }
2143  
2144  add_shortcode( 'gallery', 'gallery_shortcode' );
2145  
2146  /**
2147   * Builds the Gallery shortcode output.
2148   *
2149   * This implements the functionality of the Gallery Shortcode for displaying
2150   * WordPress images on a post.
2151   *
2152   * @since 2.5.0
2153   *
2154   * @param array $attr {
2155   *     Attributes of the gallery shortcode.
2156   *
2157   *     @type string       $order      Order of the images in the gallery. Default 'ASC'. Accepts 'ASC', 'DESC'.
2158   *     @type string       $orderby    The field to use when ordering the images. Default 'menu_order ID'.
2159   *                                    Accepts any valid SQL ORDERBY statement.
2160   *     @type int          $id         Post ID.
2161   *     @type string       $itemtag    HTML tag to use for each image in the gallery.
2162   *                                    Default 'dl', or 'figure' when the theme registers HTML5 gallery support.
2163   *     @type string       $icontag    HTML tag to use for each image's icon.
2164   *                                    Default 'dt', or 'div' when the theme registers HTML5 gallery support.
2165   *     @type string       $captiontag HTML tag to use for each image's caption.
2166   *                                    Default 'dd', or 'figcaption' when the theme registers HTML5 gallery support.
2167   *     @type int          $columns    Number of columns of images to display. Default 3.
2168   *     @type string|int[] $size       Size of the images to display. Accepts any registered image size name, or an array
2169   *                                    of width and height values in pixels (in that order). Default 'thumbnail'.
2170   *     @type string       $ids        A comma-separated list of IDs of attachments to display. Default empty.
2171   *     @type string       $include    A comma-separated list of IDs of attachments to include. Default empty.
2172   *     @type string       $exclude    A comma-separated list of IDs of attachments to exclude. Default empty.
2173   *     @type string       $link       What to link each image to. Default empty (links to the attachment page).
2174   *                                    Accepts 'file', 'none'.
2175   * }
2176   * @return string HTML content to display gallery.
2177   */
2178  function gallery_shortcode( $attr ) {
2179      $post = get_post();
2180  
2181      static $instance = 0;
2182      $instance++;
2183  
2184      if ( ! empty( $attr['ids'] ) ) {
2185          // 'ids' is explicitly ordered, unless you specify otherwise.
2186          if ( empty( $attr['orderby'] ) ) {
2187              $attr['orderby'] = 'post__in';
2188          }
2189          $attr['include'] = $attr['ids'];
2190      }
2191  
2192      /**
2193       * Filters the default gallery shortcode output.
2194       *
2195       * If the filtered output isn't empty, it will be used instead of generating
2196       * the default gallery template.
2197       *
2198       * @since 2.5.0
2199       * @since 4.2.0 The `$instance` parameter was added.
2200       *
2201       * @see gallery_shortcode()
2202       *
2203       * @param string $output   The gallery output. Default empty.
2204       * @param array  $attr     Attributes of the gallery shortcode.
2205       * @param int    $instance Unique numeric ID of this gallery shortcode instance.
2206       */
2207      $output = apply_filters( 'post_gallery', '', $attr, $instance );
2208  
2209      if ( ! empty( $output ) ) {
2210          return $output;
2211      }
2212  
2213      $html5 = current_theme_supports( 'html5', 'gallery' );
2214      $atts  = shortcode_atts(
2215          array(
2216              'order'      => 'ASC',
2217              'orderby'    => 'menu_order ID',
2218              'id'         => $post ? $post->ID : 0,
2219              'itemtag'    => $html5 ? 'figure' : 'dl',
2220              'icontag'    => $html5 ? 'div' : 'dt',
2221              'captiontag' => $html5 ? 'figcaption' : 'dd',
2222              'columns'    => 3,
2223              'size'       => 'thumbnail',
2224              'include'    => '',
2225              'exclude'    => '',
2226              'link'       => '',
2227          ),
2228          $attr,
2229          'gallery'
2230      );
2231  
2232      $id = (int) $atts['id'];
2233  
2234      if ( ! empty( $atts['include'] ) ) {
2235          $_attachments = get_posts(
2236              array(
2237                  'include'        => $atts['include'],
2238                  'post_status'    => 'inherit',
2239                  'post_type'      => 'attachment',
2240                  'post_mime_type' => 'image',
2241                  'order'          => $atts['order'],
2242                  'orderby'        => $atts['orderby'],
2243              )
2244          );
2245  
2246          $attachments = array();
2247          foreach ( $_attachments as $key => $val ) {
2248              $attachments[ $val->ID ] = $_attachments[ $key ];
2249          }
2250      } elseif ( ! empty( $atts['exclude'] ) ) {
2251          $attachments = get_children(
2252              array(
2253                  'post_parent'    => $id,
2254                  'exclude'        => $atts['exclude'],
2255                  'post_status'    => 'inherit',
2256                  'post_type'      => 'attachment',
2257                  'post_mime_type' => 'image',
2258                  'order'          => $atts['order'],
2259                  'orderby'        => $atts['orderby'],
2260              )
2261          );
2262      } else {
2263          $attachments = get_children(
2264              array(
2265                  'post_parent'    => $id,
2266                  'post_status'    => 'inherit',
2267                  'post_type'      => 'attachment',
2268                  'post_mime_type' => 'image',
2269                  'order'          => $atts['order'],
2270                  'orderby'        => $atts['orderby'],
2271              )
2272          );
2273      }
2274  
2275      if ( empty( $attachments ) ) {
2276          return '';
2277      }
2278  
2279      if ( is_feed() ) {
2280          $output = "\n";
2281          foreach ( $attachments as $att_id => $attachment ) {
2282              if ( ! empty( $atts['link'] ) ) {
2283                  if ( 'none' === $atts['link'] ) {
2284                      $output .= wp_get_attachment_image( $att_id, $atts['size'], false, $attr );
2285                  } else {
2286                      $output .= wp_get_attachment_link( $att_id, $atts['size'], false );
2287                  }
2288              } else {
2289                  $output .= wp_get_attachment_link( $att_id, $atts['size'], true );
2290              }
2291              $output .= "\n";
2292          }
2293          return $output;
2294      }
2295  
2296      $itemtag    = tag_escape( $atts['itemtag'] );
2297      $captiontag = tag_escape( $atts['captiontag'] );
2298      $icontag    = tag_escape( $atts['icontag'] );
2299      $valid_tags = wp_kses_allowed_html( 'post' );
2300      if ( ! isset( $valid_tags[ $itemtag ] ) ) {
2301          $itemtag = 'dl';
2302      }
2303      if ( ! isset( $valid_tags[ $captiontag ] ) ) {
2304          $captiontag = 'dd';
2305      }
2306      if ( ! isset( $valid_tags[ $icontag ] ) ) {
2307          $icontag = 'dt';
2308      }
2309  
2310      $columns   = (int) $atts['columns'];
2311      $itemwidth = $columns > 0 ? floor( 100 / $columns ) : 100;
2312      $float     = is_rtl() ? 'right' : 'left';
2313  
2314      $selector = "gallery-{$instance}";
2315  
2316      $gallery_style = '';
2317  
2318      /**
2319       * Filters whether to print default gallery styles.
2320       *
2321       * @since 3.1.0
2322       *
2323       * @param bool $print Whether to print default gallery styles.
2324       *                    Defaults to false if the theme supports HTML5 galleries.
2325       *                    Otherwise, defaults to true.
2326       */
2327      if ( apply_filters( 'use_default_gallery_style', ! $html5 ) ) {
2328          $type_attr = current_theme_supports( 'html5', 'style' ) ? '' : ' type="text/css"';
2329  
2330          $gallery_style = "
2331          <style{$type_attr}>
2332              #{$selector} {
2333                  margin: auto;
2334              }
2335              #{$selector} .gallery-item {
2336                  float: {$float};
2337                  margin-top: 10px;
2338                  text-align: center;
2339                  width: {$itemwidth}%;
2340              }
2341              #{$selector} img {
2342                  border: 2px solid #cfcfcf;
2343              }
2344              #{$selector} .gallery-caption {
2345                  margin-left: 0;
2346              }
2347              /* see gallery_shortcode() in wp-includes/media.php */
2348          </style>\n\t\t";
2349      }
2350  
2351      $size_class  = sanitize_html_class( is_array( $atts['size'] ) ? implode( 'x', $atts['size'] ) : $atts['size'] );
2352      $gallery_div = "<div id='$selector' class='gallery galleryid-{$id} gallery-columns-{$columns} gallery-size-{$size_class}'>";
2353  
2354      /**
2355       * Filters the default gallery shortcode CSS styles.
2356       *
2357       * @since 2.5.0
2358       *
2359       * @param string $gallery_style Default CSS styles and opening HTML div container
2360       *                              for the gallery shortcode output.
2361       */
2362      $output = apply_filters( 'gallery_style', $gallery_style . $gallery_div );
2363  
2364      $i = 0;
2365  
2366      foreach ( $attachments as $id => $attachment ) {
2367  
2368          $attr = ( trim( $attachment->post_excerpt ) ) ? array( 'aria-describedby' => "$selector-$id" ) : '';
2369  
2370          if ( ! empty( $atts['link'] ) && 'file' === $atts['link'] ) {
2371              $image_output = wp_get_attachment_link( $id, $atts['size'], false, false, false, $attr );
2372          } elseif ( ! empty( $atts['link'] ) && 'none' === $atts['link'] ) {
2373              $image_output = wp_get_attachment_image( $id, $atts['size'], false, $attr );
2374          } else {
2375              $image_output = wp_get_attachment_link( $id, $atts['size'], true, false, false, $attr );
2376          }
2377  
2378          $image_meta = wp_get_attachment_metadata( $id );
2379  
2380          $orientation = '';
2381  
2382          if ( isset( $image_meta['height'], $image_meta['width'] ) ) {
2383              $orientation = ( $image_meta['height'] > $image_meta['width'] ) ? 'portrait' : 'landscape';
2384          }
2385  
2386          $output .= "<{$itemtag} class='gallery-item'>";
2387          $output .= "
2388              <{$icontag} class='gallery-icon {$orientation}'>
2389                  $image_output
2390              </{$icontag}>";
2391  
2392          if ( $captiontag && trim( $attachment->post_excerpt ) ) {
2393              $output .= "
2394                  <{$captiontag} class='wp-caption-text gallery-caption' id='$selector-$id'>
2395                  " . wptexturize( $attachment->post_excerpt ) . "
2396                  </{$captiontag}>";
2397          }
2398  
2399          $output .= "</{$itemtag}>";
2400  
2401          if ( ! $html5 && $columns > 0 && 0 === ++$i % $columns ) {
2402              $output .= '<br style="clear: both" />';
2403          }
2404      }
2405  
2406      if ( ! $html5 && $columns > 0 && 0 !== $i % $columns ) {
2407          $output .= "
2408              <br style='clear: both' />";
2409      }
2410  
2411      $output .= "
2412          </div>\n";
2413  
2414      return $output;
2415  }
2416  
2417  /**
2418   * Outputs the templates used by playlists.
2419   *
2420   * @since 3.9.0
2421   */
2422  function wp_underscore_playlist_templates() {
2423      ?>
2424  <script type="text/html" id="tmpl-wp-playlist-current-item">
2425      <# if ( data.thumb && data.thumb.src ) { #>
2426          <img src="{{ data.thumb.src }}" alt="" />
2427      <# } #>
2428      <div class="wp-playlist-caption">
2429          <span class="wp-playlist-item-meta wp-playlist-item-title">
2430          <?php
2431              /* translators: %s: Playlist item title. */
2432              printf( _x( '&#8220;%s&#8221;', 'playlist item title' ), '{{ data.title }}' );
2433          ?>
2434          </span>
2435          <# if ( data.meta.album ) { #><span class="wp-playlist-item-meta wp-playlist-item-album">{{ data.meta.album }}</span><# } #>
2436          <# if ( data.meta.artist ) { #><span class="wp-playlist-item-meta wp-playlist-item-artist">{{ data.meta.artist }}</span><# } #>
2437      </div>
2438  </script>
2439  <script type="text/html" id="tmpl-wp-playlist-item">
2440      <div class="wp-playlist-item">
2441          <a class="wp-playlist-caption" href="{{ data.src }}">
2442              {{ data.index ? ( data.index + '. ' ) : '' }}
2443              <# if ( data.caption ) { #>
2444                  {{ data.caption }}
2445              <# } else { #>
2446                  <span class="wp-playlist-item-title">
2447                  <?php
2448                      /* translators: %s: Playlist item title. */
2449                      printf( _x( '&#8220;%s&#8221;', 'playlist item title' ), '{{{ data.title }}}' );
2450                  ?>
2451                  </span>
2452                  <# if ( data.artists && data.meta.artist ) { #>
2453                  <span class="wp-playlist-item-artist"> &mdash; {{ data.meta.artist }}</span>
2454                  <# } #>
2455              <# } #>
2456          </a>
2457          <# if ( data.meta.length_formatted ) { #>
2458          <div class="wp-playlist-item-length">{{ data.meta.length_formatted }}</div>
2459          <# } #>
2460      </div>
2461  </script>
2462      <?php
2463  }
2464  
2465  /**
2466   * Outputs and enqueue default scripts and styles for playlists.
2467   *
2468   * @since 3.9.0
2469   *
2470   * @param string $type Type of playlist. Accepts 'audio' or 'video'.
2471   */
2472  function wp_playlist_scripts( $type ) {
2473      wp_enqueue_style( 'wp-mediaelement' );
2474      wp_enqueue_script( 'wp-playlist' );
2475      ?>
2476  <!--[if lt IE 9]><script>document.createElement('<?php echo esc_js( $type ); ?>');</script><![endif]-->
2477      <?php
2478      add_action( 'wp_footer', 'wp_underscore_playlist_templates', 0 );
2479      add_action( 'admin_footer', 'wp_underscore_playlist_templates', 0 );
2480  }
2481  
2482  /**
2483   * Builds the Playlist shortcode output.
2484   *
2485   * This implements the functionality of the playlist shortcode for displaying
2486   * a collection of WordPress audio or video files in a post.
2487   *
2488   * @since 3.9.0
2489   *
2490   * @global int $content_width
2491   *
2492   * @param array $attr {
2493   *     Array of default playlist attributes.
2494   *
2495   *     @type string  $type         Type of playlist to display. Accepts 'audio' or 'video'. Default 'audio'.
2496   *     @type string  $order        Designates ascending or descending order of items in the playlist.
2497   *                                 Accepts 'ASC', 'DESC'. Default 'ASC'.
2498   *     @type string  $orderby      Any column, or columns, to sort the playlist. If $ids are
2499   *                                 passed, this defaults to the order of the $ids array ('post__in').
2500   *                                 Otherwise default is 'menu_order ID'.
2501   *     @type int     $id           If an explicit $ids array is not present, this parameter
2502   *                                 will determine which attachments are used for the playlist.
2503   *                                 Default is the current post ID.
2504   *     @type array   $ids          Create a playlist out of these explicit attachment IDs. If empty,
2505   *                                 a playlist will be created from all $type attachments of $id.
2506   *                                 Default empty.
2507   *     @type array   $exclude      List of specific attachment IDs to exclude from the playlist. Default empty.
2508   *     @type string  $style        Playlist style to use. Accepts 'light' or 'dark'. Default 'light'.
2509   *     @type bool    $tracklist    Whether to show or hide the playlist. Default true.
2510   *     @type bool    $tracknumbers Whether to show or hide the numbers next to entries in the playlist. Default true.
2511   *     @type bool    $images       Show or hide the video or audio thumbnail (Featured Image/post
2512   *                                 thumbnail). Default true.
2513   *     @type bool    $artists      Whether to show or hide artist name in the playlist. Default true.
2514   * }
2515   *
2516   * @return string Playlist output. Empty string if the passed type is unsupported.
2517   */
2518  function wp_playlist_shortcode( $attr ) {
2519      global $content_width;
2520      $post = get_post();
2521  
2522      static $instance = 0;
2523      $instance++;
2524  
2525      if ( ! empty( $attr['ids'] ) ) {
2526          // 'ids' is explicitly ordered, unless you specify otherwise.
2527          if ( empty( $attr['orderby'] ) ) {
2528              $attr['orderby'] = 'post__in';
2529          }
2530          $attr['include'] = $attr['ids'];
2531      }
2532  
2533      /**
2534       * Filters the playlist output.
2535       *
2536       * Returning a non-empty value from the filter will short-circuit generation
2537       * of the default playlist output, returning the passed value instead.
2538       *
2539       * @since 3.9.0
2540       * @since 4.2.0 The `$instance` parameter was added.
2541       *
2542       * @param string $output   Playlist output. Default empty.
2543       * @param array  $attr     An array of shortcode attributes.
2544       * @param int    $instance Unique numeric ID of this playlist shortcode instance.
2545       */
2546      $output = apply_filters( 'post_playlist', '', $attr, $instance );
2547  
2548      if ( ! empty( $output ) ) {
2549          return $output;
2550      }
2551  
2552      $atts = shortcode_atts(
2553          array(
2554              'type'         => 'audio',
2555              'order'        => 'ASC',
2556              'orderby'      => 'menu_order ID',
2557              'id'           => $post ? $post->ID : 0,
2558              'include'      => '',
2559              'exclude'      => '',
2560              'style'        => 'light',
2561              'tracklist'    => true,
2562              'tracknumbers' => true,
2563              'images'       => true,
2564              'artists'      => true,
2565          ),
2566          $attr,
2567          'playlist'
2568      );
2569  
2570      $id = (int) $atts['id'];
2571  
2572      if ( 'audio' !== $atts['type'] ) {
2573          $atts['type'] = 'video';
2574      }
2575  
2576      $args = array(
2577          'post_status'    => 'inherit',
2578          'post_type'      => 'attachment',
2579          'post_mime_type' => $atts['type'],
2580          'order'          => $atts['order'],
2581          'orderby'        => $atts['orderby'],
2582      );
2583  
2584      if ( ! empty( $atts['include'] ) ) {
2585          $args['include'] = $atts['include'];
2586          $_attachments    = get_posts( $args );
2587  
2588          $attachments = array();
2589          foreach ( $_attachments as $key => $val ) {
2590              $attachments[ $val->ID ] = $_attachments[ $key ];
2591          }
2592      } elseif ( ! empty( $atts['exclude'] ) ) {
2593          $args['post_parent'] = $id;
2594          $args['exclude']     = $atts['exclude'];
2595          $attachments         = get_children( $args );
2596      } else {
2597          $args['post_parent'] = $id;
2598          $attachments         = get_children( $args );
2599      }
2600  
2601      if ( empty( $attachments ) ) {
2602          return '';
2603      }
2604  
2605      if ( is_feed() ) {
2606          $output = "\n";
2607          foreach ( $attachments as $att_id => $attachment ) {
2608              $output .= wp_get_attachment_link( $att_id ) . "\n";
2609          }
2610          return $output;
2611      }
2612  
2613      $outer = 22; // Default padding and border of wrapper.
2614  
2615      $default_width  = 640;
2616      $default_height = 360;
2617  
2618      $theme_width  = empty( $content_width ) ? $default_width : ( $content_width - $outer );
2619      $theme_height = empty( $content_width ) ? $default_height : round( ( $default_height * $theme_width ) / $default_width );
2620  
2621      $data = array(
2622          'type'         => $atts['type'],
2623          // Don't pass strings to JSON, will be truthy in JS.
2624          'tracklist'    => wp_validate_boolean( $atts['tracklist'] ),
2625          'tracknumbers' => wp_validate_boolean( $atts['tracknumbers'] ),
2626          'images'       => wp_validate_boolean( $atts['images'] ),
2627          'artists'      => wp_validate_boolean( $atts['artists'] ),
2628      );
2629  
2630      $tracks = array();
2631      foreach ( $attachments as $attachment ) {
2632          $url   = wp_get_attachment_url( $attachment->ID );
2633          $ftype = wp_check_filetype( $url, wp_get_mime_types() );
2634          $track = array(
2635              'src'         => $url,
2636              'type'        => $ftype['type'],
2637              'title'       => $attachment->post_title,
2638              'caption'     => $attachment->post_excerpt,
2639              'description' => $attachment->post_content,
2640          );
2641  
2642          $track['meta'] = array();
2643          $meta          = wp_get_attachment_metadata( $attachment->ID );
2644          if ( ! empty( $meta ) ) {
2645  
2646              foreach ( wp_get_attachment_id3_keys( $attachment ) as $key => $label ) {
2647                  if ( ! empty( $meta[ $key ] ) ) {
2648                      $track['meta'][ $key ] = $meta[ $key ];
2649                  }
2650              }
2651  
2652              if ( 'video' === $atts['type'] ) {
2653                  if ( ! empty( $meta['width'] ) && ! empty( $meta['height'] ) ) {
2654                      $width        = $meta['width'];
2655                      $height       = $meta['height'];
2656                      $theme_height = round( ( $height * $theme_width ) / $width );
2657                  } else {
2658                      $width  = $default_width;
2659                      $height = $default_height;
2660                  }
2661  
2662                  $track['dimensions'] = array(
2663                      'original' => compact( 'width', 'height' ),
2664                      'resized'  => array(
2665                          'width'  => $theme_width,
2666                          'height' => $theme_height,
2667                      ),
2668                  );
2669              }
2670          }
2671  
2672          if ( $atts['images'] ) {
2673              $thumb_id = get_post_thumbnail_id( $attachment->ID );
2674              if ( ! empty( $thumb_id ) ) {
2675                  list( $src, $width, $height ) = wp_get_attachment_image_src( $thumb_id, 'full' );
2676                  $track['image']               = compact( 'src', 'width', 'height' );
2677                  list( $src, $width, $height ) = wp_get_attachment_image_src( $thumb_id, 'thumbnail' );
2678                  $track['thumb']               = compact( 'src', 'width', 'height' );
2679              } else {
2680                  $src            = wp_mime_type_icon( $attachment->ID );
2681                  $width          = 48;
2682                  $height         = 64;
2683                  $track['image'] = compact( 'src', 'width', 'height' );
2684                  $track['thumb'] = compact( 'src', 'width', 'height' );
2685              }
2686          }
2687  
2688          $tracks[] = $track;
2689      }
2690      $data['tracks'] = $tracks;
2691  
2692      $safe_type  = esc_attr( $atts['type'] );
2693      $safe_style = esc_attr( $atts['style'] );
2694  
2695      ob_start();
2696  
2697      if ( 1 === $instance ) {
2698          /**
2699           * Prints and enqueues playlist scripts, styles, and JavaScript templates.
2700           *
2701           * @since 3.9.0
2702           *
2703           * @param string $type  Type of playlist. Possible values are 'audio' or 'video'.
2704           * @param string $style The 'theme' for the playlist. Core provides 'light' and 'dark'.
2705           */
2706          do_action( 'wp_playlist_scripts', $atts['type'], $atts['style'] );
2707      }
2708      ?>
2709  <div class="wp-playlist wp-<?php echo $safe_type; ?>-playlist wp-playlist-<?php echo $safe_style; ?>">
2710      <?php if ( 'audio' === $atts['type'] ) : ?>
2711          <div class="wp-playlist-current-item"></div>
2712      <?php endif ?>
2713      <<?php echo $safe_type; ?> controls="controls" preload="none" width="<?php echo (int) $theme_width; ?>"
2714          <?php
2715          if ( 'video' === $safe_type ) {
2716              echo ' height="', (int) $theme_height, '"';
2717          }
2718          ?>
2719      ></<?php echo $safe_type; ?>>
2720      <div class="wp-playlist-next"></div>
2721      <div class="wp-playlist-prev"></div>
2722      <noscript>
2723      <ol>
2724          <?php
2725          foreach ( $attachments as $att_id => $attachment ) {
2726              printf( '<li>%s</li>', wp_get_attachment_link( $att_id ) );
2727          }
2728          ?>
2729      </ol>
2730      </noscript>
2731      <script type="application/json" class="wp-playlist-script"><?php echo wp_json_encode( $data ); ?></script>
2732  </div>
2733      <?php
2734      return ob_get_clean();
2735  }
2736  add_shortcode( 'playlist', 'wp_playlist_shortcode' );
2737  
2738  /**
2739   * Provides a No-JS Flash fallback as a last resort for audio / video.
2740   *
2741   * @since 3.6.0
2742   *
2743   * @param string $url The media element URL.
2744   * @return string Fallback HTML.
2745   */
2746  function wp_mediaelement_fallback( $url ) {
2747      /**
2748       * Filters the Mediaelement fallback output for no-JS.
2749       *
2750       * @since 3.6.0
2751       *
2752       * @param string $output Fallback output for no-JS.
2753       * @param string $url    Media file URL.
2754       */
2755      return apply_filters( 'wp_mediaelement_fallback', sprintf( '<a href="%1$s">%1$s</a>', esc_url( $url ) ), $url );
2756  }
2757  
2758  /**
2759   * Returns a filtered list of supported audio formats.
2760   *
2761   * @since 3.6.0
2762   *
2763   * @return string[] Supported audio formats.
2764   */
2765  function wp_get_audio_extensions() {
2766      /**
2767       * Filters the list of supported audio formats.
2768       *
2769       * @since 3.6.0
2770       *
2771       * @param string[] $extensions An array of supported audio formats. Defaults are
2772       *                            'mp3', 'ogg', 'flac', 'm4a', 'wav'.
2773       */
2774      return apply_filters( 'wp_audio_extensions', array( 'mp3', 'ogg', 'flac', 'm4a', 'wav' ) );
2775  }
2776  
2777  /**
2778   * Returns useful keys to use to lookup data from an attachment's stored metadata.
2779   *
2780   * @since 3.9.0
2781   *
2782   * @param WP_Post $attachment The current attachment, provided for context.
2783   * @param string  $context    Optional. The context. Accepts 'edit', 'display'. Default 'display'.
2784   * @return string[] Key/value pairs of field keys to labels.
2785   */
2786  function wp_get_attachment_id3_keys( $attachment, $context = 'display' ) {
2787      $fields = array(
2788          'artist' => __( 'Artist' ),
2789          'album'  => __( 'Album' ),
2790      );
2791  
2792      if ( 'display' === $context ) {
2793          $fields['genre']            = __( 'Genre' );
2794          $fields['year']             = __( 'Year' );
2795          $fields['length_formatted'] = _x( 'Length', 'video or audio' );
2796      } elseif ( 'js' === $context ) {
2797          $fields['bitrate']      = __( 'Bitrate' );
2798          $fields['bitrate_mode'] = __( 'Bitrate Mode' );
2799      }
2800  
2801      /**
2802       * Filters the editable list of keys to look up data from an attachment's metadata.
2803       *
2804       * @since 3.9.0
2805       *
2806       * @param array   $fields     Key/value pairs of field keys to labels.
2807       * @param WP_Post $attachment Attachment object.
2808       * @param string  $context    The context. Accepts 'edit', 'display'. Default 'display'.
2809       */
2810      return apply_filters( 'wp_get_attachment_id3_keys', $fields, $attachment, $context );
2811  }
2812  /**
2813   * Builds the Audio shortcode output.
2814   *
2815   * This implements the functionality of the Audio Shortcode for displaying
2816   * WordPress mp3s in a post.
2817   *
2818   * @since 3.6.0
2819   *
2820   * @param array  $attr {
2821   *     Attributes of the audio shortcode.
2822   *
2823   *     @type string $src      URL to the source of the audio file. Default empty.
2824   *     @type string $loop     The 'loop' attribute for the `<audio>` element. Default empty.
2825   *     @type string $autoplay The 'autoplay' attribute for the `<audio>` element. Default empty.
2826   *     @type string $preload  The 'preload' attribute for the `<audio>` element. Default 'none'.
2827   *     @type string $class    The 'class' attribute for the `<audio>` element. Default 'wp-audio-shortcode'.
2828   *     @type string $style    The 'style' attribute for the `<audio>` element. Default 'width: 100%;'.
2829   * }
2830   * @param string $content Shortcode content.
2831   * @return string|void HTML content to display audio.
2832   */
2833  function wp_audio_shortcode( $attr, $content = '' ) {
2834      $post_id = get_post() ? get_the_ID() : 0;
2835  
2836      static $instance = 0;
2837      $instance++;
2838  
2839      /**
2840       * Filters the default audio shortcode output.
2841       *
2842       * If the filtered output isn't empty, it will be used instead of generating the default audio template.
2843       *
2844       * @since 3.6.0
2845       *
2846       * @param string $html     Empty variable to be replaced with shortcode markup.
2847       * @param array  $attr     Attributes of the shortcode. @see wp_audio_shortcode()
2848       * @param string $content  Shortcode content.
2849       * @param int    $instance Unique numeric ID of this audio shortcode instance.
2850       */
2851      $override = apply_filters( 'wp_audio_shortcode_override', '', $attr, $content, $instance );
2852  
2853      if ( '' !== $override ) {
2854          return $override;
2855      }
2856  
2857      $audio = null;
2858  
2859      $default_types = wp_get_audio_extensions();
2860      $defaults_atts = array(
2861          'src'      => '',
2862          'loop'     => '',
2863          'autoplay' => '',
2864          'preload'  => 'none',
2865          'class'    => 'wp-audio-shortcode',
2866          'style'    => 'width: 100%;',
2867      );
2868      foreach ( $default_types as $type ) {
2869          $defaults_atts[ $type ] = '';
2870      }
2871  
2872      $atts = shortcode_atts( $defaults_atts, $attr, 'audio' );
2873  
2874      $primary = false;
2875      if ( ! empty( $atts['src'] ) ) {
2876          $type = wp_check_filetype( $atts['src'], wp_get_mime_types() );
2877  
2878          if ( ! in_array( strtolower( $type['ext'] ), $default_types, true ) ) {
2879              return sprintf( '<a class="wp-embedded-audio" href="%s">%s</a>', esc_url( $atts['src'] ), esc_html( $atts['src'] ) );
2880          }
2881  
2882          $primary = true;
2883          array_unshift( $default_types, 'src' );
2884      } else {
2885          foreach ( $default_types as $ext ) {
2886              if ( ! empty( $atts[ $ext ] ) ) {
2887                  $type = wp_check_filetype( $atts[ $ext ], wp_get_mime_types() );
2888  
2889                  if ( strtolower( $type['ext'] ) === $ext ) {
2890                      $primary = true;
2891                  }
2892              }
2893          }
2894      }
2895  
2896      if ( ! $primary ) {
2897          $audios = get_attached_media( 'audio', $post_id );
2898  
2899          if ( empty( $audios ) ) {
2900              return;
2901          }
2902  
2903          $audio       = reset( $audios );
2904          $atts['src'] = wp_get_attachment_url( $audio->ID );
2905  
2906          if ( empty( $atts['src'] ) ) {
2907              return;
2908          }
2909  
2910          array_unshift( $default_types, 'src' );
2911      }
2912  
2913      /**
2914       * Filters the media library used for the audio shortcode.
2915       *
2916       * @since 3.6.0
2917       *
2918       * @param string $library Media library used for the audio shortcode.
2919       */
2920      $library = apply_filters( 'wp_audio_shortcode_library', 'mediaelement' );
2921  
2922      if ( 'mediaelement' === $library && did_action( 'init' ) ) {
2923          wp_enqueue_style( 'wp-mediaelement' );
2924          wp_enqueue_script( 'wp-mediaelement' );
2925      }
2926  
2927      /**
2928       * Filters the class attribute for the audio shortcode output container.
2929       *
2930       * @since 3.6.0
2931       * @since 4.9.0 The `$atts` parameter was added.
2932       *
2933       * @param string $class CSS class or list of space-separated classes.
2934       * @param array  $atts  Array of audio shortcode attributes.
2935       */
2936      $atts['class'] = apply_filters( 'wp_audio_shortcode_class', $atts['class'], $atts );
2937  
2938      $html_atts = array(
2939          'class'    => $atts['class'],
2940          'id'       => sprintf( 'audio-%d-%d', $post_id, $instance ),
2941          'loop'     => wp_validate_boolean( $atts['loop'] ),
2942          'autoplay' => wp_validate_boolean( $atts['autoplay'] ),
2943          'preload'  => $atts['preload'],
2944          'style'    => $atts['style'],
2945      );
2946  
2947      // These ones should just be omitted altogether if they are blank.
2948      foreach ( array( 'loop', 'autoplay', 'preload' ) as $a ) {
2949          if ( empty( $html_atts[ $a ] ) ) {
2950              unset( $html_atts[ $a ] );
2951          }
2952      }
2953  
2954      $attr_strings = array();
2955  
2956      foreach ( $html_atts as $k => $v ) {
2957          $attr_strings[] = $k . '="' . esc_attr( $v ) . '"';
2958      }
2959  
2960      $html = '';
2961  
2962      if ( 'mediaelement' === $library && 1 === $instance ) {
2963          $html .= "<!--[if lt IE 9]><script>document.createElement('audio');</script><![endif]-->\n";
2964      }
2965  
2966      $html .= sprintf( '<audio %s controls="controls">', implode( ' ', $attr_strings ) );
2967  
2968      $fileurl = '';
2969      $source  = '<source type="%s" src="%s" />';
2970  
2971      foreach ( $default_types as $fallback ) {
2972          if ( ! empty( $atts[ $fallback ] ) ) {
2973              if ( empty( $fileurl ) ) {
2974                  $fileurl = $atts[ $fallback ];
2975              }
2976  
2977              $type  = wp_check_filetype( $atts[ $fallback ], wp_get_mime_types() );
2978              $url   = add_query_arg( '_', $instance, $atts[ $fallback ] );
2979              $html .= sprintf( $source, $type['type'], esc_url( $url ) );
2980          }
2981      }
2982  
2983      if ( 'mediaelement' === $library ) {
2984          $html .= wp_mediaelement_fallback( $fileurl );
2985      }
2986  
2987      $html .= '</audio>';
2988  
2989      /**
2990       * Filters the audio shortcode output.
2991       *
2992       * @since 3.6.0
2993       *
2994       * @param string $html    Audio shortcode HTML output.
2995       * @param array  $atts    Array of audio shortcode attributes.
2996       * @param string $audio   Audio file.
2997       * @param int    $post_id Post ID.
2998       * @param string $library Media library used for the audio shortcode.
2999       */
3000      return apply_filters( 'wp_audio_shortcode', $html, $atts, $audio, $post_id, $library );
3001  }
3002  add_shortcode( 'audio', 'wp_audio_shortcode' );
3003  
3004  /**
3005   * Returns a filtered list of supported video formats.
3006   *
3007   * @since 3.6.0
3008   *
3009   * @return string[] List of supported video formats.
3010   */
3011  function wp_get_video_extensions() {
3012      /**
3013       * Filters the list of supported video formats.
3014       *
3015       * @since 3.6.0
3016       *
3017       * @param string[] $extensions An array of supported video formats. Defaults are
3018       *                             'mp4', 'm4v', 'webm', 'ogv', 'flv'.
3019       */
3020      return apply_filters( 'wp_video_extensions', array( 'mp4', 'm4v', 'webm', 'ogv', 'flv' ) );
3021  }
3022  
3023  /**
3024   * Builds the Video shortcode output.
3025   *
3026   * This implements the functionality of the Video Shortcode for displaying
3027   * WordPress mp4s in a post.
3028   *
3029   * @since 3.6.0
3030   *
3031   * @global int $content_width
3032   *
3033   * @param array  $attr {
3034   *     Attributes of the shortcode.
3035   *
3036   *     @type string $src      URL to the source of the video file. Default empty.
3037   *     @type int    $height   Height of the video embed in pixels. Default 360.
3038   *     @type int    $width    Width of the video embed in pixels. Default $content_width or 640.
3039   *     @type string $poster   The 'poster' attribute for the `<video>` element. Default empty.
3040   *     @type string $loop     The 'loop' attribute for the `<video>` element. Default empty.
3041   *     @type string $autoplay The 'autoplay' attribute for the `<video>` element. Default empty.
3042   *     @type string $preload  The 'preload' attribute for the `<video>` element.
3043   *                            Default 'metadata'.
3044   *     @type string $class    The 'class' attribute for the `<video>` element.
3045   *                            Default 'wp-video-shortcode'.
3046   * }
3047   * @param string $content Shortcode content.
3048   * @return string|void HTML content to display video.
3049   */
3050  function wp_video_shortcode( $attr, $content = '' ) {
3051      global $content_width;
3052      $post_id = get_post() ? get_the_ID() : 0;
3053  
3054      static $instance = 0;
3055      $instance++;
3056  
3057      /**
3058       * Filters the default video shortcode output.
3059       *
3060       * If the filtered output isn't empty, it will be used instead of generating
3061       * the default video template.
3062       *
3063       * @since 3.6.0
3064       *
3065       * @see wp_video_shortcode()
3066       *
3067       * @param string $html     Empty variable to be replaced with shortcode markup.
3068       * @param array  $attr     Attributes of the shortcode. @see wp_video_shortcode()
3069       * @param string $content  Video shortcode content.
3070       * @param int    $instance Unique numeric ID of this video shortcode instance.
3071       */
3072      $override = apply_filters( 'wp_video_shortcode_override', '', $attr, $content, $instance );
3073  
3074      if ( '' !== $override ) {
3075          return $override;
3076      }
3077  
3078      $video = null;
3079  
3080      $default_types = wp_get_video_extensions();
3081      $defaults_atts = array(
3082          'src'      => '',
3083          'poster'   => '',
3084          'loop'     => '',
3085          'autoplay' => '',
3086          'preload'  => 'metadata',
3087          'width'    => 640,
3088          'height'   => 360,
3089          'class'    => 'wp-video-shortcode',
3090      );
3091  
3092      foreach ( $default_types as $type ) {
3093          $defaults_atts[ $type ] = '';
3094      }
3095  
3096      $atts = shortcode_atts( $defaults_atts, $attr, 'video' );
3097  
3098      if ( is_admin() ) {
3099          // Shrink the video so it isn't huge in the admin.
3100          if ( $atts['width'] > $defaults_atts['width'] ) {
3101              $atts['height'] = round( ( $atts['height'] * $defaults_atts['width'] ) / $atts['width'] );
3102              $atts['width']  = $defaults_atts['width'];
3103          }
3104      } else {
3105          // If the video is bigger than the theme.
3106          if ( ! empty( $content_width ) && $atts['width'] > $content_width ) {
3107              $atts['height'] = round( ( $atts['height'] * $content_width ) / $atts['width'] );
3108              $atts['width']  = $content_width;
3109          }
3110      }
3111  
3112      $is_vimeo      = false;
3113      $is_youtube    = false;
3114      $yt_pattern    = '#^https?://(?:www\.)?(?:youtube\.com/watch|youtu\.be/)#';
3115      $vimeo_pattern = '#^https?://(.+\.)?vimeo\.com/.*#';
3116  
3117      $primary = false;
3118      if ( ! empty( $atts['src'] ) ) {
3119          $is_vimeo   = ( preg_match( $vimeo_pattern, $atts['src'] ) );
3120          $is_youtube = ( preg_match( $yt_pattern, $atts['src'] ) );
3121  
3122          if ( ! $is_youtube && ! $is_vimeo ) {
3123              $type = wp_check_filetype( $atts['src'], wp_get_mime_types() );
3124  
3125              if ( ! in_array( strtolower( $type['ext'] ), $default_types, true ) ) {
3126                  return sprintf( '<a class="wp-embedded-video" href="%s">%s</a>', esc_url( $atts['src'] ), esc_html( $atts['src'] ) );
3127              }
3128          }
3129  
3130          if ( $is_vimeo ) {
3131              wp_enqueue_script( 'mediaelement-vimeo' );
3132          }
3133  
3134          $primary = true;
3135          array_unshift( $default_types, 'src' );
3136      } else {
3137          foreach ( $default_types as $ext ) {
3138              if ( ! empty( $atts[ $ext ] ) ) {
3139                  $type = wp_check_filetype( $atts[ $ext ], wp_get_mime_types() );
3140                  if ( strtolower( $type['ext'] ) === $ext ) {
3141                      $primary = true;
3142                  }
3143              }
3144          }
3145      }
3146  
3147      if ( ! $primary ) {
3148          $videos = get_attached_media( 'video', $post_id );
3149          if ( empty( $videos ) ) {
3150              return;
3151          }
3152  
3153          $video       = reset( $videos );
3154          $atts['src'] = wp_get_attachment_url( $video->ID );
3155          if ( empty( $atts['src'] ) ) {
3156              return;
3157          }
3158  
3159          array_unshift( $default_types, 'src' );
3160      }
3161  
3162      /**
3163       * Filters the media library used for the video shortcode.
3164       *
3165       * @since 3.6.0
3166       *
3167       * @param string $library Media library used for the video shortcode.
3168       */
3169      $library = apply_filters( 'wp_video_shortcode_library', 'mediaelement' );
3170      if ( 'mediaelement' === $library && did_action( 'init' ) ) {
3171          wp_enqueue_style( 'wp-mediaelement' );
3172          wp_enqueue_script( 'wp-mediaelement' );
3173          wp_enqueue_script( 'mediaelement-vimeo' );
3174      }
3175  
3176      // MediaElement.js has issues with some URL formats for Vimeo and YouTube,
3177      // so update the URL to prevent the ME.js player from breaking.
3178      if ( 'mediaelement' === $library ) {
3179          if ( $is_youtube ) {
3180              // Remove `feature` query arg and force SSL - see #40866.
3181              $atts['src'] = remove_query_arg( 'feature', $atts['src'] );
3182              $atts['src'] = set_url_scheme( $atts['src'], 'https' );
3183          } elseif ( $is_vimeo ) {
3184              // Remove all query arguments and force SSL - see #40866.
3185              $parsed_vimeo_url = wp_parse_url( $atts['src'] );
3186              $vimeo_src        = 'https://' . $parsed_vimeo_url['host'] . $parsed_vimeo_url['path'];
3187  
3188              // Add loop param for mejs bug - see #40977, not needed after #39686.
3189              $loop        = $atts['loop'] ? '1' : '0';
3190              $atts['src'] = add_query_arg( 'loop', $loop, $vimeo_src );
3191          }
3192      }
3193  
3194      /**
3195       * Filters the class attribute for the video shortcode output container.
3196       *
3197       * @since 3.6.0
3198       * @since 4.9.0 The `$atts` parameter was added.
3199       *
3200       * @param string $class CSS class or list of space-separated classes.
3201       * @param array  $atts  Array of video shortcode attributes.
3202       */
3203      $atts['class'] = apply_filters( 'wp_video_shortcode_class', $atts['class'], $atts );
3204  
3205      $html_atts = array(
3206          'class'    => $atts['class'],
3207          'id'       => sprintf( 'video-%d-%d', $post_id, $instance ),
3208          'width'    => absint( $atts['width'] ),
3209          'height'   => absint( $atts['height'] ),
3210          'poster'   => esc_url( $atts['poster'] ),
3211          'loop'     => wp_validate_boolean( $atts['loop'] ),
3212          'autoplay' => wp_validate_boolean( $atts['autoplay'] ),
3213          'preload'  => $atts['preload'],
3214      );
3215  
3216      // These ones should just be omitted altogether if they are blank.
3217      foreach ( array( 'poster', 'loop', 'autoplay', 'preload' ) as $a ) {
3218          if ( empty( $html_atts[ $a ] ) ) {
3219              unset( $html_atts[ $a ] );
3220          }
3221      }
3222  
3223      $attr_strings = array();
3224      foreach ( $html_atts as $k => $v ) {
3225          $attr_strings[] = $k . '="' . esc_attr( $v ) . '"';
3226      }
3227  
3228      $html = '';
3229  
3230      if ( 'mediaelement' === $library && 1 === $instance ) {
3231          $html .= "<!--[if lt IE 9]><script>document.createElement('video');</script><![endif]-->\n";
3232      }
3233  
3234      $html .= sprintf( '<video %s controls="controls">', implode( ' ', $attr_strings ) );
3235  
3236      $fileurl = '';
3237      $source  = '<source type="%s" src="%s" />';
3238  
3239      foreach ( $default_types as $fallback ) {
3240          if ( ! empty( $atts[ $fallback ] ) ) {
3241              if ( empty( $fileurl ) ) {
3242                  $fileurl = $atts[ $fallback ];
3243              }
3244              if ( 'src' === $fallback && $is_youtube ) {
3245                  $type = array( 'type' => 'video/youtube' );
3246              } elseif ( 'src' === $fallback && $is_vimeo ) {
3247                  $type = array( 'type' => 'video/vimeo' );
3248              } else {
3249                  $type = wp_check_filetype( $atts[ $fallback ], wp_get_mime_types() );
3250              }
3251              $url   = add_query_arg( '_', $instance, $atts[ $fallback ] );
3252              $html .= sprintf( $source, $type['type'], esc_url( $url ) );
3253          }
3254      }
3255  
3256      if ( ! empty( $content ) ) {
3257          if ( false !== strpos( $content, "\n" ) ) {
3258              $content = str_replace( array( "\r\n", "\n", "\t" ), '', $content );
3259          }
3260          $html .= trim( $content );
3261      }
3262  
3263      if ( 'mediaelement' === $library ) {
3264          $html .= wp_mediaelement_fallback( $fileurl );
3265      }
3266      $html .= '</video>';
3267  
3268      $width_rule = '';
3269      if ( ! empty( $atts['width'] ) ) {
3270          $width_rule = sprintf( 'width: %dpx;', $atts['width'] );
3271      }
3272      $output = sprintf( '<div style="%s" class="wp-video">%s</div>', $width_rule, $html );
3273  
3274      /**
3275       * Filters the output of the video shortcode.
3276       *
3277       * @since 3.6.0
3278       *
3279       * @param string $output  Video shortcode HTML output.
3280       * @param array  $atts    Array of video shortcode attributes.
3281       * @param string $video   Video file.
3282       * @param int    $post_id Post ID.
3283       * @param string $library Media library used for the video shortcode.
3284       */
3285      return apply_filters( 'wp_video_shortcode', $output, $atts, $video, $post_id, $library );
3286  }
3287  add_shortcode( 'video', 'wp_video_shortcode' );
3288  
3289  /**
3290   * Displays previous image link that has the same post parent.
3291   *
3292   * @since 2.5.0
3293   *
3294   * @see adjacent_image_link()
3295   *
3296   * @param string|int[] $size Optional. Image size. Accepts any registered image size name, or an array
3297   *                           of width and height values in pixels (in that order). Default 'thumbnail'.
3298   * @param string       $text Optional. Link text. Default false.
3299   */
3300  function previous_image_link( $size = 'thumbnail', $text = false ) {
3301      adjacent_image_link( true, $size, $text );
3302  }
3303  
3304  /**
3305   * Displays next image link that has the same post parent.
3306   *
3307   * @since 2.5.0
3308   *
3309   * @see adjacent_image_link()
3310   *
3311   * @param string|int[] $size Optional. Image size. Accepts any registered image size name, or an array
3312   *                           of width and height values in pixels (in that order). Default 'thumbnail'.
3313   * @param string       $text Optional. Link text. Default false.
3314   */
3315  function next_image_link( $size = 'thumbnail', $text = false ) {
3316      adjacent_image_link( false, $size, $text );
3317  }
3318  
3319  /**
3320   * Displays next or previous image link that has the same post parent.
3321   *
3322   * Retrieves the current attachment object from the $post global.
3323   *
3324   * @since 2.5.0
3325   *
3326   * @param bool         $prev Optional. Whether to display the next (false) or previous (true) link. Default true.
3327   * @param string|int[] $size Optional. Image size. Accepts any registered image size name, or an array
3328   *                           of width and height values in pixels (in that order). Default 'thumbnail'.
3329   * @param bool         $text Optional. Link text. Default false.
3330   */
3331  function adjacent_image_link( $prev = true, $size = 'thumbnail', $text = false ) {
3332      $post        = get_post();
3333      $attachments = array_values(
3334          get_children(
3335              array(
3336                  'post_parent'    => $post->post_parent,
3337                  'post_status'    => 'inherit',
3338                  'post_type'      => 'attachment',
3339                  'post_mime_type' => 'image',
3340                  'order'          => 'ASC',
3341                  'orderby'        => 'menu_order ID',
3342              )
3343          )
3344      );
3345  
3346      foreach ( $attachments as $k => $attachment ) {
3347          if ( (int) $attachment->ID === (int) $post->ID ) {
3348              break;
3349          }
3350      }
3351  
3352      $output        = '';
3353      $attachment_id = 0;
3354  
3355      if ( $attachments ) {
3356          $k = $prev ? $k - 1 : $k + 1;
3357  
3358          if ( isset( $attachments[ $k ] ) ) {
3359              $attachment_id = $attachments[ $k ]->ID;
3360              $output        = wp_get_attachment_link( $attachment_id, $size, true, false, $text );
3361          }
3362      }
3363  
3364      $adjacent = $prev ? 'previous' : 'next';
3365  
3366      /**
3367       * Filters the adjacent image link.
3368       *
3369       * The dynamic portion of the hook name, `$adjacent`, refers to the type of adjacency,
3370       * either 'next', or 'previous'.
3371       *
3372       * @since 3.5.0
3373       *
3374       * @param string $output        Adjacent image HTML markup.
3375       * @param int    $attachment_id Attachment ID
3376       * @param string|int[] $size    Requested image size. Can be any registered image size name, or
3377       *                              an array of width and height values in pixels (in that order).
3378       * @param string $text          Link text.
3379       */
3380      echo apply_filters( "{$adjacent}_image_link", $output, $attachment_id, $size, $text );
3381  }
3382  
3383  /**
3384   * Retrieves taxonomies attached to given the attachment.
3385   *
3386   * @since 2.5.0
3387   * @since 4.7.0 Introduced the `$output` parameter.
3388   *
3389   * @param int|array|object $attachment Attachment ID, data array, or data object.
3390   * @param string           $output     Output type. 'names' to return an array of taxonomy names,
3391   *                                     or 'objects' to return an array of taxonomy objects.
3392   *                                     Default is 'names'.
3393   * @return string[]|WP_Taxonomy[] List of taxonomies or taxonomy names. Empty array on failure.
3394   */
3395  function get_attachment_taxonomies( $attachment, $output = 'names' ) {
3396      if ( is_int( $attachment ) ) {
3397          $attachment = get_post( $attachment );
3398      } elseif ( is_array( $attachment ) ) {
3399          $attachment = (object) $attachment;
3400      }
3401  
3402      if ( ! is_object( $attachment ) ) {
3403          return array();
3404      }
3405  
3406      $file     = get_attached_file( $attachment->ID );
3407      $filename = wp_basename( $file );
3408  
3409      $objects = array( 'attachment' );
3410  
3411      if ( false !== strpos( $filename, '.' ) ) {
3412          $objects[] = 'attachment:' . substr( $filename, strrpos( $filename, '.' ) + 1 );
3413      }
3414  
3415      if ( ! empty( $attachment->post_mime_type ) ) {
3416          $objects[] = 'attachment:' . $attachment->post_mime_type;
3417  
3418          if ( false !== strpos( $attachment->post_mime_type, '/' ) ) {
3419              foreach ( explode( '/', $attachment->post_mime_type ) as $token ) {
3420                  if ( ! empty( $token ) ) {
3421                      $objects[] = "attachment:$token";
3422                  }
3423              }
3424          }
3425      }
3426  
3427      $taxonomies = array();
3428  
3429      foreach ( $objects as $object ) {
3430          $taxes = get_object_taxonomies( $object, $output );
3431  
3432          if ( $taxes ) {
3433              $taxonomies = array_merge( $taxonomies, $taxes );
3434          }
3435      }
3436  
3437      if ( 'names' === $output ) {
3438          $taxonomies = array_unique( $taxonomies );
3439      }
3440  
3441      return $taxonomies;
3442  }
3443  
3444  /**
3445   * Retrieves all of the taxonomies that are registered for attachments.
3446   *
3447   * Handles mime-type-specific taxonomies such as attachment:image and attachment:video.
3448   *
3449   * @since 3.5.0
3450   *
3451   * @see get_taxonomies()
3452   *
3453   * @param string $output Optional. The type of taxonomy output to return. Accepts 'names' or 'objects'.
3454   *                       Default 'names'.
3455   * @return string[]|WP_Taxonomy[] Array of names or objects of registered taxonomies for attachments.
3456   */
3457  function get_taxonomies_for_attachments( $output = 'names' ) {
3458      $taxonomies = array();
3459  
3460      foreach ( get_taxonomies( array(), 'objects' ) as $taxonomy ) {
3461          foreach ( $taxonomy->object_type as $object_type ) {
3462              if ( 'attachment' === $object_type || 0 === strpos( $object_type, 'attachment:' ) ) {
3463                  if ( 'names' === $output ) {
3464                      $taxonomies[] = $taxonomy->name;
3465                  } else {
3466                      $taxonomies[ $taxonomy->name ] = $taxonomy;
3467                  }
3468                  break;
3469              }
3470          }
3471      }
3472  
3473      return $taxonomies;
3474  }
3475  
3476  /**
3477   * Determines whether the value is an acceptable type for GD image functions.
3478   *
3479   * In PHP 8.0, the GD extension uses GdImage objects for its data structures.
3480   * This function checks if the passed value is either a resource of type `gd`
3481   * or a GdImage object instance. Any other type will return false.
3482   *
3483   * @since 5.6.0
3484   *
3485   * @param resource|GdImage|false $image A value to check the type for.
3486   * @return bool True if $image is either a GD image resource or GdImage instance,
3487   *              false otherwise.
3488   */
3489  function is_gd_image( $image ) {
3490      if ( is_resource( $image ) && 'gd' === get_resource_type( $image )
3491          || is_object( $image ) && $image instanceof GdImage
3492      ) {
3493          return true;
3494      }
3495  
3496      return false;
3497  }
3498  
3499  /**
3500   * Create new GD image resource with transparency support
3501   *
3502   * @todo Deprecate if possible.
3503   *
3504   * @since 2.9.0
3505   *
3506   * @param int $width  Image width in pixels.
3507   * @param int $height Image height in pixels.
3508   * @return resource|GdImage The GD image resource or GdImage instance.
3509   */
3510  function wp_imagecreatetruecolor( $width, $height ) {
3511      $img = imagecreatetruecolor( $width, $height );
3512  
3513      if ( is_gd_image( $img )
3514          && function_exists( 'imagealphablending' ) && function_exists( 'imagesavealpha' )
3515      ) {
3516          imagealphablending( $img, false );
3517          imagesavealpha( $img, true );
3518      }
3519  
3520      return $img;
3521  }
3522  
3523  /**
3524   * Based on a supplied width/height example, return the biggest possible dimensions based on the max width/height.
3525   *
3526   * @since 2.9.0
3527   *
3528   * @see wp_constrain_dimensions()
3529   *
3530   * @param int $example_width  The width of an example embed.
3531   * @param int $example_height The height of an example embed.
3532   * @param int $max_width      The maximum allowed width.
3533   * @param int $max_height     The maximum allowed height.
3534   * @return int[] {
3535   *     An array of maximum width and height values.
3536   *
3537   *     @type int $0 The maximum width in pixels.
3538   *     @type int $1 The maximum height in pixels.
3539   * }
3540   */
3541  function wp_expand_dimensions( $example_width, $example_height, $max_width, $max_height ) {
3542      $example_width  = (int) $example_width;
3543      $example_height = (int) $example_height;
3544      $max_width      = (int) $max_width;
3545      $max_height     = (int) $max_height;
3546  
3547      return wp_constrain_dimensions( $example_width * 1000000, $example_height * 1000000, $max_width, $max_height );
3548  }
3549  
3550  /**
3551   * Determines the maximum upload size allowed in php.ini.
3552   *
3553   * @since 2.5.0
3554   *
3555   * @return int Allowed upload size.
3556   */
3557  function wp_max_upload_size() {
3558      $u_bytes = wp_convert_hr_to_bytes( ini_get( 'upload_max_filesize' ) );
3559      $p_bytes = wp_convert_hr_to_bytes( ini_get( 'post_max_size' ) );
3560  
3561      /**
3562       * Filters the maximum upload size allowed in php.ini.
3563       *
3564       * @since 2.5.0
3565       *
3566       * @param int $size    Max upload size limit in bytes.
3567       * @param int $u_bytes Maximum upload filesize in bytes.
3568       * @param int $p_bytes Maximum size of POST data in bytes.
3569       */
3570      return apply_filters( 'upload_size_limit', min( $u_bytes, $p_bytes ), $u_bytes, $p_bytes );
3571  }
3572  
3573  /**
3574   * Returns a WP_Image_Editor instance and loads file into it.
3575   *
3576   * @since 3.5.0
3577   *
3578   * @param string $path Path to the file to load.
3579   * @param array  $args Optional. Additional arguments for retrieving the image editor.
3580   *                     Default empty array.
3581   * @return WP_Image_Editor|WP_Error The WP_Image_Editor object if successful, an WP_Error
3582   *                                  object otherwise.
3583   */
3584  function wp_get_image_editor( $path, $args = array() ) {
3585      $args['path'] = $path;
3586  
3587      if ( ! isset( $args['mime_type'] ) ) {
3588          $file_info = wp_check_filetype( $args['path'] );
3589  
3590          // If $file_info['type'] is false, then we let the editor attempt to
3591          // figure out the file type, rather than forcing a failure based on extension.
3592          if ( isset( $file_info ) && $file_info['type'] ) {
3593              $args['mime_type'] = $file_info['type'];
3594          }
3595      }
3596  
3597      $implementation = _wp_image_editor_choose( $args );
3598  
3599      if ( $implementation ) {
3600          $editor = new $implementation( $path );
3601          $loaded = $editor->load();
3602  
3603          if ( is_wp_error( $loaded ) ) {
3604              return $loaded;
3605          }
3606  
3607          return $editor;
3608      }
3609  
3610      return new WP_Error( 'image_no_editor', __( 'No editor could be selected.' ) );
3611  }
3612  
3613  /**
3614   * Tests whether there is an editor that supports a given mime type or methods.
3615   *
3616   * @since 3.5.0
3617   *
3618   * @param string|array $args Optional. Array of arguments to retrieve the image editor supports.
3619   *                           Default empty array.
3620   * @return bool True if an eligible editor is found; false otherwise.
3621   */
3622  function wp_image_editor_supports( $args = array() ) {
3623      return (bool) _wp_image_editor_choose( $args );
3624  }
3625  
3626  /**
3627   * Tests which editors are capable of supporting the request.
3628   *
3629   * @ignore
3630   * @since 3.5.0
3631   *
3632   * @param array $args Optional. Array of arguments for choosing a capable editor. Default empty array.
3633   * @return string|false Class name for the first editor that claims to support the request. False if no
3634   *                     editor claims to support the request.
3635   */
3636  function _wp_image_editor_choose( $args = array() ) {
3637      require_once  ABSPATH . WPINC . '/class-wp-image-editor.php';
3638      require_once  ABSPATH . WPINC . '/class-wp-image-editor-gd.php';
3639      require_once  ABSPATH . WPINC . '/class-wp-image-editor-imagick.php';
3640      /**
3641       * Filters the list of image editing library classes.
3642       *
3643       * @since 3.5.0
3644       *
3645       * @param string[] $image_editors Array of available image editor class names. Defaults are
3646       *                                'WP_Image_Editor_Imagick', 'WP_Image_Editor_GD'.
3647       */
3648      $implementations = apply_filters( 'wp_image_editors', array( 'WP_Image_Editor_Imagick', 'WP_Image_Editor_GD' ) );
3649  
3650      foreach ( $implementations as $implementation ) {
3651          if ( ! call_user_func( array( $implementation, 'test' ), $args ) ) {
3652              continue;
3653          }
3654  
3655          if ( isset( $args['mime_type'] ) &&
3656              ! call_user_func(
3657                  array( $implementation, 'supports_mime_type' ),
3658                  $args['mime_type']
3659              ) ) {
3660              continue;
3661          }
3662  
3663          if ( isset( $args['methods'] ) &&
3664              array_diff( $args['methods'], get_class_methods( $implementation ) ) ) {
3665  
3666              continue;
3667          }
3668  
3669          return $implementation;
3670      }
3671  
3672      return false;
3673  }
3674  
3675  /**
3676   * Prints default Plupload arguments.
3677   *
3678   * @since 3.4.0
3679   */
3680  function wp_plupload_default_settings() {
3681      $wp_scripts = wp_scripts();
3682  
3683      $data = $wp_scripts->get_data( 'wp-plupload', 'data' );
3684      if ( $data && false !== strpos( $data, '_wpPluploadSettings' ) ) {
3685          return;
3686      }
3687  
3688      $max_upload_size    = wp_max_upload_size();
3689      $allowed_extensions = array_keys( get_allowed_mime_types() );
3690      $extensions         = array();
3691      foreach ( $allowed_extensions as $extension ) {
3692          $extensions = array_merge( $extensions, explode( '|', $extension ) );
3693      }
3694  
3695      /*
3696       * Since 4.9 the `runtimes` setting is hardcoded in our version of Plupload to `html5,html4`,
3697       * and the `flash_swf_url` and `silverlight_xap_url` are not used.
3698       */
3699      $defaults = array(
3700          'file_data_name' => 'async-upload', // Key passed to $_FILE.
3701          'url'            => admin_url( 'async-upload.php', 'relative' ),
3702          'filters'        => array(
3703              'max_file_size' => $max_upload_size . 'b',
3704              'mime_types'    => array( array( 'extensions' => implode( ',', $extensions ) ) ),
3705          ),
3706      );
3707  
3708      /*
3709       * Currently only iOS Safari supports multiple files uploading,
3710       * but iOS 7.x has a bug that prevents uploading of videos when enabled.
3711       * See #29602.
3712       */
3713      if ( wp_is_mobile() && strpos( $_SERVER['HTTP_USER_AGENT'], 'OS 7_' ) !== false &&
3714          strpos( $_SERVER['HTTP_USER_AGENT'], 'like Mac OS X' ) !== false ) {
3715  
3716          $defaults['multi_selection'] = false;
3717      }
3718  
3719      /**
3720       * Filters the Plupload default settings.
3721       *
3722       * @since 3.4.0
3723       *
3724       * @param array $defaults Default Plupload settings array.
3725       */
3726      $defaults = apply_filters( 'plupload_default_settings', $defaults );
3727  
3728      $params = array(
3729          'action' => 'upload-attachment',
3730      );
3731  
3732      /**
3733       * Filters the Plupload default parameters.
3734       *
3735       * @since 3.4.0
3736       *
3737       * @param array $params Default Plupload parameters array.
3738       */
3739      $params = apply_filters( 'plupload_default_params', $params );
3740  
3741      $params['_wpnonce'] = wp_create_nonce( 'media-form' );
3742  
3743      $defaults['multipart_params'] = $params;
3744  
3745      $settings = array(
3746          'defaults'      => $defaults,
3747          'browser'       => array(
3748              'mobile'    => wp_is_mobile(),
3749              'supported' => _device_can_upload(),
3750          ),
3751          'limitExceeded' => is_multisite() && ! is_upload_space_available(),
3752      );
3753  
3754      $script = 'var _wpPluploadSettings = ' . wp_json_encode( $settings ) . ';';
3755  
3756      if ( $data ) {
3757          $script = "$data\n$script";
3758      }
3759  
3760      $wp_scripts->add_data( 'wp-plupload', 'data', $script );
3761  }
3762  
3763  /**
3764   * Prepares an attachment post object for JS, where it is expected
3765   * to be JSON-encoded and fit into an Attachment model.
3766   *
3767   * @since 3.5.0
3768   *
3769   * @param int|WP_Post $attachment Attachment ID or object.
3770   * @return array|void {
3771   *     Array of attachment details, or void if the parameter does not correspond to an attachment.
3772   *
3773   *     @type string $alt                   Alt text of the attachment.
3774   *     @type string $author                ID of the attachment author, as a string.
3775   *     @type string $authorName            Name of the attachment author.
3776   *     @type string $caption               Caption for the attachment.
3777   *     @type array  $compat                Containing item and meta.
3778   *     @type string $context               Context, whether it's used as the site icon for example.
3779   *     @type int    $date                  Uploaded date, timestamp in milliseconds.
3780   *     @type string $dateFormatted         Formatted date (e.g. June 29, 2018).
3781   *     @type string $description           Description of the attachment.
3782   *     @type string $editLink              URL to the edit page for the attachment.
3783   *     @type string $filename              File name of the attachment.
3784   *     @type string $filesizeHumanReadable Filesize of the attachment in human readable format (e.g. 1 MB).
3785   *     @type int    $filesizeInBytes       Filesize of the attachment in bytes.
3786   *     @type int    $height                If the attachment is an image, represents the height of the image in pixels.
3787   *     @type string $icon                  Icon URL of the attachment (e.g. /wp-includes/images/media/archive.png).
3788   *     @type int    $id                    ID of the attachment.
3789   *     @type string $link                  URL to the attachment.
3790   *     @type int    $menuOrder             Menu order of the attachment post.
3791   *     @type array  $meta                  Meta data for the attachment.
3792   *     @type string $mime                  Mime type of the attachment (e.g. image/jpeg or application/zip).
3793   *     @type int    $modified              Last modified, timestamp in milliseconds.
3794   *     @type string $name                  Name, same as title of the attachment.
3795   *     @type array  $nonces                Nonces for update, delete and edit.
3796   *     @type string $orientation           If the attachment is an image, represents the image orientation
3797   *                                         (landscape or portrait).
3798   *     @type array  $sizes                 If the attachment is an image, contains an array of arrays
3799   *                                         for the images sizes: thumbnail, medium, large, and full.
3800   *     @type string $status                Post status of the attachment (usually 'inherit').
3801   *     @type string $subtype               Mime subtype of the attachment (usually the last part, e.g. jpeg or zip).
3802   *     @type string $title                 Title of the attachment (usually slugified file name without the extension).
3803   *     @type string $type                  Type of the attachment (usually first part of the mime type, e.g. image).
3804   *     @type int    $uploadedTo            Parent post to which the attachment was uploaded.
3805   *     @type string $uploadedToLink        URL to the edit page of the parent post of the attachment.
3806   *     @type string $uploadedToTitle       Post title of the parent of the attachment.
3807   *     @type string $url                   Direct URL to the attachment file (from wp-content).
3808   *     @type int    $width                 If the attachment is an image, represents the width of the image in pixels.
3809   * }
3810   *
3811   */
3812  function wp_prepare_attachment_for_js( $attachment ) {
3813      $attachment = get_post( $attachment );
3814  
3815      if ( ! $attachment ) {
3816          return;
3817      }
3818  
3819      if ( 'attachment' !== $attachment->post_type ) {
3820          return;
3821      }
3822  
3823      $meta = wp_get_attachment_metadata( $attachment->ID );
3824      if ( false !== strpos( $attachment->post_mime_type, '/' ) ) {
3825          list( $type, $subtype ) = explode( '/', $attachment->post_mime_type );
3826      } else {
3827          list( $type, $subtype ) = array( $attachment->post_mime_type, '' );
3828      }
3829  
3830      $attachment_url = wp_get_attachment_url( $attachment->ID );
3831      $base_url       = str_replace( wp_basename( $attachment_url ), '', $attachment_url );
3832  
3833      $response = array(
3834          'id'            => $attachment->ID,
3835          'title'         => $attachment->post_title,
3836          'filename'      => wp_basename( get_attached_file( $attachment->ID ) ),
3837          'url'           => $attachment_url,
3838          'link'          => get_attachment_link( $attachment->ID ),
3839          'alt'           => get_post_meta( $attachment->ID, '_wp_attachment_image_alt', true ),
3840          'author'        => $attachment->post_author,
3841          'description'   => $attachment->post_content,
3842          'caption'       => $attachment->post_excerpt,
3843          'name'          => $attachment->post_name,
3844          'status'        => $attachment->post_status,
3845          'uploadedTo'    => $attachment->post_parent,
3846          'date'          => strtotime( $attachment->post_date_gmt ) * 1000,
3847          'modified'      => strtotime( $attachment->post_modified_gmt ) * 1000,
3848          'menuOrder'     => $attachment->menu_order,
3849          'mime'          => $attachment->post_mime_type,
3850          'type'          => $type,
3851          'subtype'       => $subtype,
3852          'icon'          => wp_mime_type_icon( $attachment->ID ),
3853          'dateFormatted' => mysql2date( __( 'F j, Y' ), $attachment->post_date ),
3854          'nonces'        => array(
3855              'update' => false,
3856              'delete' => false,
3857              'edit'   => false,
3858          ),
3859          'editLink'      => false,
3860          'meta'          => false,
3861      );
3862  
3863      $author = new WP_User( $attachment->post_author );
3864      if ( $author->exists() ) {
3865          $author_name            = $author->display_name ? $author->display_name : $author->nickname;
3866          $response['authorName'] = html_entity_decode( $author_name, ENT_QUOTES, get_bloginfo( 'charset' ) );
3867          $response['authorLink'] = get_edit_user_link( $author->ID );
3868      } else {
3869          $response['authorName'] = __( '(no author)' );
3870      }
3871  
3872      if ( $attachment->post_parent ) {
3873          $post_parent = get_post( $attachment->post_parent );
3874          if ( $post_parent ) {
3875              $response['uploadedToTitle'] = $post_parent->post_title ? $post_parent->post_title : __( '(no title)' );
3876              $response['uploadedToLink']  = get_edit_post_link( $attachment->post_parent, 'raw' );
3877          }
3878      }
3879  
3880      $attached_file = get_attached_file( $attachment->ID );
3881  
3882      if ( isset( $meta['filesize'] ) ) {
3883          $bytes = $meta['filesize'];
3884      } elseif ( file_exists( $attached_file ) ) {
3885          $bytes = filesize( $attached_file );
3886      } else {
3887          $bytes = '';
3888      }
3889  
3890      if ( $bytes ) {
3891          $response['filesizeInBytes']       = $bytes;
3892          $response['filesizeHumanReadable'] = size_format( $bytes );
3893      }
3894  
3895      $context             = get_post_meta( $attachment->ID, '_wp_attachment_context', true );
3896      $response['context'] = ( $context ) ? $context : '';
3897  
3898      if ( current_user_can( 'edit_post', $attachment->ID ) ) {
3899          $response['nonces']['update'] = wp_create_nonce( 'update-post_' . $attachment->ID );
3900          $response['nonces']['edit']   = wp_create_nonce( 'image_editor-' . $attachment->ID );
3901          $response['editLink']         = get_edit_post_link( $attachment->ID, 'raw' );
3902      }
3903  
3904      if ( current_user_can( 'delete_post', $attachment->ID ) ) {
3905          $response['nonces']['delete'] = wp_create_nonce( 'delete-post_' . $attachment->ID );
3906      }
3907  
3908      if ( $meta && ( 'image' === $type || ! empty( $meta['sizes'] ) ) ) {
3909          $sizes = array();
3910  
3911          /** This filter is documented in wp-admin/includes/media.php */
3912          $possible_sizes = apply_filters(
3913              'image_size_names_choose',
3914              array(
3915                  'thumbnail' => __( 'Thumbnail' ),
3916                  'medium'    => __( 'Medium' ),
3917                  'large'     => __( 'Large' ),
3918                  'full'      => __( 'Full Size' ),
3919              )
3920          );
3921          unset( $possible_sizes['full'] );
3922  
3923          /*
3924           * Loop through all potential sizes that may be chosen. Try to do this with some efficiency.
3925           * First: run the image_downsize filter. If it returns something, we can use its data.
3926           * If the filter does not return something, then image_downsize() is just an expensive way
3927           * to check the image metadata, which we do second.
3928           */
3929          foreach ( $possible_sizes as $size => $label ) {
3930  
3931              /** This filter is documented in wp-includes/media.php */
3932              $downsize = apply_filters( 'image_downsize', false, $attachment->ID, $size );
3933  
3934              if ( $downsize ) {
3935                  if ( empty( $downsize[3] ) ) {
3936                      continue;
3937                  }
3938  
3939                  $sizes[ $size ] = array(
3940                      'height'      => $downsize[2],
3941                      'width'       => $downsize[1],
3942                      'url'         => $downsize[0],
3943                      'orientation' => $downsize[2] > $downsize[1] ? 'portrait' : 'landscape',
3944                  );
3945              } elseif ( isset( $meta['sizes'][ $size ] ) ) {
3946                  // Nothing from the filter, so consult image metadata if we have it.
3947                  $size_meta = $meta['sizes'][ $size ];
3948  
3949                  // We have the actual image size, but might need to further constrain it if content_width is narrower.
3950                  // Thumbnail, medium, and full sizes are also checked against the site's height/width options.
3951                  list( $width, $height ) = image_constrain_size_for_editor( $size_meta['width'], $size_meta['height'], $size, 'edit' );
3952  
3953                  $sizes[ $size ] = array(
3954                      'height'      => $height,
3955                      'width'       => $width,
3956                      'url'         => $base_url . $size_meta['file'],
3957                      'orientation' => $height > $width ? 'portrait' : 'landscape',
3958                  );
3959              }
3960          }
3961  
3962          if ( 'image' === $type ) {
3963              if ( ! empty( $meta['original_image'] ) ) {
3964                  $response['originalImageURL']  = wp_get_original_image_url( $attachment->ID );
3965                  $response['originalImageName'] = wp_basename( wp_get_original_image_path( $attachment->ID ) );
3966              }
3967  
3968              $sizes['full'] = array( 'url' => $attachment_url );
3969  
3970              if ( isset( $meta['height'], $meta['width'] ) ) {
3971                  $sizes['full']['height']      = $meta['height'];
3972                  $sizes['full']['width']       = $meta['width'];
3973                  $sizes['full']['orientation'] = $meta['height'] > $meta['width'] ? 'portrait' : 'landscape';
3974              }
3975  
3976              $response = array_merge( $response, $sizes['full'] );
3977          } elseif ( $meta['sizes']['full']['file'] ) {
3978              $sizes['full'] = array(
3979                  'url'         => $base_url . $meta['sizes']['full']['file'],
3980                  'height'      => $meta['sizes']['full']['height'],
3981                  'width'       => $meta['sizes']['full']['width'],
3982                  'orientation' => $meta['sizes']['full']['height'] > $meta['sizes']['full']['width'] ? 'portrait' : 'landscape',
3983              );
3984          }
3985  
3986          $response = array_merge( $response, array( 'sizes' => $sizes ) );
3987      }
3988  
3989      if ( $meta && 'video' === $type ) {
3990          if ( isset( $meta['width'] ) ) {
3991              $response['width'] = (int) $meta['width'];
3992          }
3993          if ( isset( $meta['height'] ) ) {
3994              $response['height'] = (int) $meta['height'];
3995          }
3996      }
3997  
3998      if ( $meta && ( 'audio' === $type || 'video' === $type ) ) {
3999          if ( isset( $meta['length_formatted'] ) ) {
4000              $response['fileLength']              = $meta['length_formatted'];
4001              $response['fileLengthHumanReadable'] = human_readable_duration( $meta['length_formatted'] );
4002          }
4003  
4004          $response['meta'] = array();
4005          foreach ( wp_get_attachment_id3_keys( $attachment, 'js' ) as $key => $label ) {
4006              $response['meta'][ $key ] = false;
4007  
4008              if ( ! empty( $meta[ $key ] ) ) {
4009                  $response['meta'][ $key ] = $meta[ $key ];
4010              }
4011          }
4012  
4013          $id = get_post_thumbnail_id( $attachment->ID );
4014          if ( ! empty( $id ) ) {
4015              list( $src, $width, $height ) = wp_get_attachment_image_src( $id, 'full' );
4016              $response['image']            = compact( 'src', 'width', 'height' );
4017              list( $src, $width, $height ) = wp_get_attachment_image_src( $id, 'thumbnail' );
4018              $response['thumb']            = compact( 'src', 'width', 'height' );
4019          } else {
4020              $src               = wp_mime_type_icon( $attachment->ID );
4021              $width             = 48;
4022              $height            = 64;
4023              $response['image'] = compact( 'src', 'width', 'height' );
4024              $response['thumb'] = compact( 'src', 'width', 'height' );
4025          }
4026      }
4027  
4028      if ( function_exists( 'get_compat_media_markup' ) ) {
4029          $response['compat'] = get_compat_media_markup( $attachment->ID, array( 'in_modal' => true ) );
4030      }
4031  
4032      $media_states = get_media_states( $attachment );
4033      if ( ! empty( $media_states ) ) {
4034          $response['mediaStates'] = implode( ', ', $media_states );
4035      }
4036  
4037      /**
4038       * Filters the attachment data prepared for JavaScript.
4039       *
4040       * @since 3.5.0
4041       *
4042       * @param array       $response   Array of prepared attachment data. @see wp_prepare_attachment_for_js().
4043       * @param WP_Post     $attachment Attachment object.
4044       * @param array|false $meta       Array of attachment meta data, or false if there is none.
4045       */
4046      return apply_filters( 'wp_prepare_attachment_for_js', $response, $attachment, $meta );
4047  }
4048  
4049  /**
4050   * Enqueues all scripts, styles, settings, and templates necessary to use
4051   * all media JS APIs.
4052   *
4053   * @since 3.5.0
4054   *
4055   * @global int       $content_width
4056   * @global wpdb      $wpdb          WordPress database abstraction object.
4057   * @global WP_Locale $wp_locale     WordPress date and time locale object.
4058   *
4059   * @param array $args {
4060   *     Arguments for enqueuing media scripts.
4061   *
4062   *     @type int|WP_Post A post object or ID.
4063   * }
4064   */
4065  function wp_enqueue_media( $args = array() ) {
4066      // Enqueue me just once per page, please.
4067      if ( did_action( 'wp_enqueue_media' ) ) {
4068          return;
4069      }
4070  
4071      global $content_width, $wpdb, $wp_locale;
4072  
4073      $defaults = array(
4074          'post' => null,
4075      );
4076      $args     = wp_parse_args( $args, $defaults );
4077  
4078      // We're going to pass the old thickbox media tabs to `media_upload_tabs`
4079      // to ensure plugins will work. We will then unset those tabs.
4080      $tabs = array(
4081          // handler action suffix => tab label
4082          'type'     => '',
4083          'type_url' => '',
4084          'gallery'  => '',
4085          'library'  => '',
4086      );
4087  
4088      /** This filter is documented in wp-admin/includes/media.php */
4089      $tabs = apply_filters( 'media_upload_tabs', $tabs );
4090      unset( $tabs['type'], $tabs['type_url'], $tabs['gallery'], $tabs['library'] );
4091  
4092      $props = array(
4093          'link'  => get_option( 'image_default_link_type' ), // DB default is 'file'.
4094          'align' => get_option( 'image_default_align' ),     // Empty default.
4095          'size'  => get_option( 'image_default_size' ),      // Empty default.
4096      );
4097  
4098      $exts      = array_merge( wp_get_audio_extensions(), wp_get_video_extensions() );
4099      $mimes     = get_allowed_mime_types();
4100      $ext_mimes = array();
4101      foreach ( $exts as $ext ) {
4102          foreach ( $mimes as $ext_preg => $mime_match ) {
4103              if ( preg_match( '#' . $ext . '#i', $ext_preg ) ) {
4104                  $ext_mimes[ $ext ] = $mime_match;
4105                  break;
4106              }
4107          }
4108      }
4109  
4110      /**
4111       * Allows showing or hiding the "Create Audio Playlist" button in the media library.
4112       *
4113       * By default, the "Create Audio Playlist" button will always be shown in
4114       * the media library.  If this filter returns `null`, a query will be run
4115       * to determine whether the media library contains any audio items.  This
4116       * was the default behavior prior to version 4.8.0, but this query is
4117       * expensive for large media libraries.
4118       *
4119       * @since 4.7.4
4120       * @since 4.8.0 The filter's default value is `true` rather than `null`.
4121       *
4122       * @link https://core.trac.wordpress.org/ticket/31071
4123       *
4124       * @param bool|null $show Whether to show the button, or `null` to decide based
4125       *                        on whether any audio files exist in the media library.
4126       */
4127      $show_audio_playlist = apply_filters( 'media_library_show_audio_playlist', true );
4128      if ( null === $show_audio_playlist ) {
4129          $show_audio_playlist = $wpdb->get_var(
4130              "
4131              SELECT ID
4132              FROM $wpdb->posts
4133              WHERE post_type = 'attachment'
4134              AND post_mime_type LIKE 'audio%'
4135              LIMIT 1
4136          "
4137          );
4138      }
4139  
4140      /**
4141       * Allows showing or hiding the "Create Video Playlist" button in the media library.
4142       *
4143       * By default, the "Create Video Playlist" button will always be shown in
4144       * the media library.  If this filter returns `null`, a query will be run
4145       * to determine whether the media library contains any video items.  This
4146       * was the default behavior prior to version 4.8.0, but this query is
4147       * expensive for large media libraries.
4148       *
4149       * @since 4.7.4
4150       * @since 4.8.0 The filter's default value is `true` rather than `null`.
4151       *
4152       * @link https://core.trac.wordpress.org/ticket/31071
4153       *
4154       * @param bool|null $show Whether to show the button, or `null` to decide based
4155       *                        on whether any video files exist in the media library.
4156       */
4157      $show_video_playlist = apply_filters( 'media_library_show_video_playlist', true );
4158      if ( null === $show_video_playlist ) {
4159          $show_video_playlist = $wpdb->get_var(
4160              "
4161              SELECT ID
4162              FROM $wpdb->posts
4163              WHERE post_type = 'attachment'
4164              AND post_mime_type LIKE 'video%'
4165              LIMIT 1
4166          "
4167          );
4168      }
4169  
4170      /**
4171       * Allows overriding the list of months displayed in the media library.
4172       *
4173       * By default (if this filter does not return an array), a query will be
4174       * run to determine the months that have media items.  This query can be
4175       * expensive for large media libraries, so it may be desirable for sites to
4176       * override this behavior.
4177       *
4178       * @since 4.7.4
4179       *
4180       * @link https://core.trac.wordpress.org/ticket/31071
4181       *
4182       * @param array|null $months An array of objects with `month` and `year`
4183       *                           properties, or `null` (or any other non-array value)
4184       *                           for default behavior.
4185       */
4186      $months = apply_filters( 'media_library_months_with_files', null );
4187      if ( ! is_array( $months ) ) {
4188          $months = $wpdb->get_results(
4189              $wpdb->prepare(
4190                  "
4191              SELECT DISTINCT YEAR( post_date ) AS year, MONTH( post_date ) AS month
4192              FROM $wpdb->posts
4193              WHERE post_type = %s
4194              ORDER BY post_date DESC
4195          ",
4196                  'attachment'
4197              )
4198          );
4199      }
4200      foreach ( $months as $month_year ) {
4201          $month_year->text = sprintf(
4202              /* translators: 1: Month, 2: Year. */
4203              __( '%1$s %2$d' ),
4204              $wp_locale->get_month( $month_year->month ),
4205              $month_year->year
4206          );
4207      }
4208  
4209      $settings = array(
4210          'tabs'             => $tabs,
4211          'tabUrl'           => add_query_arg( array( 'chromeless' => true ), admin_url( 'media-upload.php' ) ),
4212          'mimeTypes'        => wp_list_pluck( get_post_mime_types(), 0 ),
4213          /** This filter is documented in wp-admin/includes/media.php */
4214          'captions'         => ! apply_filters( 'disable_captions', '' ),
4215          'nonce'            => array(
4216              'sendToEditor' => wp_create_nonce( 'media-send-to-editor' ),
4217          ),
4218          'post'             => array(
4219              'id' => 0,
4220          ),
4221          'defaultProps'     => $props,
4222          'attachmentCounts' => array(
4223              'audio' => ( $show_audio_playlist ) ? 1 : 0,
4224              'video' => ( $show_video_playlist ) ? 1 : 0,
4225          ),
4226          'oEmbedProxyUrl'   => rest_url( 'oembed/1.0/proxy' ),
4227          'embedExts'        => $exts,
4228          'embedMimes'       => $ext_mimes,
4229          'contentWidth'     => $content_width,
4230          'months'           => $months,
4231          'mediaTrash'       => MEDIA_TRASH ? 1 : 0,
4232      );
4233  
4234      $post = null;
4235      if ( isset( $args['post'] ) ) {
4236          $post             = get_post( $args['post'] );
4237          $settings['post'] = array(
4238              'id'    => $post->ID,
4239              'nonce' => wp_create_nonce( 'update-post_' . $post->ID ),
4240          );
4241  
4242          $thumbnail_support = current_theme_supports( 'post-thumbnails', $post->post_type ) && post_type_supports( $post->post_type, 'thumbnail' );
4243          if ( ! $thumbnail_support && 'attachment' === $post->post_type && $post->post_mime_type ) {
4244              if ( wp_attachment_is( 'audio', $post ) ) {
4245                  $thumbnail_support = post_type_supports( 'attachment:audio', 'thumbnail' ) || current_theme_supports( 'post-thumbnails', 'attachment:audio' );
4246              } elseif ( wp_attachment_is( 'video', $post ) ) {
4247                  $thumbnail_support = post_type_supports( 'attachment:video', 'thumbnail' ) || current_theme_supports( 'post-thumbnails', 'attachment:video' );
4248              }
4249          }
4250  
4251          if ( $thumbnail_support ) {
4252              $featured_image_id                   = get_post_meta( $post->ID, '_thumbnail_id', true );
4253              $settings['post']['featuredImageId'] = $featured_image_id ? $featured_image_id : -1;
4254          }
4255      }
4256  
4257      if ( $post ) {
4258          $post_type_object = get_post_type_object( $post->post_type );
4259      } else {
4260          $post_type_object = get_post_type_object( 'post' );
4261      }
4262  
4263      $strings = array(
4264          // Generic.
4265          'mediaFrameDefaultTitle'      => __( 'Media' ),
4266          'url'                         => __( 'URL' ),
4267          'addMedia'                    => __( 'Add media' ),
4268          'search'                      => __( 'Search' ),
4269          'select'                      => __( 'Select' ),
4270          'cancel'                      => __( 'Cancel' ),
4271          'update'                      => __( 'Update' ),
4272          'replace'                     => __( 'Replace' ),
4273          'remove'                      => __( 'Remove' ),
4274          'back'                        => __( 'Back' ),
4275          /*
4276           * translators: This is a would-be plural string used in the media manager.
4277           * If there is not a word you can use in your language to avoid issues with the
4278           * lack of plural support here, turn it into "selected: %d" then translate it.
4279           */
4280          'selected'                    => __( '%d selected' ),
4281          'dragInfo'                    => __( 'Drag and drop to reorder media files.' ),
4282  
4283          // Upload.
4284          'uploadFilesTitle'            => __( 'Upload files' ),
4285          'uploadImagesTitle'           => __( 'Upload images' ),
4286  
4287          // Library.
4288          'mediaLibraryTitle'           => __( 'Media Library' ),
4289          'insertMediaTitle'            => __( 'Add media' ),
4290          'createNewGallery'            => __( 'Create a new gallery' ),
4291          'createNewPlaylist'           => __( 'Create a new playlist' ),
4292          'createNewVideoPlaylist'      => __( 'Create a new video playlist' ),
4293          'returnToLibrary'             => __( '&#8592; Return to library' ),
4294          'allMediaItems'               => __( 'All media items' ),
4295          'allDates'                    => __( 'All dates' ),
4296          'noItemsFound'                => __( 'No items found.' ),
4297          'insertIntoPost'              => $post_type_object->labels->insert_into_item,
4298          'unattached'                  => __( 'Unattached' ),
4299          'mine'                        => _x( 'Mine', 'media items' ),
4300          'trash'                       => _x( 'Trash', 'noun' ),
4301          'uploadedToThisPost'          => $post_type_object->labels->uploaded_to_this_item,
4302          'warnDelete'                  => __( "You are about to permanently delete this item from your site.\nThis action cannot be undone.\n 'Cancel' to stop, 'OK' to delete." ),
4303          'warnBulkDelete'              => __( "You are about to permanently delete these items from your site.\nThis action cannot be undone.\n 'Cancel' to stop, 'OK' to delete." ),
4304          'warnBulkTrash'               => __( "You are about to trash these items.\n  'Cancel' to stop, 'OK' to delete." ),
4305          'bulkSelect'                  => __( 'Bulk select' ),
4306          'trashSelected'               => __( 'Move to Trash' ),
4307          'restoreSelected'             => __( 'Restore from Trash' ),
4308          'deletePermanently'           => __( 'Delete permanently' ),
4309          'apply'                       => __( 'Apply' ),
4310          'filterByDate'                => __( 'Filter by date' ),
4311          'filterByType'                => __( 'Filter by type' ),
4312          'searchLabel'                 => __( 'Search' ),
4313          'searchMediaLabel'            => __( 'Search media' ),          // Backward compatibility pre-5.3.
4314          'searchMediaPlaceholder'      => __( 'Search media items...' ), // Placeholder (no ellipsis), backward compatibility pre-5.3.
4315          'mediaFound'                  => __( 'Number of media items found: %d' ),
4316          'mediaFoundHasMoreResults'    => __( 'Number of media items displayed: %d. Scroll the page for more results.' ),
4317          'noMedia'                     => __( 'No media items found.' ),
4318          'noMediaTryNewSearch'         => __( 'No media items found. Try a different search.' ),
4319  
4320          // Library Details.
4321          'attachmentDetails'           => __( 'Attachment details' ),
4322  
4323          // From URL.
4324          'insertFromUrlTitle'          => __( 'Insert from URL' ),
4325  
4326          // Featured Images.
4327          'setFeaturedImageTitle'       => $post_type_object->labels->featured_image,
4328          'setFeaturedImage'            => $post_type_object->labels->set_featured_image,
4329  
4330          // Gallery.
4331          'createGalleryTitle'          => __( 'Create gallery' ),
4332          'editGalleryTitle'            => __( 'Edit gallery' ),
4333          'cancelGalleryTitle'          => __( '&#8592; Cancel gallery' ),
4334          'insertGallery'               => __( 'Insert gallery' ),
4335          'updateGallery'               => __( 'Update gallery' ),
4336          'addToGallery'                => __( 'Add to gallery' ),
4337          'addToGalleryTitle'           => __( 'Add to gallery' ),
4338          'reverseOrder'                => __( 'Reverse order' ),
4339  
4340          // Edit Image.
4341          'imageDetailsTitle'           => __( 'Image details' ),
4342          'imageReplaceTitle'           => __( 'Replace image' ),
4343          'imageDetailsCancel'          => __( 'Cancel edit' ),
4344          'editImage'                   => __( 'Edit image' ),
4345  
4346          // Crop Image.
4347          'chooseImage'                 => __( 'Choose image' ),
4348          'selectAndCrop'               => __( 'Select and crop' ),
4349          'skipCropping'                => __( 'Skip cropping' ),
4350          'cropImage'                   => __( 'Crop image' ),
4351          'cropYourImage'               => __( 'Crop your image' ),
4352          'cropping'                    => __( 'Cropping&hellip;' ),
4353          /* translators: 1: Suggested width number, 2: Suggested height number. */
4354          'suggestedDimensions'         => __( 'Suggested image dimensions: %1$s by %2$s pixels.' ),
4355          'cropError'                   => __( 'There has been an error cropping your image.' ),
4356  
4357          // Edit Audio.
4358          'audioDetailsTitle'           => __( 'Audio details' ),
4359          'audioReplaceTitle'           => __( 'Replace audio' ),
4360          'audioAddSourceTitle'         => __( 'Add audio source' ),
4361          'audioDetailsCancel'          => __( 'Cancel edit' ),
4362  
4363          // Edit Video.
4364          'videoDetailsTitle'           => __( 'Video details' ),
4365          'videoReplaceTitle'           => __( 'Replace video' ),
4366          'videoAddSourceTitle'         => __( 'Add video source' ),
4367          'videoDetailsCancel'          => __( 'Cancel edit' ),
4368          'videoSelectPosterImageTitle' => __( 'Select poster image' ),
4369          'videoAddTrackTitle'          => __( 'Add subtitles' ),
4370  
4371          // Playlist.
4372          'playlistDragInfo'            => __( 'Drag and drop to reorder tracks.' ),
4373          'createPlaylistTitle'         => __( 'Create audio playlist' ),
4374          'editPlaylistTitle'           => __( 'Edit audio playlist' ),
4375          'cancelPlaylistTitle'         => __( '&#8592; Cancel audio playlist' ),
4376          'insertPlaylist'              => __( 'Insert audio playlist' ),
4377          'updatePlaylist'              => __( 'Update audio playlist' ),
4378          'addToPlaylist'               => __( 'Add to audio playlist' ),
4379          'addToPlaylistTitle'          => __( 'Add to Audio Playlist' ),
4380  
4381          // Video Playlist.
4382          'videoPlaylistDragInfo'       => __( 'Drag and drop to reorder videos.' ),
4383          'createVideoPlaylistTitle'    => __( 'Create video playlist' ),
4384          'editVideoPlaylistTitle'      => __( 'Edit video playlist' ),
4385          'cancelVideoPlaylistTitle'    => __( '&#8592; Cancel video playlist' ),
4386          'insertVideoPlaylist'         => __( 'Insert video playlist' ),
4387          'updateVideoPlaylist'         => __( 'Update video playlist' ),
4388          'addToVideoPlaylist'          => __( 'Add to video playlist' ),
4389          'addToVideoPlaylistTitle'     => __( 'Add to video Playlist' ),
4390  
4391          // Headings.
4392          'filterAttachments'           => __( 'Filter media' ),
4393          'attachmentsList'             => __( 'Media list' ),
4394      );
4395  
4396      /**
4397       * Filters the media view settings.
4398       *
4399       * @since 3.5.0
4400       *
4401       * @param array   $settings List of media view settings.
4402       * @param WP_Post $post     Post object.
4403       */
4404      $settings = apply_filters( 'media_view_settings', $settings, $post );
4405  
4406      /**
4407       * Filters the media view strings.
4408       *
4409       * @since 3.5.0
4410       *
4411       * @param string[] $strings Array of media view strings keyed by the name they'll be referenced by in JavaScript.
4412       * @param WP_Post  $post    Post object.
4413       */
4414      $strings = apply_filters( 'media_view_strings', $strings, $post );
4415  
4416      $strings['settings'] = $settings;
4417  
4418      // Ensure we enqueue media-editor first, that way media-views
4419      // is registered internally before we try to localize it. See #24724.
4420      wp_enqueue_script( 'media-editor' );
4421      wp_localize_script( 'media-views', '_wpMediaViewsL10n', $strings );
4422  
4423      wp_enqueue_script( 'media-audiovideo' );
4424      wp_enqueue_style( 'media-views' );
4425      if ( is_admin() ) {
4426          wp_enqueue_script( 'mce-view' );
4427          wp_enqueue_script( 'image-edit' );
4428      }
4429      wp_enqueue_style( 'imgareaselect' );
4430      wp_plupload_default_settings();
4431  
4432      require_once  ABSPATH . WPINC . '/media-template.php';
4433      add_action( 'admin_footer', 'wp_print_media_templates' );
4434      add_action( 'wp_footer', 'wp_print_media_templates' );
4435      add_action( 'customize_controls_print_footer_scripts', 'wp_print_media_templates' );
4436  
4437      /**
4438       * Fires at the conclusion of wp_enqueue_media().
4439       *
4440       * @since 3.5.0
4441       */
4442      do_action( 'wp_enqueue_media' );
4443  }
4444  
4445  /**
4446   * Retrieves media attached to the passed post.
4447   *
4448   * @since 3.6.0
4449   *
4450   * @param string      $type Mime type.
4451   * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post.
4452   * @return WP_Post[] Array of media attached to the given post.
4453   */
4454  function get_attached_media( $type, $post = 0 ) {
4455      $post = get_post( $post );
4456  
4457      if ( ! $post ) {
4458          return array();
4459      }
4460  
4461      $args = array(
4462          'post_parent'    => $post->ID,
4463          'post_type'      => 'attachment',
4464          'post_mime_type' => $type,
4465          'posts_per_page' => -1,
4466          'orderby'        => 'menu_order',
4467          'order'          => 'ASC',
4468      );
4469  
4470      /**
4471       * Filters arguments used to retrieve media attached to the given post.
4472       *
4473       * @since 3.6.0
4474       *
4475       * @param array   $args Post query arguments.
4476       * @param string  $type Mime type of the desired media.
4477       * @param WP_Post $post Post object.
4478       */
4479      $args = apply_filters( 'get_attached_media_args', $args, $type, $post );
4480  
4481      $children = get_children( $args );
4482  
4483      /**
4484       * Filters the list of media attached to the given post.
4485       *
4486       * @since 3.6.0
4487       *
4488       * @param WP_Post[] $children Array of media attached to the given post.
4489       * @param string    $type     Mime type of the media desired.
4490       * @param WP_Post   $post     Post object.
4491       */
4492      return (array) apply_filters( 'get_attached_media', $children, $type, $post );
4493  }
4494  
4495  /**
4496   * Check the content HTML for a audio, video, object, embed, or iframe tags.
4497   *
4498   * @since 3.6.0
4499   *
4500   * @param string   $content A string of HTML which might contain media elements.
4501   * @param string[] $types   An array of media types: 'audio', 'video', 'object', 'embed', or 'iframe'.
4502   * @return string[] Array of found HTML media elements.
4503   */
4504  function get_media_embedded_in_content( $content, $types = null ) {
4505      $html = array();
4506  
4507      /**
4508       * Filters the embedded media types that are allowed to be returned from the content blob.
4509       *
4510       * @since 4.2.0
4511       *
4512       * @param string[] $allowed_media_types An array of allowed media types. Default media types are
4513       *                                      'audio', 'video', 'object', 'embed', and 'iframe'.
4514       */
4515      $allowed_media_types = apply_filters( 'media_embedded_in_content_allowed_types', array( 'audio', 'video', 'object', 'embed', 'iframe' ) );
4516  
4517      if ( ! empty( $types ) ) {
4518          if ( ! is_array( $types ) ) {
4519              $types = array( $types );
4520          }
4521  
4522          $allowed_media_types = array_intersect( $allowed_media_types, $types );
4523      }
4524  
4525      $tags = implode( '|', $allowed_media_types );
4526  
4527      if ( preg_match_all( '#<(?P<tag>' . $tags . ')[^<]*?(?:>[\s\S]*?<\/(?P=tag)>|\s*\/>)#', $content, $matches ) ) {
4528          foreach ( $matches[0] as $match ) {
4529              $html[] = $match;
4530          }
4531      }
4532  
4533      return $html;
4534  }
4535  
4536  /**
4537   * Retrieves galleries from the passed post's content.
4538   *
4539   * @since 3.6.0
4540   *
4541   * @param int|WP_Post $post Post ID or object.
4542   * @param bool        $html Optional. Whether to return HTML or data in the array. Default true.
4543   * @return array A list of arrays, each containing gallery data and srcs parsed
4544   *               from the expanded shortcode.
4545   */
4546  function get_post_galleries( $post, $html = true ) {
4547      $post = get_post( $post );
4548  
4549      if ( ! $post ) {
4550          return array();
4551      }
4552  
4553      if ( ! has_shortcode( $post->post_content, 'gallery' ) ) {
4554          return array();
4555      }
4556  
4557      $galleries = array();
4558      if ( preg_match_all( '/' . get_shortcode_regex() . '/s', $post->post_content, $matches, PREG_SET_ORDER ) ) {
4559          foreach ( $matches as $shortcode ) {
4560              if ( 'gallery' === $shortcode[2] ) {
4561                  $srcs = array();
4562  
4563                  $shortcode_attrs = shortcode_parse_atts( $shortcode[3] );
4564                  if ( ! is_array( $shortcode_attrs ) ) {
4565                      $shortcode_attrs = array();
4566                  }
4567  
4568                  // Specify the post ID of the gallery we're viewing if the shortcode doesn't reference another post already.
4569                  if ( ! isset( $shortcode_attrs['id'] ) ) {
4570                      $shortcode[3] .= ' id="' . (int) $post->ID . '"';
4571                  }
4572  
4573                  $gallery = do_shortcode_tag( $shortcode );
4574                  if ( $html ) {
4575                      $galleries[] = $gallery;
4576                  } else {
4577                      preg_match_all( '#src=([\'"])(.+?)\1#is', $gallery, $src, PREG_SET_ORDER );
4578                      if ( ! empty( $src ) ) {
4579                          foreach ( $src as $s ) {
4580                              $srcs[] = $s[2];
4581                          }
4582                      }
4583  
4584                      $galleries[] = array_merge(
4585                          $shortcode_attrs,
4586                          array(
4587                              'src' => array_values( array_unique( $srcs ) ),
4588                          )
4589                      );
4590                  }
4591              }
4592          }
4593      }
4594  
4595      /**
4596       * Filters the list of all found galleries in the given post.
4597       *
4598       * @since 3.6.0
4599       *
4600       * @param array   $galleries Associative array of all found post galleries.
4601       * @param WP_Post $post      Post object.
4602       */
4603      return apply_filters( 'get_post_galleries', $galleries, $post );
4604  }
4605  
4606  /**
4607   * Check a specified post's content for gallery and, if present, return the first
4608   *
4609   * @since 3.6.0
4610   *
4611   * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post.
4612   * @param bool        $html Optional. Whether to return HTML or data. Default is true.
4613   * @return string|array Gallery data and srcs parsed from the expanded shortcode.
4614   */
4615  function get_post_gallery( $post = 0, $html = true ) {
4616      $galleries = get_post_galleries( $post, $html );
4617      $gallery   = reset( $galleries );
4618  
4619      /**
4620       * Filters the first-found post gallery.
4621       *
4622       * @since 3.6.0
4623       *
4624       * @param array       $gallery   The first-found post gallery.
4625       * @param int|WP_Post $post      Post ID or object.
4626       * @param array       $galleries Associative array of all found post galleries.
4627       */
4628      return apply_filters( 'get_post_gallery', $gallery, $post, $galleries );
4629  }
4630  
4631  /**
4632   * Retrieve the image srcs from galleries from a post's content, if present
4633   *
4634   * @since 3.6.0
4635   *
4636   * @see get_post_galleries()
4637   *
4638   * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`.
4639   * @return array A list of lists, each containing image srcs parsed.
4640   *               from an expanded shortcode
4641   */
4642  function get_post_galleries_images( $post = 0 ) {
4643      $galleries = get_post_galleries( $post, false );
4644      return wp_list_pluck( $galleries, 'src' );
4645  }
4646  
4647  /**
4648   * Checks a post's content for galleries and return the image srcs for the first found gallery
4649   *
4650   * @since 3.6.0
4651   *
4652   * @see get_post_gallery()
4653   *
4654   * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`.
4655   * @return string[] A list of a gallery's image srcs in order.
4656   */
4657  function get_post_gallery_images( $post = 0 ) {
4658      $gallery = get_post_gallery( $post, false );
4659      return empty( $gallery['src'] ) ? array() : $gallery['src'];
4660  }
4661  
4662  /**
4663   * Maybe attempts to generate attachment metadata, if missing.
4664   *
4665   * @since 3.9.0
4666   *
4667   * @param WP_Post $attachment Attachment object.
4668   */
4669  function wp_maybe_generate_attachment_metadata( $attachment ) {
4670      if ( empty( $attachment ) || empty( $attachment->ID ) ) {
4671          return;
4672      }
4673  
4674      $attachment_id = (int) $attachment->ID;
4675      $file          = get_attached_file( $attachment_id );
4676      $meta          = wp_get_attachment_metadata( $attachment_id );
4677  
4678      if ( empty( $meta ) && file_exists( $file ) ) {
4679          $_meta = get_post_meta( $attachment_id );
4680          $_lock = 'wp_generating_att_' . $attachment_id;
4681  
4682          if ( ! array_key_exists( '_wp_attachment_metadata', $_meta ) && ! get_transient( $_lock ) ) {
4683              set_transient( $_lock, $file );
4684              wp_update_attachment_metadata( $attachment_id, wp_generate_attachment_metadata( $attachment_id, $file ) );
4685              delete_transient( $_lock );
4686          }
4687      }
4688  }
4689  
4690  /**
4691   * Tries to convert an attachment URL into a post ID.
4692   *
4693   * @since 4.0.0
4694   *
4695   * @global wpdb $wpdb WordPress database abstraction object.
4696   *
4697   * @param string $url The URL to resolve.
4698   * @return int The found post ID, or 0 on failure.
4699   */
4700  function attachment_url_to_postid( $url ) {
4701      global $wpdb;
4702  
4703      $dir  = wp_get_upload_dir();
4704      $path = $url;
4705  
4706      $site_url   = parse_url( $dir['url'] );
4707      $image_path = parse_url( $path );
4708  
4709      // Force the protocols to match if needed.
4710      if ( isset( $image_path['scheme'] ) && ( $image_path['scheme'] !== $site_url['scheme'] ) ) {
4711          $path = str_replace( $image_path['scheme'], $site_url['scheme'], $path );
4712      }
4713  
4714      if ( 0 === strpos( $path, $dir['baseurl'] . '/' ) ) {
4715          $path = substr( $path, strlen( $dir['baseurl'] . '/' ) );
4716      }
4717  
4718      $sql = $wpdb->prepare(
4719          "SELECT post_id, meta_value FROM $wpdb->postmeta WHERE meta_key = '_wp_attached_file' AND meta_value = %s",
4720          $path
4721      );
4722  
4723      $results = $wpdb->get_results( $sql );
4724      $post_id = null;
4725  
4726      if ( $results ) {
4727          // Use the first available result, but prefer a case-sensitive match, if exists.
4728          $post_id = reset( $results )->post_id;
4729  
4730          if ( count( $results ) > 1 ) {
4731              foreach ( $results as $result ) {
4732                  if ( $path === $result->meta_value ) {
4733                      $post_id = $result->post_id;
4734                      break;
4735                  }
4736              }
4737          }
4738      }
4739  
4740      /**
4741       * Filters an attachment ID found by URL.
4742       *
4743       * @since 4.2.0
4744       *
4745       * @param int|null $post_id The post_id (if any) found by the function.
4746       * @param string   $url     The URL being looked up.
4747       */
4748      return (int) apply_filters( 'attachment_url_to_postid', $post_id, $url );
4749  }
4750  
4751  /**
4752   * Returns the URLs for CSS files used in an iframe-sandbox'd TinyMCE media view.
4753   *
4754   * @since 4.0.0
4755   *
4756   * @return string[] The relevant CSS file URLs.
4757   */
4758  function wpview_media_sandbox_styles() {
4759      $version        = 'ver=' . get_bloginfo( 'version' );
4760      $mediaelement   = includes_url( "js/mediaelement/mediaelementplayer-legacy.min.css?$version" );
4761      $wpmediaelement = includes_url( "js/mediaelement/wp-mediaelement.css?$version" );
4762  
4763      return array( $mediaelement, $wpmediaelement );
4764  }
4765  
4766  /**
4767   * Registers the personal data exporter for media.
4768   *
4769   * @param array[] $exporters An array of personal data exporters, keyed by their ID.
4770   * @return array[] Updated array of personal data exporters.
4771   */
4772  function wp_register_media_personal_data_exporter( $exporters ) {
4773      $exporters['wordpress-media'] = array(
4774          'exporter_friendly_name' => __( 'WordPress Media' ),
4775          'callback'               => 'wp_media_personal_data_exporter',
4776      );
4777  
4778      return $exporters;
4779  }
4780  
4781  /**
4782   * Finds and exports attachments associated with an email address.
4783   *
4784   * @since 4.9.6
4785   *
4786   * @param string $email_address The attachment owner email address.
4787   * @param int    $page          Attachment page.
4788   * @return array An array of personal data.
4789   */
4790  function wp_media_personal_data_exporter( $email_address, $page = 1 ) {
4791      // Limit us to 50 attachments at a time to avoid timing out.
4792      $number = 50;
4793      $page   = (int) $page;
4794  
4795      $data_to_export = array();
4796  
4797      $user = get_user_by( 'email', $email_address );
4798      if ( false === $user ) {
4799          return array(
4800              'data' => $data_to_export,
4801              'done' => true,
4802          );
4803      }
4804  
4805      $post_query = new WP_Query(
4806          array(
4807              'author'         => $user->ID,
4808              'posts_per_page' => $number,
4809              'paged'          => $page,
4810              'post_type'      => 'attachment',
4811              'post_status'    => 'any',
4812              'orderby'        => 'ID',
4813              'order'          => 'ASC',
4814          )
4815      );
4816  
4817      foreach ( (array) $post_query->posts as $post ) {
4818          $attachment_url = wp_get_attachment_url( $post->ID );
4819  
4820          if ( $attachment_url ) {
4821              $post_data_to_export = array(
4822                  array(
4823                      'name'  => __( 'URL' ),
4824                      'value' => $attachment_url,
4825                  ),
4826              );
4827  
4828              $data_to_export[] = array(
4829                  'group_id'          => 'media',
4830                  'group_label'       => __( 'Media' ),
4831                  'group_description' => __( 'User&#8217;s media data.' ),
4832                  'item_id'           => "post-{$post->ID}",
4833                  'data'              => $post_data_to_export,
4834              );
4835          }
4836      }
4837  
4838      $done = $post_query->max_num_pages <= $page;
4839  
4840      return array(
4841          'data' => $data_to_export,
4842          'done' => $done,
4843      );
4844  }
4845  
4846  /**
4847   * Add additional default image sub-sizes.
4848   *
4849   * These sizes are meant to enhance the way WordPress displays images on the front-end on larger,
4850   * high-density devices. They make it possible to generate more suitable `srcset` and `sizes` attributes
4851   * when the users upload large images.
4852   *
4853   * The sizes can be changed or removed by themes and plugins but that is not recommended.
4854   * The size "names" reflect the image dimensions, so changing the sizes would be quite misleading.
4855   *
4856   * @since 5.3.0
4857   * @access private
4858   */
4859  function _wp_add_additional_image_sizes() {
4860      // 2x medium_large size.
4861      add_image_size( '1536x1536', 1536, 1536 );
4862      // 2x large size.
4863      add_image_size( '2048x2048', 2048, 2048 );
4864  }
4865  
4866  /**
4867   * Callback to enable showing of the user error when uploading .heic images.
4868   *
4869   * @since 5.5.0
4870   *
4871   * @param array[] $plupload_settings The settings for Plupload.js.
4872   * @return array[] Modified settings for Plupload.js.
4873   */
4874  function wp_show_heic_upload_error( $plupload_settings ) {
4875      $plupload_settings['heic_upload_error'] = true;
4876      return $plupload_settings;
4877  }