IMetadata
in
Metadata content of a folder. The metadata can be changed in the arrow-down icon in the folders sidebar toolbar. To handle metadata for folders you can use the add_media_folder_meta function.
To register the metadata class you must use the following API function add_rml_meta_box.
Table of Contents
Methods
- content() : string
- Return modified content for the meta box.
- save() : array<string|int, string>
- Save the infos. Add an error to the array to show on the frontend dialog. Add an successful data to receive it in JavaScript.
- scripts() : mixed
- Enqueue scripts and styles for this meta box.
Methods
content()
Return modified content for the meta box.
public
content(string $content, IFolder|null $folder) : string
Note: If you want to use a more complex content in a meta table use something like this:
<tr>
<th scope="row">Medium size</th>
<td><fieldset>
<legend class="screen-reader-text"><span>Medium size</span></legend>
<label for="medium_size_w">Max Width</label>
<input name="medium_size_w" type="number" step="1" min="0" id="medium_size_w" value="300" class="small-text">
<label for="medium_size_h">Max Height</label>
<input name="medium_size_h" type="number" step="1" min="0" id="medium_size_h" value="300" class="small-text">
</fieldset></td>
</tr>
If you want to "group" your meta boxes you can use this code to create a empty space:
<tr class="rml-meta-margin"></tr>
Parameters
- $content : string
-
the HTML formatted string for the dialog
- $folder : IFolder|null
-
The folder object
Return values
stringsave()
Save the infos. Add an error to the array to show on the frontend dialog. Add an successful data to receive it in JavaScript.
public
save(array<string|int, string> $response, IFolder|null $folder, WP_REST_Request $request) : array<string|int, string>
$response["errors"][] = "Your error";
$response["data"]["myData"] = "Test";
Since v.4.0.8 the minimum PHP version is 4.0.8 and you can use traits in your meta implementation: metadata\CommonTrait, metadata\CommonFolderTrait or usersettings\CommonUserSettingsTrait.
Parameters
- $response : array<string|int, string>
-
Array of errors and successful data.
- $folder : IFolder|null
-
The folder object
- $request : WP_REST_Request
-
The server request
Return values
array<string|int, string>scripts()
Enqueue scripts and styles for this meta box.
public
scripts(Assets $assets) : mixed
Parameters
- $assets : Assets
-
The assets instance so you can enqueue library scripts