Changeset 42704 for trunk/src/wp-includes/media.php

Timestamp:

02/12/2018 09:36:36 PM (7 years ago)

Author:

SergeyBiryukov

Message:

Media: Pass original attribute values to img_caption_shortcode_width filter instead of markup pieces.

Add caption_id to the list of documented [caption] shortcode attributes.

See #34595.

File:

• trunk/src/wp-includes/media.php (modified) (7 diffs)

trunk/src/wp-includes/media.php

@@ -1494 +1494 @@
  * parameter and the content parameter values.
  *
- * The supported attributes for the shortcode are 'id', 'align', 'width', and
- * 'caption'.
+ * The supported attributes for the shortcode are 'id', 'caption_id', 'align',
+ * 'width', 'caption', and 'class'.
  *
  * @since 2.6.0
+ * @since 3.9.0 The `class` attribute was added.
+ * @since 5.0.0 The `caption_id` attribute was added.
  *
  * @param array  $attr {
  *     Attributes of the caption shortcode.
  *
- *     @type string $id      ID of the div element for the caption.
- *     @type string $align   Class name that aligns the caption. Default 'alignnone'. Accepts 'alignleft',
- *                           'aligncenter', alignright', 'alignnone'.
- *     @type int    $width   The width of the caption, in pixels.
- *     @type string $caption The caption text.
- *     @type string $class   Additional class name(s) added to the caption container.
+ *     @type string $id         ID of the image and caption container element, i.e. <figure> or <div>.
+ *     @type string $caption_id ID of the caption element, i.e. <figcaption> or <p>.
+ *     @type string $align      Class name that aligns the caption. Default 'alignnone'. Accepts 'alignleft',
+ *                              'aligncenter', alignright', 'alignnone'.
+ *     @type int    $width      The width of the caption, in pixels.
+ *     @type string $caption    The caption text.
+ *     @type string $class      Additional class name(s) added to the caption container.
  * }
  * @param string $content Shortcode content.
@@ -1559 +1562 @@
 
     if ( $atts['id'] ) {
-        $att_id     = esc_attr( sanitize_html_class( $atts['id'] ) );
-        $atts['id'] = 'id="' . $att_id . '" ';
-
-        if ( ! $atts['caption_id'] ) {
-            $atts['caption_id'] = 'caption-' . str_replace( '_', '-', $att_id );
-        }
+        $atts['id'] = sanitize_html_class( $atts['id'] );
+        $id         = 'id="' . esc_attr( $atts['id'] ) . '" ';
+    }
+
+    if ( $atts['caption_id'] ) {
+        $atts['caption_id'] = sanitize_html_class( $atts['caption_id'] );
+    } elseif ( $atts['id'] ) {
+        $atts['caption_id'] = 'caption-' . str_replace( '_', '-', $atts['id'] );
     }
 
@@ -1570 +1575 @@
 
     if ( $atts['caption_id'] ) {
-        $describedby        = 'aria-describedby="' . $atts['caption_id'] . '" ';
-        $atts['caption_id'] = 'id="' . $atts['caption_id'] . '" ';
+        $caption_id  = 'id="' . esc_attr( $atts['caption_id'] ) . '" ';
+        $describedby = 'aria-describedby="' . esc_attr( $atts['caption_id'] ) . '" ';
     }
 
@@ -1605 +1610 @@
         $html = sprintf(
             '<figure %s%s%sclass="%s">%s%s</figure>',
-            $atts['id'],
+            $id,
             $describedby,
             $style,
@@ -1612 +1617 @@
             sprintf(
                 '<figcaption %sclass="wp-caption-text">%s</figcaption>',
-                $atts['caption_id'],
+                $caption_id,
                 $atts['caption']
             )
@@ -1619 +1624 @@
         $html = sprintf(
             '<div %s%sclass="%s">%s%s</div>',
-            $atts['id'],
+            $id,
             $style,
             esc_attr( $class ),
@@ -1625 +1630 @@
             sprintf(
                 '<p %sclass="wp-caption-text">%s</p>',
-                $atts['caption_id'],
+                $caption_id,
                 $atts['caption']
             )