PHPDoc Real Media Library
  • Namespace
  • Class

Namespaces

  • MatthiasWeb
    • RealMediaLibrary
      • api
  • None

Functions

  • _wp_rml_active
  • _wp_rml_root
  • _wp_rml_sanitize
  • add_media_folder_meta
  • add_rml_meta_box
  • add_rml_user_settings_box
  • delete_media_folder_meta
  • delete_media_folder_meta_by_key
  • get_media_folder_meta
  • is_rml_folder
  • truncate_media_folder_meta
  • update_media_folder_meta
  • wp_attachment_ensure_source_file
  • wp_attachment_folder
  • wp_attachment_get_shortcuts
  • wp_attachment_has_shortcuts
  • wp_attachment_is_shortcut
  • wp_attachment_order_update
  • wp_rml_create
  • wp_rml_create_or_return_existing_id
  • wp_rml_create_shortcuts
  • wp_rml_created_shortcuts_last_ids
  • wp_rml_delete
  • wp_rml_dropdown
  • wp_rml_dropdown_collection
  • wp_rml_dropdown_gallery
  • wp_rml_dropdown_gallery_or_collection
  • wp_rml_get_attachments
  • wp_rml_get_by_absolute_path
  • wp_rml_get_by_id
  • wp_rml_get_object_by_id
  • wp_rml_get_parent_id
  • wp_rml_is_type
  • wp_rml_move
  • wp_rml_objects
  • wp_rml_register_creatable
  • wp_rml_rename
  • wp_rml_root_childs
  • wp_rml_select_tree
  • wp_rml_structure_reset
  • wp_rml_update_count

No namespace

Functions summary

_wp_rml_active Checks if RML is active for the current user.
_wp_rml_root Get the parent root folder for a given blog id.
_wp_rml_sanitize

Sanitize to a valid folder name for a given folder name. If the passed folder name contains only unvalide characters, then it falls back to the base64 encode.

add_media_folder_meta Add meta data field to a folder.
add_rml_meta_box Add a visible content to the folder details dialog.
add_rml_user_settings_box Add a visible content to the general user settings dialog.
delete_media_folder_meta Remove metadata matching criteria from a folder.
delete_media_folder_meta_by_key Delete everything from folder meta matching meta key.
get_media_folder_meta Retrieve folder meta field for a folder.
is_rml_folder

Checks, if a given variable is an implementation of the IFolder interface.

truncate_media_folder_meta Remove all metas of a folder. Use this with caution!!
update_media_folder_meta Update folder meta field based on folder ID.
wp_attachment_ensure_source_file

Checks if a given attachment has already a shortcut in a given folder id or has generelly shortcuts.

wp_attachment_folder

Returns the folder id of an given attachment or more than one attachment (array). If you pass an array as attachment ids, then the default value does not work, only for single queries. When you pass a shortcut attachment id, the folder id for the shortcut is returned.

wp_attachment_get_shortcuts Checks if a given attachment ID has shortcut and returns the shortcut IDs as array.
wp_attachment_has_shortcuts

Checks if a given attachment has already a shortcut in a given folder id or has generelly shortcuts.

wp_attachment_is_shortcut

Checks if a given attachment is a shortcut, use the $returnSourceId parameter to get the source attachment id.

wp_attachment_order_update Moves an attachment before another given attachment in the order table.
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.

wp_rml_create_or_return_existing_id Wrapper function for wp_rml_create().
wp_rml_create_shortcuts

Link/Copy a set of attachments to a specific folder. When the folder has already a given shortcut, the movement for the given attachment will be skipped.

wp_rml_created_shortcuts_last_ids If you create shortcuts you can get the ids for those shortcuts with this function.
wp_rml_delete Deletes a folder by ID.
wp_rml_dropdown

This functions returns a HTML formatted string which contains options-tag elements with all folders, collections and galleries.

wp_rml_dropdown_collection

This functions returns a HTML formatted string which contains

<options>

elements with all folders, collections and galleries. Note: Only COLLECTIONS are SELECTABLE!

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!

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!

wp_rml_get_attachments Reads content of a folder.
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.

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.

wp_rml_get_object_by_id

A shortcut function for the {@link wp_rml_get_by_id) function that ensures, that a IFolder object is returned. For -1 the root instance is returned.

wp_rml_get_parent_id Get the parent ID of a given folder id.
wp_rml_is_type Determines if a Folder is a special folder type.
wp_rml_move Move or create shortcuts of a set of attachments to a specific folder.
wp_rml_objects Get all available folders, collections, galleries, ...
wp_rml_register_creatable

Register a new folder type for RML. It does not check if the creatable type is already registered.

wp_rml_rename

Renames a folder and then checks, if there is no duplicate folder in the parent folder.

wp_rml_root_childs Gets the first level childs of the media library.
wp_rml_select_tree

Returns a .rml-root-list with an given tree. The selected folder id is saved automatically in a hidden input type.

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.

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.

PHPDoc Real Media Library API documentation generated by ApiGen