\MatthiasWeb\RealMediaLibrary\metadataMeta

Create general functionality for the custom folder fields.

For an example see the function-doc of this::content_general and this::save_general

Summary

Methods
Properties
Constants
getPluginConstantPrefix()
content()
save()
scripts()
prepare_content()
add()
get()
exists()
folder_deleted()
getInstance()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
__construct()
$me
$view
$boxes
N/A

Properties

$me

$me :

Type

$view

$view :

Type

$boxes

$boxes :

Type

Methods

getPluginConstantPrefix()

getPluginConstantPrefix(): string

Get the prefix of this plugin so composer packages can dynamically build other constant values on it.

Returns

string

content()

content(string  $content,\MatthiasWeb\RealMediaLibrary\api\IFolder|null  $folder): string

Return modified content for the 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\api\IFolder|null $folder

The folder object

Returns

string

save()

save(array<mixed,string>  $response,\MatthiasWeb\RealMediaLibrary\api\IFolder|null  $folder,\WP_REST_Request  $request): array<mixed,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.

$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\api\IFolder|null $folder

The folder object

\WP_REST_Request $request

The server request

Returns

array<mixed,string>

scripts()

scripts(\MatthiasWeb\RealMediaLibrary\Assets  $assets)

Enqueue scripts and styles for this meta box.

Parameters

\MatthiasWeb\RealMediaLibrary\Assets $assets

The assets instance so you can enqueue library scripts

prepare_content()

prepare_content(integer  $fid)

Prepare the whole content for a single meta box.

Parameters

integer $fid

exists()

exists(string  $name): boolean

Check if a meta box exists by name.

Parameters

string $name

Returns

boolean

folder_deleted()

folder_deleted(integer  $fid,mixed  $oldData)

When a folder gets deleted, also delete meta.

Parameters

integer $fid
mixed $oldData

__construct()

__construct()

C'tor.