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
207       * Filters whether to disable captions.
208       *
209       * Prevents image captions from being appended to image HTML when inserted into the editor.
210       *
211       * @since 2.6.0
212       *
213       * @param bool $bool Whether to disable appending captions. Returning true from the filter
214       *                   will disable captions. Default empty string.
215       */
216      if ( empty( $caption ) || apply_filters( 'disable_captions', '' ) ) {
217           return $html;
218      }
219
220      $id = ( 0 < (int) $id ) ? 'attachment_' . $id : '';
221
222      if ( ! preg_match( '/width=["\']([0-9]+)/', $html, $matches ) ) {
223           return $html;
224      }
225
 
Line Code
2428
2429           if ( '' === f.src.value || '' === t.width )
2430                return false;
2431
2432           if ( f.alt.value )
2433                alt = f.alt.value.replace(/'/g, '&#039;').replace(/"/g, '&quot;').replace(/</g, '&lt;').replace(/>/g, '&gt;');
2434
2435           <?php
2436           /** This filter is documented in wp-admin/includes/media.php */
2437           if ( ! apply_filters( 'disable_captions', '' ) ) {
2438                ?>
2439                if ( f.caption.value ) {
2440                     caption = f.caption.value.replace(/\r\n|\r/g, '\n');
2441                     caption = caption.replace(/<[a-zA-Z0-9]+( [^<>]+)?>/g, function(a){
2442                          return a.replace(/[\r\n\t]+/, ' ');
2443                     });
2444
2445                     caption = caption.replace(/\s*\n\s*/g, '<br />');
2446                }
 
Line Code
2909  * Creates the form for external url
2910  *
2911  * @since 2.7.0
2912  *
2913  * @param string $default_view
2914  * @return string the form html
2915  */
2916 function wp_media_insert_url_form( $default_view = 'image' ) {
2917      /** This filter is documented in wp-admin/includes/media.php */
2918      if ( ! apply_filters( 'disable_captions', '' ) ) {
2919           $caption = '
2920           <tr class="image-only">
2921                <th scope="row" class="label">
2922                     <label for="caption"><span class="alignleft">' . __( 'Image Caption' ) . '</span></label>
2923                </th>
2924                <td class="field"><textarea id="caption" name="caption"></textarea></td>
2925           </tr>';
2926      } else {
2927           $caption = '';