PHPDoc Real Media Library
  • Namespace
  • Class

Namespaces

  • MatthiasWeb
    • RealMediaLibrary
      • api
  • None

Interfaces

  • IFolder
  • IMetadata
  • IUserSettings

Interface IMetadata

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()

Namespace: MatthiasWeb\RealMediaLibrary\api
Located at IMetadata.interface.php

Methods summary

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

Return modified content for the meta box.

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

$content
the HTML formatted string for the dialog
$folder
The folder object

Returns

string Content
public
# save( array $response, MatthiasWeb\RealMediaLibrary\api\IFolder|null $folder )

Save the infos. Add an error to the array to show on the frontend dialog. Add an successful data to receive it in JavaScript.

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";

Parameters

$response
Array of errors and successful data.
$folder
The folder object

Returns

array Response
public
# scripts( )

Enqueue scripts and styles for this meta box.

Enqueue scripts and styles for this meta box.

Note: This resources are only loaded in the media library.

PHPDoc Real Media Library API documentation generated by ApiGen