Overview
  • Namespace
  • Class

Namespaces

  • MatthiasWeb
    • RealMediaLibrary
      • api
      • attachment
      • base
      • comp
        • complexquery
      • folder
      • general
      • metadata
      • order
      • rest
      • usersettings
  • None

Interfaces

  • IFolder
  • IFolderActions
  • IFolderContent
  • IMetadata
  • IStructure
  • IUserSettings

Interface IUserSettings

Metadata content for the general user settings. The metadata can be changed in the cog icon in the folders sidebar toolbar. To handle metadata for general user settings you can use the default wordpress add_user_meta function.

To register the metadata class you must use the following API function add_rml_user_settings_box()

Direct known implementers

MatthiasWeb\RealMediaLibrary\usersettings\Demo

Namespace: MatthiasWeb\RealMediaLibrary\api
Since: 3.2
See: https://developer.wordpress.org/reference/functions/add_user_meta/
Located at api/IUserSettings.interface.php

Methods summary

public
# content( string $content, integer $user )

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
$user
Current user id

Returns

string Content
public
# save( array $response, integer $user, WP_REST_Request $request )

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.
$user
Current user id
$request
The server request

Returns

array Response
public
# scripts( {Assets} $assets )

Enqueue scripts and styles for this meta box.

Enqueue scripts and styles for this meta box.

Parameters

$assets
The assets instance so you can enqueu library scripts
API documentation generated by ApiGen