Media Library Control

PHP Field Configuration Reference

Media Library

Use this config when fieldType is media_library.

1) Base Parameters

Parameter	Required	Type	Default	Choices	Description
fieldType	Yes	string	media_library	media_library	Sets control type.
name	Yes	string			Sets control name. Use snake_case.
fieldLabel	Yes	string			Sets control label.
required	No	bool	false	true, false	Sets control required.
disabled	No	bool	false	true, false	Sets control disabled.
hideLabelFromVision	No	bool	false	true, false	Sets control hide label from vision.
fieldHelpText	No	string			Sets control help text.
className	No	string			Sets control css class name.
fieldLabelPosition	No	string	top	top, left	Sets control label position.
fieldLabelTextTransform	No	string	uppercase	uppercase, capitalize, lowercase	Sets control label text transform.

2) Media Library Specific Parameters

Parameter	Required	Type	Default	Choices	Description
allowedTypes	No	string		image, video, audio, application	JSON array of allowed media types. Leave empty to allow all types. Example: ["image","video"]
multiple	No	bool	false	true, false	Allow selecting multiple files from the media library.

3) PHP Array Schema

Here is an example of how to use the media library control in a post meta configuration:

[
    'fieldType' => 'media_library',
    'name' => 'post_media_library',
    'fieldLabel' => 'Post Media Library',
    'required' => false,
    'disabled' => false,
    'hideLabelFromVision' => false,
    'fieldHelpText' => 'Select a media file.',
    'className' => 'custom-class',
    'fieldLabelPosition' => 'top',
    'fieldLabelTextTransform' => 'uppercase',
    'allowedTypes' => '["image"]',
    'multiple' => false,
]

3) Hook-Based Example (Post Meta Config)

It is available to use this control in post meta fields, term meta fields and user settings page and options page fields.

Available hooks:

• native_custom_fields_post_meta_fields
• native_custom_fields_term_meta_fields
• native_custom_fields_user_meta_fields
• native_custom_fields_options_page_fields

add_filter( 'native_custom_fields_post_meta_fields', function( array $configs ): array {
    $post_type = 'book';

    if ( ! isset( $configs[ $post_type ] ) || ! is_array( $configs[ $post_type ] ) ) {
        $configs[ $post_type ] = [
            'post_type' => $post_type,
            'sections'  => [],
        ];
    }

    $configs[ $post_type ]['sections'][] = [
        'meta_box_id'       => 'post_options',
        'meta_box_title'    => 'Post Options',
        'meta_box_context'  => 'side',
        'meta_box_priority' => 'default',
        'fields'            => [
            [
            'fieldType' => 'media_library',
            'name' => 'post_media_library',
            'fieldLabel' => 'Post Media Library',
            'required' => false,
            'disabled' => false,
            'hideLabelFromVision' => false,
            'fieldHelpText' => 'Select a media file.',
            'className' => 'custom-class',
            'fieldLabelPosition' => 'top',
            'fieldLabelTextTransform' => 'uppercase',
            'allowedTypes' => '["image"]',
            'multiple' => false,
            ],
        ],
    ];

    return $configs;
} );

4) Stored Value Type

Field Type	Meta Value Type
media_library	string (serialized JSON, for example {"id":123,"url":"https://example.com/wp-content/uploads/image.jpg","type":"image","alt":"Image alt text"}) or JSON array if multiple is true