\MatthiasWeb\RealMediaLibrary\metadataDescription

Implements a description field.

Summary

Methods
Properties
Constants
getDescription()
content()
save()
scripts()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

getDescription()

getDescription(integer  $folder_id): string

Get description if set.

Parameters

integer $folder_id

Returns

string

content()

content(string  $content,\MatthiasWeb\RealMediaLibrary\metadata\IFolder  $folder): string

Generate content for meta box.

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

string $content

the HTML formatted string for the dialog

\MatthiasWeb\RealMediaLibrary\metadata\IFolder $folder

The folder object

Returns

string

save()

save(array<mixed,string>  $response,\MatthiasWeb\RealMediaLibrary\metadata\IFolder  $folder,\MatthiasWeb\RealMediaLibrary\metadata\WP_REST_Request  $request): array<mixed,string>

Save content in meta box.

$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

array<mixed,string> $response

Array of errors and successful data.

\MatthiasWeb\RealMediaLibrary\metadata\IFolder $folder

The folder object

\MatthiasWeb\RealMediaLibrary\metadata\WP_REST_Request $request

The server request

Returns

array<mixed,string>

scripts()

scripts(\MatthiasWeb\RealMediaLibrary\metadata\Assets  $assets)

Enqueue scripts.

Parameters

\MatthiasWeb\RealMediaLibrary\metadata\Assets $assets

The assets instance so you can enqueue library scripts