);
/**
- * Filter the available tabs in the legacy (pre-3.5.0) media popup.
+ * Filters the available tabs in the legacy (pre-3.5.0) media popup.
*
* @since 2.5.0
*
* @param string $title Image title attribute.
* @param string $align Image CSS alignment property.
* @param string $url Optional. Image src URL. Default empty.
- * @param bool|string $rel Optional. Value for rel attribute or whether to add a dafault value. Default false.
+ * @param bool|string $rel Optional. Value for rel attribute or whether to add a default value. Default false.
* @param string|array $size Optional. Image size. Accepts any valid image size, or an array of width
* and height values in pixels (in that order). Default 'medium'.
* @param string $alt Optional. Image alt attribute. Default empty.
$html = '<a href="' . esc_attr( $url ) . '"' . $rel . '>' . $html . '</a>';
/**
- * Filter the image HTML markup to send to the editor.
+ * Filters the image HTML markup to send to the editor.
*
* @since 2.5.0
*
function image_add_caption( $html, $id, $caption, $title, $align, $url, $size, $alt = '' ) {
/**
- * Filter the caption text.
+ * Filters the caption text.
*
* Note: If the caption text is empty, the caption shortcode will not be appended
* to the image HTML when inserted into the editor.
*
* Passing an empty value also prevents the {@see 'image_add_caption_shortcode'}
- * filter from being evaluated at the end of {@see image_add_caption()}.
+ * Filters from being evaluated at the end of image_add_caption().
*
* @since 4.1.0
*
$caption = apply_filters( 'image_add_caption_text', $caption, $id );
/**
- * Filter whether to disable captions.
+ * Filters whether to disable captions.
*
* Prevents image captions from being appended to image HTML when inserted into the editor.
*
$shcode = '[caption id="' . $id . '" align="align' . $align . '" width="' . $width . '"]' . $html . ' ' . $caption . '[/caption]';
/**
- * Filter the image HTML markup including the caption shortcode.
+ * Filters the image HTML markup including the caption shortcode.
*
* @since 2.6.0
*
*
* @since 2.5.0
*
- * @param string $file_id Index of the {@link $_FILES} array that the file was sent. Required.
+ * @param string $file_id Index of the `$_FILES` array that the file was sent. Required.
* @param int $post_id The post ID of a post to attach the media item to. Required, but can
* be set to 0, creating a media item that has no relationship to a post.
* @param array $post_data Overwrite some of the attachment. Optional.
- * @param array $overrides Override the {@link wp_handle_upload()} behavior. Optional.
+ * @param array $overrides Override the wp_handle_upload() behavior. Optional.
* @return int|WP_Error ID of the attachment or a WP_Error object on failure.
*/
function media_handle_upload($file_id, $post_id, $post_data = array(), $overrides = array( 'test_form' => false )) {
}
/**
- * This handles a sideloaded file in the same way as an uploaded file is handled by {@link media_handle_upload()}
+ * Handles a side-loaded file in the same way as an uploaded file is handled by media_handle_upload().
*
* @since 2.6.0
*
- * @param array $file_array Array similar to a {@link $_FILES} upload array
- * @param int $post_id The post ID the media is associated with
- * @param string $desc Description of the sideloaded file
- * @param array $post_data allows you to overwrite some of the attachment
- * @return int|object The ID of the attachment or a WP_Error on failure
+ * @param array $file_array Array similar to a `$_FILES` upload array.
+ * @param int $post_id The post ID the media is associated with.
+ * @param string $desc Optional. Description of the side-loaded file. Default null.
+ * @param array $post_data Optional. Post data to override. Default empty array.
+ * @return int|object The ID of the attachment or a WP_Error on failure.
*/
-function media_handle_sideload($file_array, $post_id, $desc = null, $post_data = array()) {
+function media_handle_sideload( $file_array, $post_id, $desc = null, $post_data = array() ) {
$overrides = array('test_form'=>false);
$time = current_time( 'mysql' );
$img . __( 'Add Media' )
);
/**
- * Filter the legacy (pre-3.5.0) media buttons.
+ * Filters the legacy (pre-3.5.0) media buttons.
+ *
+ * Use {@see 'media_buttons'} action instead.
*
* @since 2.5.0
- * @deprecated 3.5.0 Use 'media_buttons' action instead.
+ * @deprecated 3.5.0 Use {@see 'media_buttons'} action instead.
*
* @param string $string Media buttons context. Default empty.
*/
$upload_iframe_src = add_query_arg('tab', $tab, $upload_iframe_src);
/**
- * Filter the upload iframe source URL for a specific media type.
+ * Filters the upload iframe source URL for a specific media type.
*
* The dynamic portion of the hook name, `$type`, refers to the type
* of media uploaded.
}
/**
- * Filter the attachment fields to be saved.
+ * Filters the attachment fields to be saved.
*
* @since 2.5.0
*
}
/**
- * Filter the HTML markup for a media item sent to the editor.
+ * Filters the HTML markup for a media item sent to the editor.
*
* @since 2.5.0
*
$type = $ext_type;
/**
- * Filter the URL sent to the editor for a specific media type.
+ * Filters the URL sent to the editor for a specific media type.
*
* The dynamic portion of the hook name, `$type`, refers to the type
* of media being sent.
$html = "<img src='" . esc_url($src) . "' alt='$alt'$class />";
/**
- * Filter the image URL sent to the editor.
+ * Filters the image URL sent to the editor.
*
* @since 2.8.0
*
*/
function image_size_input_fields( $post, $check = '' ) {
/**
- * Filter the names and labels of the default image sizes.
+ * Filters the names and labels of the default image sizes.
*
* @since 3.3.0
*
* Filters input from media_upload_form_handler() and assigns a default
* post_title from the file name if none supplied.
*
- * Illustrates the use of the attachment_fields_to_save filter
+ * Illustrates the use of the {@see 'attachment_fields_to_save'} filter
* which can be used to add default values to any field before saving to DB.
*
* @since 2.5.0
}
/**
- * Filter the attachment fields to edit.
+ * Filters the attachment fields to edit.
*
* @since 2.5.0
*
$args = wp_parse_args( $args, $default_args );
/**
- * Filter the arguments used to retrieve an image for the edit image form.
+ * Filters the arguments used to retrieve an image for the edit image form.
*
* @since 3.1.0
*
$media_dims .= "<span id='media-dims-$post->ID'>{$meta['width']} × {$meta['height']}</span> ";
/**
- * Filter the media metadata.
+ * Filters the media metadata.
*
* @since 2.5.0
*
);
/**
- * Filter the media upload post parameters.
+ * Filters the media upload post parameters.
*
* @since 3.1.0 As 'swfupload_post_params'
* @since 3.3.0
}
/**
- * Filter the default Plupload settings.
+ * Filters the default Plupload settings.
*
* @since 3.3.0
*
$form_action_url = admin_url("media-upload.php?type=$type&tab=type&post_id=$post_id");
/**
- * Filter the media upload form action URL.
+ * Filters the media upload form action URL.
*
* @since 2.6.0
*
<div class="media-item media-blank">
<?php
/**
- * Filter the insert media from URL form HTML.
+ * Filters the insert media from URL form HTML.
*
* @since 3.3.0
*
$type_links[] = '<li><a href="' . esc_url(add_query_arg(array('post_mime_type'=>$mime_type, 'paged'=>false))) . '"' . $class . '>' . sprintf( translate_nooped_plural( $label[2], $num_posts[$mime_type] ), '<span id="' . $mime_type . '-counter">' . number_format_i18n( $num_posts[$mime_type] ) . '</span>') . '</a>';
}
/**
- * Filter the media upload mime type list items.
+ * Filters the media upload mime type list items.
*
* Returned values should begin with an `<li>` tag.
*
echo wp_video_shortcode( $attr );
+ else :
+
+ /**
+ * Fires when an attachment type can't be rendered in the edit form.
+ *
+ * @since 4.6.0
+ *
+ * @param WP_Post $post A post object.
+ */
+ do_action( 'wp_edit_form_attachment_display', $post );
+
endif; ?>
</div>
<div class="wp_attachment_details edit-form-section">
}
/**
- * Displays non-editable attachment metadata in the publish metabox
+ * Displays non-editable attachment metadata in the publish meta box.
*
* @since 3.5.0
*/
if ( preg_match( '#^(audio|video)/#', $post->post_mime_type ) ) {
/**
- * Filter the audio and video metadata fields to be shown in the publish meta box.
+ * Filters the audio and video metadata fields to be shown in the publish meta box.
*
* The key for each item in the array should correspond to an attachment
* metadata key, and the value should be the desired label.
}
/**
- * Filter the audio attachment metadata fields to be shown in the publish meta box.
+ * Filters the audio attachment metadata fields to be shown in the publish meta box.
*
* The key for each item in the array should correspond to an attachment
* metadata key, and the value should be the desired label.
}
if ( ! current_user_can( 'edit_post', $parent_id ) ) {
- wp_die( __( 'You are not allowed to edit this post.' ) );
+ wp_die( __( 'Sorry, you are not allowed to edit this post.' ) );
}
$ids = array();
foreach ( (array) $_REQUEST['media'] as $att_id ) {
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff