1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
<?php
namespace MatthiasWeb\RealMediaLibrary\api;
defined( 'ABSPATH' ) or die( 'No script kiddies please!' );
/**
* 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 {@link add_rml_user_settings_box}
* @see https://developer.wordpress.org/reference/functions/add_user_meta/
*
* @since 3.2
*/
interface IUserSettings {
/**
* Return modified content for the meta box.
*
* <strong>Note:</strong> If you want to use a more complex content
* in a meta table use something like this:
* <code><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></code>
*
* If you want to "group" your meta boxes you can use this code to create a empty space:
* <code><tr class="rml-meta-margin"></tr></code>
*
* @param string $content the HTML formatted string for the dialog
* @param int $user Current user id
* @returns string Content
*/
public function content($content, $user);
/**
* Save the infos. Add an error to the array to show on the frontend dialog. Add an
* successful data to receive it in JavaScript.
*
* <code>$response["errors"][] = "Your error";
* $response["data"]["myData"] = "Test";</code>
*
* @param array $response Array of errors and successful data.
* @param int $user Current user id
* @param WP_REST_Request $request The server request
* @returns array Response
*/
public function save($response, $user, $request);
/**
* Enqueue scripts and styles for this meta box.
*
* @param {Assets} $assets The assets instance so you can enqueu library scripts
*/
public function scripts($assets);
}