Menu Adam R Brown

WP hooks navigation: Home/browseActions indexFilters index

Source View: disable_captions

To save our bandwidth, we show only a snippet of code around each occurence of the hook. View complete file in SVN (without highlighting).

Understanding Source Code

The best way to understand what a hook does is to look at where it occurs in the source code.

Remember, this hook may occur in more than one file. Moreover, the hook's context may change from version to version.

Source View

This hook occurs 3 times in this file.

Line Code
178       * Filter whether to disable captions.
179       *
180       * Prevents image captions from being appended to image HTML when inserted into the editor.
181       *
182       * @since 2.6.0
183       *
184       * @param bool $bool Whether to disable appending captions. Returning true to the filter
185       *                   will disable captions. Default empty string.
186       */
187      if ( empty($caption) || apply_filters( 'disable_captions', '' ) )
188           return $html;
189
190      $id = ( 0 < (int) $id ) ? 'attachment_' . $id : '';
191
192      if ( ! preg_match( '/width=["\']([0-9]+)/', $html, $matches ) )
193           return $html;
194
195      $width = $matches[1];
196
 
Line Code
2024
2025           if ( '' == f.src.value || '' == t.width )
2026                return false;
2027
2028           if ( f.alt.value )
2029                alt = f.alt.value.replace(/'/g, '&#039;').replace(/"/g, '&quot;').replace(/</g, '&lt;').replace(/>/g, '&gt;');
2030
2031 <?php
2032      /** This filter is documented in wp-admin/includes/media.php */
2033      if ( ! apply_filters( 'disable_captions', '' ) ) {
2034           ?>
2035           if ( f.caption.value ) {
2036                caption = f.caption.value.replace(/\r\n|\r/g, '\n');
2037                caption = caption.replace(/<[a-zA-Z0-9]+( [^<>]+)?>/g, function(a){
2038                     return a.replace(/[\r\n\t]+/, ' ');
2039                });
2040
2041                caption = caption.replace(/\s*\n\s*/g, '<br />');
2042           }
 
Line Code
2452  * Creates the form for external url
2453  *
2454  * @since 2.7.0
2455  *
2456  * @param string $default_view
2457  * @return string the form html
2458  */
2459 function wp_media_insert_url_form( $default_view = 'image' ) {
2460      /** This filter is documented in wp-admin/includes/media.php */
2461      if ( ! apply_filters( 'disable_captions', '' ) ) {
2462           $caption = '
2463           <tr class="image-only">
2464                <th scope="row" class="label">
2465                     <label for="caption"><span class="alignleft">' . __('Image Caption') . '</span></label>
2466                </th>
2467                <td class="field"><textarea id="caption" name="caption"></textarea></td>
2468           </tr>
2469 ';
2470      } else {