InfiniteScrolling
in package
implements
IUserSettings
Uses
CommonUserSettingsTrait, UtilsProvider
Add an option so the user can disable the WordPress infinite scrolling.
Tags
Table of Contents
Interfaces
- 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.
Constants
- FIELD_NAME = 'infiniteScrolling'
- MIN_WP_VERSION = '5.8'
- OPTION_NAME = 'rmlInfiniteScrolling'
Methods
- __construct() : mixed
- C'tor.
- content() : string
- Return modified content for the meta box.
- getPluginConstantPrefix() : string
- Get the prefix of this plugin so composer packages can dynamically build other constant values on it.
- isAvailable() : mixed
- Check if this setting should be available to the current WordPress instance.
- isEnabled() : mixed
- save() : array<string|int, 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.
- scripts() : mixed
- Enqueue scripts and styles for this meta box.
- get() : string|bool
- Gets (and persists) a string to the user (settings) metadata.
- is() : bool
- Gets (and persists) a checkbox to the user (settings) metadata.
Constants
FIELD_NAME
public
mixed
FIELD_NAME
= 'infiniteScrolling'
MIN_WP_VERSION
public
mixed
MIN_WP_VERSION
= '5.8'
OPTION_NAME
public
mixed
OPTION_NAME
= 'rmlInfiniteScrolling'
Methods
__construct()
C'tor.
public
__construct() : mixed
content()
Return modified content for the meta box.
public
content(mixed $content, mixed $user) : string
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 : mixed
-
the HTML formatted string for the dialog
- $user : mixed
-
Current user id
Return values
string —Content
getPluginConstantPrefix()
Get the prefix of this plugin so composer packages can dynamically build other constant values on it.
public
getPluginConstantPrefix() : string
Tags
Return values
stringisAvailable()
Check if this setting should be available to the current WordPress instance.
public
isAvailable() : mixed
isEnabled()
public
static isEnabled([mixed $persist = null ]) : mixed
Parameters
- $persist : mixed = null
save()
Save the infos. Add an error to the array to show on the frontend dialog. Add an successful data to receive it in JavaScript.
public
save(mixed $response, mixed $user, mixed $request) : array<string|int, string>
$response["errors"][] = "Your error";
$response["data"]["myData"] = "Test";
Parameters
- $response : mixed
-
Array of errors and successful data.
- $user : mixed
-
Current user id
- $request : mixed
-
The server request
Return values
array<string|int, string>scripts()
Enqueue scripts and styles for this meta box.
public
scripts(mixed $assets) : mixed
Parameters
- $assets : mixed
-
The assets instance so you can enqueue library scripts
get()
Gets (and persists) a string to the user (settings) metadata.
protected
static get(string $meta[, bool $persist = null ]) : string|bool
Parameters
- $meta : string
-
The meta key
- $persist : bool = null
-
If setted it will be updated or deleted
Return values
string|boolis()
Gets (and persists) a checkbox to the user (settings) metadata.
protected
static is(string $meta[, bool $persist = null ]) : bool
Parameters
- $meta : string
-
The meta key
- $persist : bool = null
-
If setted it will be updated or deleted