\MatthiasWeb\RealMediaLibrary\apiIUserSettings

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.

Summary

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

Methods

content()

content(string  $content,integer  $user): 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

integer $user

Current user id

Returns

string —

Content

save()

save(array<mixed,string>  $response,integer  $user,\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";

Parameters

array<mixed,string> $response

Array of errors and successful data.

integer $user

Current user id

\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