apply_filters( 'attachment_fields_to_save', array $post , array $attachment )
Filters the attachment fields to be saved.
Contents
Description
See also
Parameters
-
$post
array -
An array of post data.
-
$attachment
array -
An array of attachment metadata.
More Information
The attachment_fields_to_save
filter is used to filter the associated data of images.
By default, it receives the input from the Media Upload screen and provides default values to the post_title
, in case the user hasn’t done so.
It returns the $post
array to be handled by the media_upload_form_handler
function.
A plugin (or theme) can register as a content filter with the code:
<?php add_filter( 'attachment_fields_to_save', 'filter_function_name', 10, 2 ) ?>
Where ‘filter_function_name’ is the function WordPress should call when an attachment is being saved.
Note that the filter function must return the $post
array after it is finished processing.
NOTE: per ticket #30687, any validation errors passed in via $post['errors']
array are silently unset and the attachment is processed without notifying the user
Source
File: wp-admin/includes/media.php
.
View all references
$post = apply_filters( 'attachment_fields_to_save', $post, $attachment );
Changelog
Version | Description |
---|---|
2.5.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
To insert a default caption for images:
(From Codex)
To insert a default caption for images: