Media > Debug
* is enabled.
*
* @param mixed|string $message The message
* @param string $methodOrFunction __METHOD__ or __FUNCTION__
* @since 4.0.2
* @internal
*/
function wp_rml_debug($message, $methodOrFunction = null)
{
Core::getInstance()->debug($message, $methodOrFunction);
}
}
if (!\function_exists('is_rml_folder')) {
/**
* Checks, if a given variable is an implementation of the
* IFolder interface.
*
* @param int|IFolder $obj Object or int (ID)
* @return boolean
* @internal
*/
function is_rml_folder($obj)
{
return \is_int($obj) ? \is_rml_folder(\wp_rml_get_object_by_id($obj)) : $obj instanceof IFolder;
}
}
if (!\function_exists('wp_rml_get_parent_id')) {
/**
* Get the parent ID of a given folder id.
*
* @param int $id The id of the folder, collection, ...
* @return int or null
* @internal
*/
function wp_rml_get_parent_id($id)
{
$folder = \wp_rml_get_object_by_id($id);
return \is_rml_folder($folder) ? $folder->getParent() : null;
}
}
if (!\function_exists('wp_rml_objects')) {
/**
* Get all available folders, collections, galleries, ...
*
* @return IFolder[]
* @internal
*/
function wp_rml_objects()
{
return Structure::getInstance()->getParsed();
}
}
if (!\function_exists('wp_rml_root_childs')) {
/**
* Gets the first level childs of the media library.
*
* @return IFolder[]
* @internal
*/
function wp_rml_root_childs()
{
return Structure::getInstance()->getTree();
}
}
if (!\function_exists('wp_rml_create')) {
/**
* Creates a folder. At first it checks if a folder in parent already exists.
* Then it checks if the given type is allowed in the parent.
*
* It is highly recommend, to use wp_rml_structure_reset after you created your folders.
*
* @param string $name String Name of the folder
* @param int $parent int ID of the parent (_wp_rml_root() for root)
* @param int $type integer 0|1|2, Folder.inc
* @param string[] $restrictions Restrictions for this folder
* @param boolean $supress_validation Supress the permission validation
* @param boolean $return_existing_id If true and the folder already exists, then return the ID of the existing folder
* @return int|string[] int (ID) when successfully array with error strings
* @throws OnlyInProVersionException
* @since 4.12.1 This function ignores the `$parent` parameter in Lite version as creating subfolders is no longer supported
* @internal
*/
function wp_rml_create($name, $parent, $type, $restrictions = [], $supress_validation = \false, $return_existing_id = \false)
{
return CRUD::getInstance()->create($name, $parent, $type, $restrictions, $supress_validation, $return_existing_id);
}
}
if (!\function_exists('wp_rml_create_p')) {
/**
* (Pro only) Creates multiple folders like "test/test2". At first it checks if a folder in parent already exists.
* Then it checks if the given type is allowed in the parent.
*
* It is highly recommend, to use wp_rml_structure_reset after you created your folders.
*
* @param string $name String Name of the folder
* @param int $parent int ID of the parent (_wp_rml_root() for root)
* @param int $type integer 0|1|2, Folder.inc
* @param string[] $restrictions Restrictions for this folder, it is only applied to first folder
* @param boolean $supress_validation Supress the permission validation
* @return int|string[] int (ID) when successfully array with error strings
* @throws OnlyInProVersionException
* @since 4.12.0
* @since 4.12.1 This function is no longer available in PRO version
* @internal
*/
function wp_rml_create_p($name, $parent, $type, $restrictions = [], $supress_validation = \false)
{
return CRUD::getInstance()->createRecursively($name, $parent, $type, $restrictions, $supress_validation);
}
}
if (!\function_exists('wp_rml_create_or_return_existing_id')) {
/**
* Wrapper function for wp_rml_create.
*
* @param string $name String Name of the folder
* @param int $parent int ID of the parent (_wp_rml_root() for root)
* @param int $type integer 0|1|2, Folder.inc
* @param string[] $restrictions Restrictions for this folder
* @param boolean $supress_validation Supress the permission validation
* @return int|string[] int (ID) when successfully array with error strings
* @since 4.12.1 This function ignores the `$parent` parameter in Lite version as creating subfolders is no longer supported
* @internal
*/
function wp_rml_create_or_return_existing_id($name, $parent, $type, $restrictions = [], $supress_validation = \false)
{
return \wp_rml_create($name, $parent, $type, $restrictions, $supress_validation, \true);
}
}
if (!\function_exists('wp_rml_rename')) {
/**
* Renames a folder and then checks, if there is no duplicate folder in the
* parent folder.
*
* @param string $name String New name of the folder
* @param int $id The ID of the folder
* @param boolean $supress_validation Suppress the permission validation
* @return boolean|string[] true or array with error strings
* @internal
*/
function wp_rml_rename($name, $id, $supress_validation = \false)
{
return CRUD::getInstance()->update($name, $id, $supress_validation);
}
}
if (!\function_exists('wp_rml_delete')) {
/**
* Deletes a folder by ID.
*
* @param int $id The ID of the folder
* @param boolean $supress_validation Supress the permission validation
* @return boolean|string[] True or array with error string
* @internal
*/
function wp_rml_delete($id, $supress_validation = \false)
{
return CRUD::getInstance()->remove($id, $supress_validation);
}
}
if (!\function_exists('wp_rml_update_count')) {
/**
* Handle the count cache for the folders. This should avoid
* a lack SQL subquery which loads data from the postmeta table.
*
* @param int[] $folders Array of folders ID, if null then all folders with cnt NULL are updated
* @param int[] $attachments Array of attachments ID, is merged with $folders if given
* @param boolean $onlyReturn Set to true if you only want the SQL query
* @return string|null
* @internal
*/
function wp_rml_update_count($folders = null, $attachments = null, $onlyReturn = \false)
{
return CountCache::getInstance()->updateCountCache($folders, $attachments, $onlyReturn);
}
}
if (!\function_exists('wp_rml_selector')) {
/**
* This function returns a HTML code (input[type="hidden"]) which gets nicely
* rendered via Javascript (FolderSelector). If you need a more complex implementation
* have a look at FolderSelector.js module.
*
* $options:
* - mixed selected=Root The selected item, "" => "None", _wp_rml_root() => "Root", int => Folder ID
* - int[] disabled Which folder types are disabled
* - boolean nullable=false Defines if null ('') is allowed as value
* - boolean editable=true Define if the selector is editable
* - string name Name for the input
* - string title Title in the modal dialog
*
* @param array $options
* @return string
* @since 4.3
* @internal
*/
function wp_rml_selector($options = [])
{
return Structure::getInstance()->getView()->selector($options);
}
}
if (!\function_exists('wp_rml_dropdown')) {
/**
* This functions returns a HTML formatted string which contains
* options-tag elements with all folders, collections and galleries.
*
* This function should only be used if you want to provide output. For a more
* UX friendly dropdown use wp_rml_selector()!
*
* @param mixed $selected The selected item, "" => "All Files", _wp_rml_root() => "Root", int => Folder ID. Can also be an array for multiple select (since 3.1.2)
* @param int[] $disabled Which folder types are disabled. Default disabled is RML_TYPE_COLLECTION
* @param boolean $useAll boolean Defines, if "All Files" should be showed
* @return string
* @internal
*/
function wp_rml_dropdown($selected, $disabled, $useAll = \true)
{
return Structure::getInstance()->getView()->dropdown($selected, $disabled, $useAll);
}
}
if (!\function_exists('wp_rml_dropdown_collection')) {
/**
* This functions returns a HTML formatted string which contains
* `` elements with all folders, collections and galleries.
* Note: Only COLLECTIONS are SELECTABLE!
*
* This function should only be used if you want to provide output. For a more
* UX friendly dropdown use wp_rml_selector()!
*
* @param mixed $selected The selected item, "" => "All Files", _wp_rml_root() => "Root", int => Folder ID. Can also be an array for multiple select (since 3.1.2)
* @return string
* @internal
*/
function wp_rml_dropdown_collection($selected)
{
return \wp_rml_dropdown($selected, [0, 2, 3, 4]);
}
}
if (!\function_exists('wp_rml_dropdown_gallery')) {
/**
* This functions returns a HTML formatted string which contains
* option-tag elements with all folders, collections and galleries.
* Note: Only GALLERIES are SELECTABLE!
*
* This function should only be used if you want to provide output. For a more
* UX friendly dropdown use wp_rml_selector()!
*
* @param mixed $selected The selected item, "" => "All Files", _wp_rml_root() => "Root", int => Folder ID. Can also be an array for multiple select (since 3.1.2)
* @return string
* @internal
*/
function wp_rml_dropdown_gallery($selected)
{
return \wp_rml_dropdown($selected, [0, 1, 3, 4]);
}
}
if (!\function_exists('wp_rml_dropdown_gallery_or_collection')) {
/**
* This functions returns a HTML formatted string which contains
* option-tag elements with all folders, collections and galleries.
* Note: Only GALLERIES AND COLLECTIONS are SELECTABLE!
*
* @param mixed $selected The selected item, "" => "All Files", _wp_rml_root() => "Root", int => Folder ID. Can also be an array for multiple select (since 3.1.2)
* @return string
* @internal
*/
function wp_rml_dropdown_gallery_or_collection($selected)
{
return \wp_rml_dropdown($selected, [0, 3, 4]);
}
}
if (!\function_exists('wp_rml_is_type')) {
/**
* Determines if a Folder is a special folder type.
*
* @param IFolder|int $folder The folder object
* @param int[] $allowed Which folder types are allowed
* @return boolean
* @internal
*/
function wp_rml_is_type($folder, $allowed)
{
if (!\is_rml_folder($folder)) {
$folder = \wp_rml_get_by_id($folder, null, \true);
if (!\is_rml_folder($folder)) {
return \false;
}
}
return \in_array($folder->getType(), $allowed, \true);
}
}
if (!\function_exists('wp_rml_get_object_by_id')) {
/**
* A shortcut function for the wp_rml_get_by_id function that ensures, that
* a IFolder object is returned. For -1 the root instance is returned.
*
* @param int $id
* @param int[] $allowed
* @return IFolder
* @internal
*/
function wp_rml_get_object_by_id($id, $allowed = null)
{
return \wp_rml_get_by_id($id, $allowed, \true, \false);
}
}
if (!\function_exists('wp_rml_get_by_id')) {
/**
* This functions checks if a specific folder exists by ID and is
* a given allowed RML Folder Type. If the given folder is _wp_rml_root you will
* get the first level folders.
*
* @param int $id Folder ID
* @param int[] $allowed Which folder types are allowed. If null all folder types are allowed.
* @param boolean $mustBeFolderObject Defines if the function may return the wp_rml_root_childs result
* @param boolean $nullForRoot If set to false and $id == -1 then the Root instance is returned
* @return IFolder
* @internal
*/
function wp_rml_get_by_id($id, $allowed = null, $mustBeFolderObject = \false, $nullForRoot = \true)
{
if (!\is_numeric($id)) {
return null;
}
if ($mustBeFolderObject === \false && $id === \_wp_rml_root()) {
return \wp_rml_root_childs();
}
$folder = Structure::getInstance()->byId($id, $nullForRoot);
if (\is_array($allowed)) {
if (!\wp_rml_is_type($folder, $allowed)) {
return null;
}
}
return $folder;
}
}
if (!\function_exists('wp_rml_get_by_absolute_path')) {
/**
* This functions checks if a specific folder exists by absolute path and is
* a given allowed RML Folder Type.
*
* @param string $path Folder Absolute Path
* @param int[] $allowed Which folder types are allowed. If null all folder types are allowed.
* @return IFolder
* @internal
*/
function wp_rml_get_by_absolute_path($path, $allowed = null)
{
$folder = Structure::getInstance()->byAbsolutePath($path);
if (\is_array($allowed)) {
if (!\wp_rml_is_type($folder, $allowed)) {
return null;
}
}
return $folder;
}
}
if (!\function_exists('wp_rml_register_creatable')) {
/**
* Register a new folder type for RML. It does not check if the creatable type
* is already registered.
*
* @param string $qualified The qualified name of the class representing the creatable
* @param int $type The type of the creatable. It must be the same as in yourClass::getType is returned
* @param boolean $onRegister Calls the yourClass::onRegister function
* @internal
*/
function wp_rml_register_creatable($qualified, $type, $onRegister = \false)
{
CRUD::getInstance()->registerCreatable($qualified, $type, $onRegister);
}
}
if (!\function_exists('_wp_rml_root')) {
/**
* Get the parent root folder for a given blog id.
*
* @return int Folder id
* @internal
*/
function _wp_rml_root()
{
/**
* Get the root folder id which is showed in the folder tree.
*
* ```php
* // Get the root folder
* $root = _wp_rml_root();
* ```
*
* @param {int} $folderId=-1 -1 is "Unorganized"
* @param {int} $blogId The current blog id
* @return {int} The root folder id
* @hook RML/ParentRoot
*/
$result = \apply_filters('RML/ParentRoot', -1, \get_current_blog_id());
return (int) $result;
}
}
if (!\function_exists('wp_rml_active')) {
/**
* Checks if RML is active for the current user.
*
* @return boolean
* @since 4.0.2
* @internal
*/
function wp_rml_active()
{
/**
* Checks if RML is active for the current user. Do not use this filter
* yourself, instead use wp_rml_active() function!
*
* @param {boolean} True for activated and false for deactivated
* @return {boolean}
* @hook RML/Active
* @since 3.2
*/
$result = \apply_filters('RML/Active', \current_user_can('upload_files'));
return $result;
}
}
if (!\function_exists('_wp_rml_sanitize')) {
/**
* Sanitize to a valid slug name for a given folder name. If the
* passed folder name contains only invalid characters, then it falls
* back to the base64 encode.
*
* @param string $name The name of the folder
* @param boolean $database If true the name is generated unique from the database slugs
* @param int $exclude
* @return string
* @internal
*/
function _wp_rml_sanitize($name, $database = \false, $exclude = -1)
{
$slug = \sanitize_title(\sanitize_file_name($name));
$slug = empty($slug) ? \base64_encode($name) : $slug;
if ($database && !empty($name)) {
// Get unique slug
global $wpdb;
$core = Core::getInstance();
$table_name = $core->getTableName();
$i = 0;
while (\true) {
// phpcs:disable WordPress.DB.PreparedSQL
$sql = $wpdb->prepare("SELECT COUNT(*) FROM {$table_name} WHERE slug = %s AND id <> %d", $i === 0 ? $slug : $slug . '-' . $i, $exclude);
$var = $wpdb->get_var($sql);
// phpcs:enable WordPress.DB.PreparedSQL
if ($var > 0) {
++$i;
} else {
break;
}
}
$slugOld = $slug;
$slug = $i === 0 ? $slugOld : $slugOld . '-' . $i;
$core->debug("Creating a new slug... check for unique slug '{$slugOld}', use '{$slug}'", __FUNCTION__);
}
return $slug;
}
}
if (!\function_exists('_wp_rml_sanitize_filename')) {
// Internal
/** @internal */
function _wp_rml_sanitize_filename($name)
{
$_name = \sanitize_file_name($name);
return empty($_name) ? \sanitize_file_name(\_wp_rml_sanitize($name)) : $_name;
}
}
if (!\function_exists('wp_rml_structure_reset')) {
/**
* Resets the structure. This function must be called when you create a new folder for example
* and to register it to the structure.
*
* ATTENTION: This function will be declared as deprecated soon, because it is
* planned to automatically reset the structure data / reset folder data (lazy loading
* of Folder objects).
*
* @param int $root The root folder to read the structure
* @param boolean $fetchData Determine if the data should be re-fetched
* @param int $returnId If set this folder is returned
* @return IFolder If $returnId is set
* @internal
*/
function wp_rml_structure_reset($root = null, $fetchData = \true, $returnId = \false)
{
Structure::getInstance()->resetData($root, $fetchData);
if ($returnId !== \false) {
return \wp_rml_get_object_by_id($returnId);
}
}
}
if (!\function_exists('wp_rml_structure')) {
/**
* Get the main working structure.
*
* @return IStructure
* @since 3.3.1
* @internal
*/
function wp_rml_structure()
{
return Structure::getInstance();
}
}
if (!\function_exists('wp_rml_create_all_parents_sql')) {
/**
* Returns a SQL query to get all parents for a folder id.
* The first result for this SQL statement is the first parent and so on...
* Use rmltmp.lvl field for the depth number upwards. To avoid performance lacks
* you should figure out if there is already an action available to search for a meta_key
* in the action RML/$action/AnyParentHasMeta.
*
* $options parameters:
*
"fields" => (string) SELECT fields (default: "rmldata.*, rmltmp.lvl AS lvlup")
* "join" => (string) JOIN statement (default: "")
* "where" => (string) Replace WHERE statement, it is preferred to use afterWhere (default: "rmltmp.lvl > " . ($includeSelf === true ? "-1" : "0"))
* "afterWhere"=> (string) Additional WHERE statement to the above WHERE (default: "")
* "orderby" => (string) ORDER BY statement (default: "rmltmp.lvl ASC")
* "limit" => (string) LIMIT statement (default: "")
*
* Note: The created SQL is supported by all well-known MySQL systems.
*
* @param IFolder|int $folder The folder object or folder id
* @param boolean $includeSelf Set true to include self (passed $folder)
* @param int $until Until this folder id
* @param array $options Additional options for the SQL query, see above
* @return string|boolean SQL query or false if something went wrong
* @internal
*/
function wp_rml_create_all_parents_sql($folder, $includeSelf = \false, $until = null, $options = null)
{
return Util::getInstance()->createSQLForAllParents($folder, $includeSelf, $until, $options);
}
}
if (!\function_exists('wp_rml_all_children_sql_supported')) {
/**
* Checks if the wp_rml_create_all_children_sql() SQL is supported by the current
* used database system. The function itself creates a dummy table and performs
* the SQL and checks if the result is as expected. The "support" result is cached
* site-wide.
*
* @param boolean $force If true the database check is performed again
* @param string $type The type which is minimum required. Possible values: 'function' (MySQL UDF) or 'legacy' (default, old variant)
* @return boolean
* @since 4.0.9
* @internal
*/
function wp_rml_all_children_sql_supported($force = \false, $type = 'legacy')
{
return Core::getInstance()->getActivator()->supportsChildQuery($force, $type);
}
}
if (!\function_exists('wp_rml_create_all_children_sql')) {
/**
* Returns a SQL query to get all children for a folder id.
* The first result for this SQL statement is the first children and so on...
*
* $options parameters:
*
"fields" => (string) SELECT fields (default: "rmldata.*"),
* "join" => (string) JOIN statement (default: ""),
* "where" => (string) Replace WHERE statement, it is preferred to use afterWhere (default: '1=1 ' . ($includeSelf === true ? "" : $wpdb->prepare(" AND rmldata.id != %d", $folderId))),
* "afterWhere" => (string) Additional WHERE statement to the above WHERE (default: ""),
* "orderby" => (string) ORDER BY statement (default: "rmldata.parent, rmldata.ord"),
* "limit" => (string) LIMIT statement (default: "")
*
* Note: Not all database systems do support this kind of SQL query. You have to use the
* wp_rml_all_children_sql_supported() API function to check if it is supported.
*
* @param IFolder|int $folder The folder object or folder id
* @param boolean $includeSelf Set true to include self (passed $folder)
* @param array $options Additional options for the SQL query, see above
* @return string|boolean SQL query or false if something went wrong
* @internal
*/
function wp_rml_create_all_children_sql($folder, $includeSelf = \false, $options = null)
{
return Util::getInstance()->createSQLForAllChildren($folder, $includeSelf, $options);
}
}
if (!\function_exists('wp_rml_last_queried_folder')) {
/**
* Set or get the last queried folder.
*
* @param int $folder The folder id (0 is handled as "All files" folder)
* @return int
* @since 4.0.5
* @internal
*/
function wp_rml_last_queried_folder($folder = null)
{
return Filter::getInstance()->lastQueriedFolder($folder);
}
}