Overview
  • Namespace
  • Class

Namespaces

  • MatthiasWeb
    • RealMediaLibrary
      • api
      • attachment
      • base
      • comp
        • complexquery
      • folder
      • general
      • metadata
      • order
      • rest
      • usersettings
  • None

Interfaces

  • IFolder
  • IFolderActions
  • IFolderContent
  • IMetadata
  • IStructure
  • IUserSettings

Namespace MatthiasWeb\RealMediaLibrary\api

Interfaces summary

IFolder

This interface provides elementary getter and setter methods for folder objects. All folder types (Folder, Collection, Gallery, ...) have implemented this interface. Also the root ("Unorganized") is a folder and implements this interface. Usually, the root acts as "-1" but you should use the _wp_rml_root() function to get the root id. If this interface does not provide an expected method, yet, have a look at the other API files. For example to create a folder use wp_rml_create().

IFolderActions

This interface provides elementary action methods for folder objects. All folder types (Folder, Collection, Gallery, ...) have implemented this interface. Also the root ("Unorganized") is a folder and implements this interface.

IFolderContent

This interface provides elementary action methods for folder content. All folder types (Folder, Collection, Gallery, ...) have implemented this interface. Also the root ("Unorganized") is a folder and implements this interface.

IMetadata

Metadata content of a folder. The metadata can be changed in the arrow-down icon in the folders sidebar toolbar. To handle metadata for folders you can use the add_media_folder_meta() function.

IStructure

Structure implementation for Real Media Library. It handles all SQL query which reads all folders from the database and "collects" it into one tree. You can modify the structure queries by RML/Tree* filters and extending the MatthiasWeb\RealMediaLibrary\attachment\Structure class (implements IStructure).

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.

API documentation generated by ApiGen