Hello there!

Getting Started

Plugin Activation

After you have installed the plugin, it is necessary to activate your copy. This will enable the plugin settings and allows you to have direct access to the latest updates and to get support. In order to activate the plugin please follow these steps:

1. Go to [Share-one-Drive] -> [Settings] in the WordPress Admin Dashboard on your website
2. Click on the "Activate" button.
3. A new window will open and you will be redirected to Envato
4. Click on the "Approve" button to activate the plugin
5. Wait while the activation is processed
6. Done!

warning

Is the activation not working? You can manually insert your purchase code by clicking on the 'Or insert your purchasecode manually and press Activate' button.

Usage

Link your Microsoft account(s)

After you have activated the plugin, you can link multiple Cloud accounts to the plugin:

1. Go to [Share-one-Drive] -> [Settings] in the WordPress Admin Dashboard on your website
2. Click on the "Add account" button.
3. A new window will open and you will be redirected to the login page of OneDrive
4. Click on the "Allow" button to authorize the plugin to access your data
5. Wait while the authorization is processed
6. Done!

info_outline

For an easy setup, the plugin is using its own OneDrive App. If you want to use your own OneDrive App, please read the extra instructions.
  Create own App

info_outline

You can link the plugin with multiple account simultaneously and use them together.

warning

If you encounter any issues when trying to use your own App with Share-one-Drive, please fall back on the default App by emptying the App Key & Secret on the Plugins settings page.

Shortcode Builder

Adding Share-one-Drive has never been easier! Although it has an impressive number of options, even beginners will manage to implement the plugin to their wishes with our intuitive workflow. A more detailed explanation of all the options in the Shortcode Builder can be found in this document.

Add module via the Gutenberg Editor

1. Create a new Page/Post or edit an existing one.
2. Open the WP Cloud Plugin section and add a the plugins block
3. Adjust the configuration in the panel on the right by pressing the 'Edit via Module Builder' button.
4. Publish or Update the page and you are finished!

Add module via Divi Page Builder

1. Create a new Page/Post or edit an existing one.
2. Add the plugin block
3. Adjust the module in the configuration panel by pressing the 'Configure module' button or by editing the raw module.
4. Publish or Update the page and you are finished!

Add module via Elementor

1. Create a new Page/Post or edit an existing one.
2. Open the WP Cloud Plugin section and add a the plugins block
3. Adjust the configuration in the panel on the right by pressing the 'Edit via Module Builder' button.
4. Publish or Update the page and you are finished!

Add module via Beaver Builder

1. Create a new Page/Post or edit an existing one.
2. Open the WP Cloud Plugin section and add a the plugins block
3. Adjust the module configuration in the panel by pressing the 'Edit via Module Builder' button.
4. Publish or Update the page and you are finished!

Add module via the Classic Editor

1. Create a new Page/Post or edit an existing one.
2. To open the Shortcode Builder press the first Share-one-Drive button in the toolbar of the Classic Block.
3. Adjust the module in the Shortcode Builder via all the controls and options
4. Press the "Insert Module" button, to add an instance to your Page
5. Publish or Update the page and you are finished!

info_outline

When you are using a 3rd party Page Editor, adding a simple Text Component / Text Block will in most cases give you access to the default MCE Editor with the plugin Shortcode Builder.

info_outline

The plugin has a standalone Shortcode Builder for situations where the Page Editor can't be used. Open it via the [WP Admin Dashboard] -> [Share-one-Drive] -> [Module] menu.

Create Direct Links

To add shared links to your documents, follow these steps:

1. Create a new Page/Post or edit an existing one.
2. Press the second Share-one-Drive button in the toolbar of the Page Editor. If you are not seeing the button, make sure that you are in the 'VISUAL' mode of the Page editor.
3. Navigate to the File of which you want to create a shared link
4. Check the checkbox of the file and press "Insert Link"
5. Publish or Update the page and you are finished!

Embed Documents

To embed single documents on your page, follow these steps:

1. Create a new Page/Post or edit an existing one.
2. Press the last Share-one-Drive button in the toolbar of the Page Editor. If you are not seeing the button, make sure that you are in the 'VISUAL' mode of the Page editor.
3. Navigate to the File which you want to embed
4. Check the checkbox of the file and press "Embed Files"
5. Publish or Update the page and you are finished!

Global Options

All main plugin options can be set via the Share-one-Drive menu page. Most settings will speak for themselves but some others might need some additional information.

Private Folders

Private Folders allow you to link specific WordPress users to specific folders in the cloud. There are two ways you can use this feature: Manually and Automatically. In the Manual mode, you will link your WordPress Users to their own folder on your OneDrive by hand. In the Automatic mode, you let the plugin automatically manage the Private Folders.

Global settings automatically linked Private Folders

warning

The following settings are only used for all modules with automatically linked Private Folders

Setting	Description
Create Private Folders on registration	Automatically create the Private Folders for an user after their registration on the site.
Create all Private Folders the 1st time a module is used	Immediately create all the Private Folders during the first rendering of a module that has the Private Folders feature enabled.
Update Private Folders after profile update	If needed, update the name of the Private Folder for an user after they have updated their profile.
Delete Private Folders after deleting WP User	Try to remove the users Private Folders after their account is deleted.
Name Template	Template used when a Private Folder for an user is created. This template can contain several placeholders like %user_login%, %user_firstname%, %user_lastname%, %user_email%, %display_name%, %ID%, %user_role{key}%, %date_{date_format}%, %date_i18n_{date_format}%, %yyyy-mm-dd%, %hh:mm%, %uniqueID%, %directory_separator% (/). Use %usermeta_{key}% to get your users custom meta value, where {key} is the meta key to retrieve. Use %postmeta_{key}% to get your post custom meta value, where {key} is the meta key to retrieve. Use %date_{date_format}% to get the current time in the specified '{date_format}', where {date_format} needs to be a PHP date format string. %date_i18n_{date_format}% acts the same as %date_{date_format}%, but returns the localised time using the language set for the site. If you want to be able to send notifications to the owner of this folder the template should contain %user_email%.

Global settings automatically linked Private Folders

Setting	Description
"Access Forbidden" Notice	Message that is displayed when an user is visiting a module with the Private Folders feature set to 'Manual' mode while it doesn't have Private Folder linked to its account.

Private Folders in WP Admin Dashboard

The Private Folders feature can also be used in the File Browsers in the WordPress Admin Dashboard. To enable this, go to the tab called 'Private Folders' on the main plugin settings page (Share-one-Drive -> Settings). The behavior of the File Browsers in the Admin section can be changed via the setting "Private Folders in WP Admin Dashboard".

add_filter('shareonedrive_notification_set_template','change_notification_email', 10, 2);

function change_notification_email($template_location, $notification){
    return WP_CONTENT_DIR .'/custom_notifications/default_notification.php';
}

Permissions

The Permissions tab controls who has access to which functionality of the plugin. You can use it (e.g.) to prevent specific administrators to access the plugin settings or disable the Module Builder for certain Editors.

You can set permissions for who can

• change the plugin settings;
• link users to private folders;
• see statistics and reports;
• access the main File Browser;
• add new modules;
• add direct links;
• embed documents.

Statistics

To log all events which are executed by the plugin, Enable the Log Events setting on the Statistics tab. The logged events are accessible via the 'Share-one-Drive' -> 'Reports' menu.

Setting	Description
Log Events	Allow the plugin to register all plugin events.
- Summary Email	Email a summary of all the events that are logged with the plugin.
--- Interval	Select the interval the summary needs to be send.
--- Recipients	Set to which email address(es) the summary should be send.
- Use Webhook	Send automated messages (JSON data) to another application for every event logged by the plugin.
--- Webhook Endpoint URL	The listener URL where the JSON data will be send to.
--- Webhook Secret	The events send to your endpoint will include a signature. You can use this secret to verify that the events were sent by this plugin, not by a third party. See the documentation for more information.
Use Google Analytics tracker	The plugin will send its events to Google Analytics if your Google tracker has been added to your site.

Email summary

The plugin can send an overview of all the events that happend in a certain period. To enable this, the plugin has to log events and Summary Email setting on the Statistics tab should be enabled

The email template is stored in /templates/notifcations/event_summary.php. Don't edit this file directly as it will automatically be overwritten when updating the plugin. Instead, use the shareonedrive_events_set_summary_template filter to modify the location of the template that needs to be used.

Example

add_filter('shareonedrive_events_set_summary_template','change_event_summary_email', 10, 2);

function change_event_summary_email($template_location, $notification){
    return WP_CONTENT_DIR .'/custom_notifications/event_summary.php';
}

Google Analytics

Is the report functionality of the plugin not sufficient for your situation? The plugin can send all download/upload events to Google Analytics.

If you enable this feature, please make sure you already added your Google Analytics web tracking code to your site. In most themes you will have a Custom Script box where you can add your Google Analytics code

All events in the plugin are registered in Google Analytics as 'Events'. So, in your Google Analytics Dashboard you will find this under 'Behavior' -> 'Events' -> 'Overview'

Webhooks

The built in Webhooks function is an easy way to get automated messages based on all events the plugin logs. The plugin can send a JSON object to a by you specified listener URL, containing all information regarding the event that is being logged.

You can enable the Webhook functionality via the Statistics tab under Log Events -> Webhook Endpoint URL.

Available events types:

shareonedrive_previewed_entry, shareonedrive_edited_entry, shareonedrive_downloaded_entry, shareonedrive_streamed_entry, shareonedrive_created_link_to_entry, shareonedrive_renamed_entry, shareonedrive_deleted_entry, shareonedrive_created_entry, shareonedrive_updated_description, shareonedrive_updated_metadata, shareonedrive_moved_entry, shareonedrive_uploaded_entry, shareonedrive_uploaded_failed, shareonedrive_searched, shareonedrive_sent_notification, shareonedrive_error

Example Data:

{
  "total": 1,
  "events": [
    {
      "timestamp": "2022-05-01T00:05:00+00:00",
      "type": "useyourdrive_previewed_entry",
      "description": "John Johnson previewed the file UK Festival Market Report.pdf",
      "data": {
        "entry": {
          "id": "1-y9psKPDJCycz38c2sN_a3lRoO9S",
          "name": "UK Festival Market Report.pdf",
          "mimetype": "application/pdf",
          "size": "2 MB",
          "icon": "https://...",
          "description": "Festival Insights and the UK Festival Awards are proud to release the UK Festival Market Report 2017.",
          "thumbnail": "https://...",
          "preview_url": "https://...",
          "download_url": "https://...",
          "is_dir": false,
          "parent_id": "0By3zfuC9ZTdGZCT1pUd0E",
          "parent_path": "/Path/To/Folder"
        },
        "account": {
          "id": "1030123322434145",
          "name": "Your Account name",
          "email": "[email protected]",
          "image": "https://..."
        }
      },
      "user": {
        "ID": "3",
        "user_login": "John Johnson",
        "user_nicename": "john-johnson",
        "user_email": "[email protected]",
        "display_name": "John Johnson"
      },
      "page": "https://yoursite.com/page"
    },
    {
      "timestamp": "2022-05-01T00:05:01+00:00",
      "type": "shareonedrive_deleted_entry",
      ...
    }
  ]
}

Example Webhook listener (PHP):

// Optional: Prevent replay attacks by ensuring this request has been signed
// recently (+/- 5 minutes). The request timestamp is in ms!
$time_difference = abs((time() - intval($_SERVER['HTTP_X_WPCP_TIMESTAMP'])) / 1000);

if ($time_difference > 300) {
  exit('Invalid request timestamp');
}

// Calculate challenge hash by concatenating the request timestamp with the
// webhook secret with a semicolon in between: "timestamp;secret".
// Hash is created with SHA256 encoded as hexdecimal lowercase string.
$secret = 'your_secret';
$challenge = hash('sha256', $req_timestamp.';'.$secret);

// Calculate request body signature using the challenge hash as secret.
// Signature is a HMAC SHA256 hash encoded as hexdecimal lowercase string.
$req_raw_body = file_get_contents('php://input');
$expected_signature = 'sha256='.hash_hmac('sha256', $req_raw_body, $challenge);

// Compare expected with received signature.
$req_signature = $_SERVER['HTTP_X_WPCP_SIGNATURE'];

if ($expected_signature !== $req_signature) {
  exit('Invalid signature');
}

// Finally, parse the JSON request body and process the received events.
$data = json_decode($req_raw_body, true);

Shortcode Builder

The different plugin views: File Browsers, Galleries, Media Players, Upload Boxes are controlled via modules. The modules can be easily generated via the Shortcode Builder of the plugin which you can find in the WordPress Page Editor. This Shortcode Builder has an impressive number of options which will be explained in this section

Module

On the Module tab select which View you want to use to display your files. Each view has different options available which will automatically become available in the Shortcode Builder.

Advanced Features

Supported Integrations

WooCommerce Integration

Gravity PDF Integration

The free GravityPDF plugin allows you to automatically generate, email and download PDF documents with Gravity Forms. Share-one-Drive extends this plugin and allows you to store the generated PDFs directly on your OneDrive.

1. Download and Install the GravityPDF plugin
2. Head to [Forms] -> [Forms] and select the Gravity Form you want integrated.
3. From the form editor page, hover over the Form Settings menu item and select PDF from the sub-navigation. Finally, click the Add New button to create a PDF.
4. Edit the created PDF template, and go to the Advanced Tab
5. Set the [ONEDRIVE] Export PDF to "Yes"
6. In the [ONEDRIVE] Folder ID, set the ID of the folder where you want to store the generated PDF forms. You can find this ID via the Shortcode Builder by pressing the Create Module button.
7. Press "Update PDF" to save the settings
8. Done!

What is the API for and how can I use it?

The API is a public API that provides a standard set of tools to help developers simplify common tasks when extending the software. It's especially useful because the WP Cloud Plugins makes full use of namespaces, and working directly with our namespaced classes can be alien for developers who aren't accustom to them.

In contrast, our API is in the global scope, can be accessed through the WPCP_ONEDRIVE_API class and uses static methods. You can easily call any method using WPCP_ONEDRIVE_API::method_name(). This allows a lower entry barrier for developers looking to extend our software, while still allowing us to take advantage of more modern PHP techniques to streamline our development.

This section of the documentation goes into detail about the usage of each API method which can be found in the API.php file in the /wp-content/plugins/share-one-drive/includes folder.

API – set_account_by_id()

Description

This method will set the OneDrive account to be used for other API calls.

Parameters

• The OneDrive account ID

Return

• The Account object corresponding to the set Account ID.

Usage

                    
                      $account = WPCP_ONEDRIVE_API::set_account_by_id('8c9bacda0-d8d8-4b22-b634-7b5281687575');

                      // Username
                      $account->get_name(); 

                      // Primary emailaddress
                      $account->get_email(); 

                      // Profile image   
                      $account->get_image(); 

                      // Kind of OneDrive account                   
                      $account->get_type(); 

                      // Storage available & used.
                      $account->get_storage_info(); 
                    
                  

Source Code

This method is located in /includes/API.php.

API – set_drive_by_id()

Description

This method will set which Drive on the OneDrive account will be used for other API calls.

Parameters

• ID of the OneDrive / SharePoint Drive

Return

Usage

                    
                      $account = WPCP_ONEDRIVE_API::set_account_by_id('8c9bacda0-d8d8-4b22-b634-7b5281687575');

                      WPCP_ONEDRIVE_API::set_drive_by_id('b!DlaHWskCed_MIid3KpJH5Lbatf9HsdXBAZH5YcvPAbMhJUKzTJyzgvXZYpBS');
                    
                  

Source Code

This method is located in /includes/API.php.

API – get_entry()

Description

This method will get the metadata for a file/folder by ID.

Parameters

• The ID for file or folder. Please note, the IDs can be the same for different files on different Drives.

Return

• The CacheNode object for the requested file or folder.

Usage

                    
                      WPCP_ONEDRIVE_API::set_account_by_id('8c9bacda0-d8d8-4b22-b634-7b5281687575');
                      WPCP_ONEDRIVE_API::set_drive_by_id('b!DlaHWskCed_MIid3KpJH5Lbatf9HsdXBAZH5YcvPAbMhJUKzTJyzgvXZYpBS');

                      $node = WPCP_ONEDRIVE_API::get_entry('01EXLSWHWMQZNDMLRG7NFIWAVYCFJAXP2R');

                      $node->get_name();
                    
                  

Source Code

This method is located in /includes/API.php.

API – get_folder()

Description

This method will get a specific folder on OneDrive/SharePoint and the files/folders directly inside it.

Parameters

• The ID of the folder that should be loaded.

Return

• The CacheNode object for the requested folder.

Usage

                    
                      WPCP_ONEDRIVE_API::set_account_by_id('8c9bacda0-d8d8-4b22-b634-7b5281687575');
                      WPCP_ONEDRIVE_API::set_drive_by_id('b!DlaHWskCed_MIid3KpJH5Lbatf9HsdXBAZH5YcvPAbMhJUKzTJyzgvXZYpBS');

                      $node = WPCP_ONEDRIVE_API::get_folder('01EXLSWHRCD7RDL3HX65BK5X3ULXLWSICN');
                      
                      $node->get_name();

                      foreach ($node->get_children() as $id => $entry_node) {
                        $entry_node->get_name();
                      }                      
                    
                  

Source Code

This method is located in /includes/API.php.

API – create_folder()

Description

This method will create a new folder in the Cloud.

Parameters

• The name of the folder to be created.

• ID of the folder where the new folder should be created.

Return

• The CacheNode object for the new created folder.

Usage

                    
                      WPCP_ONEDRIVE_API::set_account_by_id('8c9bacda0-d8d8-4b22-b634-7b5281687575');
                      WPCP_ONEDRIVE_API::set_drive_by_id('b!DlaHWskCed_MIid3KpJH5Lbatf9HsdXBAZH5YcvPAbMhJUKzTJyzgvXZYpBS');

                      // Create a new folder
                      $node = WPCP_ONEDRIVE_API::create_folder('Documents', '01EXLSWHRCD7RDL3HX65BK5X3ULXLWSICN');
                    
                  

Source Code

This method is located in /includes/API.php.

API – copy()

Description

This method will copy multiple files to a new location.

Parameters

• ID of the entries that should be copied.

• ID of the folder where the entry should be copied to.

Return

• An array of Entry objects for the copied files/folders.

Usage

                    
                      WPCP_ONEDRIVE_API::set_account_by_id('8c9bacda0-d8d8-4b22-b634-7b5281687575');
                      WPCP_ONEDRIVE_API::set_drive_by_id('b!DlaHWskCed_MIid3KpJH5Lbatf9HsdXBAZH5YcvPAbMhJUKzTJyzgvXZYpBS');

                      $entry_ids = [
                        '01EXLSWHWMQZNDMLRG7NFIWAVYCFJAXP2R',
                        '01EXLSWHW3APNASPERAVGJEAVQAMUNIKF6'
                      ];

                      $copied_nodes = WPCP_ONEDRIVE_API::copy($entry_ids, '01EXLSWHRCD7RDL3HX65BK5X3ULXLWSICN');
                    
                  

Source Code

This method is located in /includes/API.php.

API – move()

Description

This method will move multiple files to a new location.

Parameters

• ID of the entries that should be moved.

• ID of the folder where the entry should be moved to.

• Move or copy the entries. Default: copy = false.

Return

• An array of Entry objects for the moved files/folders.

Usage

                    
                      WPCP_ONEDRIVE_API::set_account_by_id('8c9bacda0-d8d8-4b22-b634-7b5281687575');
                      WPCP_ONEDRIVE_API::set_drive_by_id('b!DlaHWskCed_MIid3KpJH5Lbatf9HsdXBAZH5YcvPAbMhJUKzTJyzgvXZYpBS');

                      $entry_ids = [
                        '01EXLSWHWMQZNDMLRG7NFIWAVYCFJAXP2R',
                        '01EXLSWHW3APNASPERAVGJEAVQAMUNIKF6'
                      ];

                      $moved_nodes = WPCP_ONEDRIVE_API::move($entry_ids, '01EXLSWHRCD7RDL3HX65BK5X3ULXLWSICN');
                    
                  

Source Code

This method is located in /includes/API.php.

API – patch()

Description

Update an file. This can be e.g. used to rename a file.

Parameters

• ID of the entry that should be updated.

• The content that should be patched. E.g. ['name'=>'new_name'].

Return

• The CacheNode object for the patched file.

Usage

                    
                      WPCP_ONEDRIVE_API::set_account_by_id('8c9bacda0-d8d8-4b22-b634-7b5281687575');
                      WPCP_ONEDRIVE_API::set_drive_by_id('b!DlaHWskCed_MIid3KpJH5Lbatf9HsdXBAZH5YcvPAbMhJUKzTJyzgvXZYpBS');

                      // Update request to rename, and add a description
                      $updaterequest = [
                        'name' => 'Another picture.jpg',
                        'description' => 'Nunc sit amet convallis ante, nec molestie leo. Duis quis egestas arcu. Sed lacinia imperdiet tellus et molestie. Nulla at ornare diam, ac pretium augue. '
                      ];

                      // Patch the file or folder
                      $node = WPCP_ONEDRIVE_API::patch('01EXLSWHWMQZNDMLRG7NFIWAVYCFJAXP2R', $updaterequest);
                    
                  

Source Code

This method is located in /includes/API.php.

API – delete()

Description

This method will delete files and folders.

Parameters

• array of IDs that need to be deleted.

Return

• An array of Entry objects for the deleted files/folders.

Usage

                    
                      WPCP_ONEDRIVE_API::set_account_by_id('8c9bacda0-d8d8-4b22-b634-7b5281687575');
                      WPCP_ONEDRIVE_API::set_drive_by_id('b!DlaHWskCed_MIid3KpJH5Lbatf9HsdXBAZH5YcvPAbMhJUKzTJyzgvXZYpBS');

                      $entry_ids = [
                        '01EXLSWHWMQZNDMLRG7NFIWAVYCFJAXP2R',
                        '01EXLSWHW3APNASPERAVGJEAVQAMUNIKF6'
                      ];

                      $deleted_nodes = WPCP_ONEDRIVE_API::delete($entry_ids');
                    
                  

Source Code

This method is located in /includes/API.php.

API – upload_file()

Description

Upload a file to the cloud using a simple file object.

Parameters

• Object containing the file details. Same as file object in $_FILES.

• ID of the upload folder.

• Description for the file.

• Overwrite an existing file with the same name? If false, the file will be renamed.

Return

• The CacheNode object for the uploaded file.

Usage

                    
                      WPCP_ONEDRIVE_API::set_account_by_id('8c9bacda0-d8d8-4b22-b634-7b5281687575');
                      WPCP_ONEDRIVE_API::set_drive_by_id('b!DlaHWskCed_MIid3KpJH5Lbatf9HsdXBAZH5YcvPAbMhJUKzTJyzgvXZYpBS');

                      // File location on server
                      $file_path = '/absolute/path/to/file/on/server.ext';

                      // Create File object
                      $file = (object) [
                          'tmp_path' => $file_path,
                          'type' => mime_content_type($file_path),
                          'name' => 'filename.ext',
                          'size' => filesize($file_path),
                      ];

                      $entry = WPCP_ONEDRIVE_API::upload_file($file, '01EXLSWHRCD7RDL3HX65BK5X3ULXLWSICN', 'A simple description', false);
                    
                  

Source Code

This method is located in /includes/API.php.

API – create_temporarily_download_url()

Description

Create a temporarily download url for a file or folder.

Parameters

• ID of the entry for which you want to create the temporarily download url.

Return

• A temporarily download link for the requested file or folder.

Usage

                    
                      WPCP_ONEDRIVE_API::set_account_by_id('8c9bacda0-d8d8-4b22-b634-7b5281687575');
                      WPCP_ONEDRIVE_API::set_drive_by_id('b!DlaHWskCed_MIid3KpJH5Lbatf9HsdXBAZH5YcvPAbMhJUKzTJyzgvXZYpBS');

                      // Create temporarily download url
                      $temporarily_url = WPCP_ONEDRIVE_API::create_temporarily_download_url('01EXLSWHRCD7RDL3HX65BK5X3ULXLWSICN');

                      // Redirect user to download url
                      header('Location: '.$temporarily_url);
                      exit;
                    
                  

Source Code

This method is located in /includes/API.php.

API – create_preview_url()

Description

Create a preview url for a file. Only available for document formats with OneDrive preview support.

Parameters

• ID of the entry for which you want to create the preview download url.

Return

• A preview url to the file

Usage

                    
                      WPCP_ONEDRIVE_API::set_account_by_id('8c9bacda0-d8d8-4b22-b634-7b5281687575');
                      WPCP_ONEDRIVE_API::set_drive_by_id('b!DlaHWskCed_MIid3KpJH5Lbatf9HsdXBAZH5YcvPAbMhJUKzTJyzgvXZYpBS');

                      // Create preview url
                      $preview_url= WPCP_ONEDRIVE_API::create_preview_url('01EXLSWHWMQZNDMLRG7NFIWAVYCFJAXP2R');
                    
                  

Source Code

This method is located in /includes/API.php.

API – create_shared_url()

Description

Create a shared url for a file or folder. By default, a public shared link will be created. OneDrive Business can request an expiring shared link or set a password.

Parameters

• ID of the entry for which you want to create the shared url.

• Additional sharing permissions. Defaults to:

  
                          $param = [
                            'type' => 'view',
                            'scope' => 'anonymous',
                          ];
                        

Return

• The created shared link.

Usage

                    
                      WPCP_ONEDRIVE_API::set_account_by_id('8c9bacda0-d8d8-4b22-b634-7b5281687575');
                      WPCP_ONEDRIVE_API::set_drive_by_id('b!DlaHWskCed_MIid3KpJH5Lbatf9HsdXBAZH5YcvPAbMhJUKzTJyzgvXZYpBS');

                      $params = [
                          'type' => 'view',
                          'scope' => 'anonymous',
                      ];

                      // Set password
                      // !!! Only available for OneDrive Business
                      $params['password'] = 'mypass1234';

                      // Set expire date
                      // !!! Only available for OneDrive Business
                      $expire_date = current_datetime()->modify('+1 month');
                      $params['unshared_at'] = $expire_date->setTimezone(new \DateTimeZone('UTC'))->format('Y-m-d\TH:i:s\Z');

                      // Create / Get shared links
                      $url = WPCP_ONEDRIVE_API::create_shared_url('01EXLSWHWMQZNDMLRG7NFIWAVYCFJAXP2R', $params);
                    
                  

Source Code

This method is located in /includes/API.php.

API – create_edit_url()

Description

Create an url to an editable view of the file. By default, a public shared link will be created. OneDrive Business can request an expiring shared link or set a password.

Parameters

• ID of the entry for which you want to create the shared url.

• Additional sharing permissions. Defaults to:

  
                          $param = [
                            'type' => 'edit',
                            'scope' => 'anonymous',
                          ];
                        

Return

• The created shared link.

Usage

                    
                      WPCP_ONEDRIVE_API::set_account_by_id('8c9bacda0-d8d8-4b22-b634-7b5281687575');
                      WPCP_ONEDRIVE_API::set_drive_by_id('b!DlaHWskCed_MIid3KpJH5Lbatf9HsdXBAZH5YcvPAbMhJUKzTJyzgvXZYpBS');

                      $params = [
                          'type' => 'edit',
                          'scope' => 'anonymous',
                      ];

                      // Set password
                      // !!! Only available for OneDrive Business
                      $params['password'] = 'mypass1234';

                      // Set expire date
                      // !!! Only available for OneDrive Business
                      $expire_date = current_datetime()->modify('+1 month');
                      $params['unshared_at'] = $expire_date->setTimezone(new \DateTimeZone('UTC'))->format('Y-m-d\TH:i:s\Z');

                      // Create / Get shared links
                      $url = WPCP_ONEDRIVE_API::create_edit_url('01EXLSWHWMQZNDMLRG7NFIWAVYCFJAXP2R', $params);
                    
                  

Source Code

This method is located in /includes/API.php.

Translations

The plugin is multi-language ready and has over 15+ translations in its package. If needed, you can quite easily translate the plugin by yourself. The plugin decides based on the language setting of your WordPress site, which translation it will load.

An easy way to translate the plugin is by using special WordPress Plugin: Loco Translate.

Support

Vulnerabilities

We have an obligation to make and keep our products as safe as possible. Creativity is key with security, and we admit we can’t possibly cover all our bases. That’s why we ask our users and the security community to submit any findings regarding security directly to us. We strive to fix all security vulnerabilities in the WP Cloud Plugins in a timely manner.

Disclosure Policy

Please do not discuss any vulnerabilities (even resolved ones) without express consent.

Submit your report

When you’ve found a security issue, please submit the report to us via a support ticket. In your ticket, make sure to include:

• The impact of the issue.
• A detailed guide on how to reproduce the issue.
• (optional) A screenrecording demonstrating the issue.

After your submission

We will make a best effort to meet the following response targets for security reports:

• Time to first response (from report submit) – 3 business days
• Time to triage (from report submit) – 7 business days

Known vulnerabilities

XSS vulnerability in the search functionality of the plugin. Shout out to Trainer Red for discovering and responsibly disclosing this issue!

Changelog

We are constantly working on a new features and improvements for Share-one-Drive in order to keep your site and your business at the top. In this section you can find information on latest updates we created during lifetime of this plugin.

Version 2.10 19 September 2023

New Features, Settings and Integrations:

• Gravity Forms
  • Added support for the :url modifier for the plugin field Merge Tag. When using this modifier, the Merge Tag will only return the urls of the uploaded files, separated by a (,) for non-HTML formats and a line break for HTML formats.

• Plugin cache could go corrupt when a fatal PHP error happened from another plugin.
• Fixed a couple of PHP 8.2 support issues.

• Translation updates.
• Removed obsolete code using old PHP functions.

• Chart.js to v4.4.0
• Plugin Update Checker to v5.2
• Included CA certificates updated

Version 2.9.2 5 September 2023

New Features, Settings and Integrations:

• Added shareonedrive_do_domain_verification filter to disable checking if AJAX requests come from the same domain.
• Advanced Custom Fields
  • The ACF field now has a setting to control the return value of the field. It defaults to an array of item metadata, and can now also return a string of one of the metadata keys (e.g. a download url).
  • The ACF field now has a setting to control the maximum number of items that can be selected.

• Added Prev/Next buttons in the inline Audio Player for the File Browser module.
• Translation updates
• Added support for WordPress 6.3.1

Version 2.9.1 23 August 2023

New Features, Settings and Integrations:

• Added WooCommerce support for WPC Product Bundles.
• Added shareonedrive_woocommerce_download_module_params filter hook to modify the exact params for the folder download module in WooCommerce.

• Fixed a PHP 8.1 trim() deprecated notice.
• The query parameters for thumbnail URLs that are stored locally were added incorrectly.
• In FireFox, the permissions selection boxes in the shortcode builder did not render.

• Added handlers to delete temporarily files in case requests are terminated unexpectedly and the server can't automatically delete files created by tmpfile().

Version 2.9 5 August 2023

New Features, Settings and Integrations:

• New 'Thumbnail location' setting for Business Accounts allowing you to store thumbnails locally on the server rather than using the API thumbnail urls. The OneDrive Business API thumbnail urls currently can reveal file metadata as well as account data.
• Added the %date_i18n_{date_format}% placeholder to get the localised time in the given PHP {date_format} string using the language set for the site.

• Warnings could be displayed when resetting the cache and deleting locked files.
• Carousel module didn't respect the sort order set in the configuration.
• For modules with the 'shuffle/random' order set, the browser incorrectly cached the data.

• The lazy loading of the images in the carousel module now also works for fast slide changes. This allows you to use the module for e.g. time lapses.
• Added security check to make sure that the plugin only accepts AJAX calls coming from the same domain.

• Chart.js to v4.3.3
• DataTables to v1.13.6
• ZipStream to v2.2.6
• Plugin Update Checker to v5.1

Version 2.8.3 18 July 2023

Bug fixes:

• Search function not always returning search results.
• Existing descriptions not editable in Gallery module.
• Remove URL anchor in deeplinks used in the %file_deeplink_url% placeholder.
• Beaver Builder
  • Module configurator not opening

Version 2.8.2 24 May 2023

New Features, Settings and Integrations:

• Added 'Events per user' report section to show the logged events per user in the selected time period.

• Actions buttons not accessible in 'Flat Dark' Lightbox skin.
• 'Creation date' not always rendered correctly for files.

• The 'Show file size' and 'Show last modified date' settings are now respected by the metadata content displayed by the description buttons (i)

Version 2.8.1 24 May 2023

Bug fixes:

• Extracting email addresses from Private Folder names for email notifications did not work for addresses with a - in the domain name.
• Individual file statistics showing incorrect totals because these were filtered by the main period range selector.

• Made the headers of the Select and Embed modals sticky.

Version 2.8 15 May 2023

New Features, Settings and Integrations:

• Added preview/lightbox functionality for slider module.
• Added 'Keep last modified date' setting in upload configuration.

• Embed functionality incorrectly allowed you to select folders.
• AJAX requests from the modules are not always cached properly, leading to reduced performance of the plugin on sites with high traffic.
• WooCommerce
  • Placeholders for product variations did not work, which could cause the module to crash on products with upload integration enabled.

• Media Player with the autoplay functionality enabled now always shows the volume status if it is muted.
• If multiple modules are added to the page, only add the localised strings for the media player once.
• If using reCaptcha integration, only verify user if not logged in.
• Added a WordPress health check to see if the site can establish a secure connection with API servers.

• Chart.js to v4.3
• DataTables to v1.13.4
• ReCaptcha to v1.3.0
• Tagify to v4.17.8

Version 2.7.3 2 May 2023

New Features, Settings and Integrations:

• Added %wc_item_quantity% placeholder which will output the number of purchased items in a WooCommerce order.
• Added a new 'Logged in user' role for the permissions selector.

• Module Configurator not handling single and double quotes correctly.
• Force the Module Configurator modal in Gutenberg to have a set width/height.
• Email notifications sent to the admin email did not always use the available user metadata in cases where the email address is the same as the 'Administration Email Address' registered for the WordPress site.
• Shuffle action in the Media Player not working as expected.
• Media Player did not load subtitles correctly when you switch between items in a playlist.
• Media Player module search function not searching case insensitive.
• Media Player module not filtering the search results correctly when the list view was used.

• WooCommerce Placeholders are now also available for renaming uploaded files.
• If you are using a direct link, the browser will now scroll the appropriate module into view when the page is loaded.

Version 2.7.2 5 April 2023

New Features, Settings and Integrations:

• The "Who can search" setting has been added to control who is allowed to use the search function in the module.
• Global setting to control if the File Browser module should remember the last opened location.

• Preview events in the Lightbox were not always logged correctly.

Version 2.7.1 29 March 2023

New Features, Settings and Integrations:

• Added support for TinyURL as a URL shortener service.

• The skin of the media module contained an unclosed DOM element.

• A small play icon for video files has been added to the Gallery module.
• The code has been adapted to support different summary email templates for different recipients.
• The Search Box module will no longer display the contents of the top folder when you use an empty search term.

Version 2.7 23 March 2023

New Features, Settings and Integrations:

• New default skin for the Media Player, which introduces a grid view and allows searching in the playlist. In addition, sharing and deep linking to playlist items is now possible. The old skin can still be used by selecting Basic Playlist 2020 skin on the layout tab of the main options page.
• Added a Theme Style option to the module configuration, which allows you to set a color scheme for a specific module that overrides the global theme style.
• New import functionality in the Shortcode Builder that allows you to load the settings of a raw shortcode.
• Added Global 'Radius' and 'Grid Gap' settings to change the appearance of various plugin elements, such as file tiles, modal dialogs and buttons.
• New setting to control the padding between images in the Gallery module.

• Long file names in Gallery module overflowing the image.
• Share action in gallery lightbox shared entire folder instead of item itself.
• Transperancy information was not saved in the color picker.
• Layout issues with dark color scheme.
• When Lightbox was reopened, it could display the contents of the last loaded file before displaying the current file.
• Shortcode Builder failed to check if user is allowed to configure modules.

• Enabled 'Use folders' filters for the audio and media player.
• Sort button added to the Gallery Module.

Version 2.6 13 March 2023

New Features, Settings and Integrations:

• New "Open Lightbox on page load" setting for File Browser and Gallery module to automatically open the lightbox immediately after the module has loaded the content. Can be useful if you want the slideshow to start in full screen when the page opens.

• iFrames in the LightBox that were opened in Safari < 16 were not centred.
• A slider overlay layer was displayed even when there were no descriptions.
• Failed to load subtitles when the playlist is hidden in the Media Player module.
• Media Player module subtitles did not load correctly when using Unicode characters in filename

• The slideshow will now wait for a video to finish before it moves on to the next slide.
• Replaced javascript that calculates the grid in the File Browser module with a CSS grid.

Version 2.5.1 28 February 2023

Bug fixes:

• Navigation header of File Browser modules in the WP Admin Dashboard not showing correctly when using a Dark theme scheme on the Front-End.
• Resolved problems with transients storing data temporarily.

Version 2.5 24 February 2023

New Features, Settings and Integrations:

• New Slider / Carousel module. Effortlessly showcase your cloud-stored images via the responsive slider module.
• New 'Show Header' setting, which can now be used alongside the 'Show Breadcrumb' setting to give more control over the navigation header.

• Slightly revised the layout of the Gallery module to give more focus on the images.
• Updated rendering of date information in file list. The full date & time is still accessible via the information button.
• Minor other layout changes.

• imagesLoaded PACKAGED to v5.0.0

Version 2.4.1 20 February 2023

Bug fixes:

• Embed button in Shortcode Builder not working in list view.
• Incorrect rendering of settings pages and Shortcode Builder when using a RTL language.
• Long file names in report table rows were not displayed correctly.

Version 2.4 3 February 2023

New Features, Settings and Integrations:

• New Reply-To notification setting when you want a reply on a notification to go to an email address that is different than the From: address.
• New module configuration setting 'Use custom name for top folder in breadcrumb'. The plugin will by default replace the first folder name in the breadcrumb with 'Start' or another custom string. Disabling this setting will use the original folder name instead.
• Uncanny Automator - Added New 'File description added' trigger.

• When curl_exec of curl_init are on the list of disabled PHP functions, the plugin cannot communicate with the API and will not run. Till now, the plugin could behave unexpectedly as it didn't check for this.
• Use Template Folder setting in Shortcode Builder not rendered correctly when editing a module configuration using template folders.

• Media Player playlist now scrolls to current item when switching between items.
• HTML attribute loading="lazy" is added for single embedded images/iframes for native lazy loading of the content.

• Included CA certificates updated.

Version 2.3 20 January 2023

New Features, Settings and Integrations:

• New %date_{format}% placeholder to return the current time in the specified '{format}'. {format} needs to be a PHP date format string.
• New 'Display filename on hover' setting for the Grid/Thumbnail view of the File Browser module.
• New setting 'Allow switching between views' for the File Browser module.

• Custom loading image was stretched on mobile devices in case an image with landscape dimensions was used.
• Upload Box module could not start uploads when the module was hidden while the plugin was initiated.
• When a File Browser modules loads the latest position it was on, the cloud account wasn't correctly selected.

• Added file name to the information box in the File Browser module.
• Updated the UI used to manually link Private Folders.
• Changed the way how a thumbnail is shown when hovering over a file in a File Browser in 'List' view.
• Hide Actions menu when there are no actions available.
• Small changes to Mobile layout of File Browser module.
• WooCommerce & Advanced Custom Fields
  • The files/folders selector now remembers the last position when switching between pages, products or creating new ones.
  • The files/folders selector now marks already added files.
  • Not longer possible to add the same file multiple times to the list of files.

• Chart.js library to v4.2

Version 2.2 5 January 2023

New Features, Settings and Integrations:

• Upload Box %queue_index% placeholder for the File Rename, prefixes & suffixes setting which can be used to add a sequential upload index to the file name of uploaded files.
• Media Player now supports SRT subtitles besides VTT. To use subtitles, add them besides the video file with the format video_filename.caption label.language.(vtt|srt). E.g. Topgun.English.en.vtt.
• New setting to disable 'scroll to top' button for module.
• Advanced Custom Fields | Support for %acf_user_{field_name}% and %acf_post_{field_name}% placeholders which will be filled with ACF fields using get_field($fieldname) and the user ID or post ID.

• Subtitle file selection failed when the movie name contained . characters.
• Lightbox not opening correctly when using a direct link on mobile devices.
• Sorting by 'Date of creation' in Media Player module not working as expected.
• Gravity Forms - gform_user_registered hook use to create Private Folders when registering an user via a Gravity Form, was ignoring the global plugins 'Create Private Folders on registration' setting.
• Advanced Custom Fields - Item selector not showing up on WooCommerce product pages.

• Only display a single admin notification when multiple accounts are not longer linked with the plugin.
• Slightly changed the breadcrumb rendering on mobile devices.

• Chart.js library to v4.1.1

Version 2.1.1 8 December 2022

Bug fixes:

• Description texts not accessible in File Browser / LightBox.
• Gravity Forms - Upload field not initiated on the correct place which could cause problems when other plugins want to access the field information early.

• Display thumbnails for uploaded files.

Version 2.1 1 December 2022

New Features, Settings and Integrations:

• New Export/Import functionality for settings, event log and the manually linked Private Folders.
• New Audio Player for playing audio files in File Browser module directly inline.
• New Setting 'Name Template Prefix for anonymous users' to change the default prefix of the Private Folders name for not logged in users. By default, their folder name will be prefixed with "Guests - " so all their folders are grouped together.

• Store dynamic input values for placeholder using the wpcp-use-input-{***} CSS classes on multipage forms.
• Elementor - Do not longer load recaptcha in Elementor page builder.
• WooCommerce Download integration - Modal to select files for digitial products not displaying correctly when their parent DOM container is hidden by other WC plugins.

• Small performance tweaks to reduce the amount of API calls required.

• DataTables library to v1.13.1
• Chart.js library to v4.0.1

Version 2.0.4 22 November 2022

New Features, Settings and Integrations:

• New 'Playlist autoplay' setting which controls if the next item in playlist should start automatically once finished the current one (default: true).
• New floating upload button in File Browser and Gallery modules when Upload Box isn't in the viewport of the browser.

• The permissions selector boxes not loading correctly when the site has users with double quotes in their display name.
• Download button visible in Lightbox for mobile devices for modules without download permission.
• Media Player playlist item not starting when video/audio is stored.
• File Browser module in Shortcode Builder not loading properly when using Private Folders in the Back-End.

Version 2.0.3 18 November 2022

Bug fixes:

• Loading API with account without active authorization could crash the plugin.
• Failing upload events not correctly logged.

Version 2.0.2 14 November 2022

Bug fixes:

• Layout issues in the page editor when the plugin was used in combination with Advanced Custom Fields.
• ShortcodeBuilder and File Embedder popups were loading other site scripts and styles as well.
• Resolved download permissions for Media Players using the deprecated 'linktomedia' parameter.
• Pan/Zoom not working for all images in Lightbox.
• Contact Form 7 - Plugin popup not loading correctly.

Version 2.0.1 10 November 2022

Bug fixes:

• Content in Lightbox showing larger than the viewport.
• Resolved 'use empty array elements in arrays' error in Shortcode Builder causing it to stop working.
• Support package renewal link pointed to the wrong plugin.
• Set CURLOPT_SSLVERSION explicitly to TLS 1.2 or higher as required by Microsoft to improve the security posture of Azure AD.. Uses a fallback for situations where the CURL constants (CURL_SSLVERSION_TLSv1_2) are not defined

• Included CA certificates updated.

Version 2.0 8 November 2022

• New API class to execute most common API calls directly via the plugin.
• New setting to fully customize the file name of uploaded files.
• New setting to show/hide thumbnails inside the Lightbox.
• New setting to set the default click behavior to edit Microsoft Office files.
• New download button in Upload Module for uploads that have finished.
• New shareonedrive_event_added hook which is fired after event has been logged.
• You can now play audio files directly in the File Browser module without opening the Lightbox.
• Added CSS class wpcp-use-input-{***} which can be used in form integrations allowing you to use form field values in placeholders.
• Configurable shared link settings (password / expire date) for OneDrive Business accounts.
• Preview support for HTML and TXT files for OneDrive Business accounts.
• Support for the powerfull Uncanny Automator plugin allowing you to use the plugin events in your workflows.
• Support for custom form field placeholders for use in dynamic folder location (Private Folders name template, subfolder name, etc).
• Support for %file_deeplink_url% placeholder in email notifications. The url will point to the file in the module on the Front-End.
• WooCommerce Download integration - Added support for downloadable folders.

• Search results could include files located in hidden folders.
• Plugin was sending download notifications for streaming events.
• Placeholders %yyyy-mm-dd% and %hh:mm% were using the server timezone rather than your WordPress timezone.
• Getting account storage information for the accountss could fail.
• Zip downloads for Gallery folders not working correctly.
• Webhooks will now only be send for valid URLs.
• PHP Code example to use Custom Event Summary template contained syntax errors.
• Elementor - Compatibility issues for recent versions.
• Formidable Forms - Form input value not rendered correctly when using a multipage configuration.
• Formidable Forms - Upload Box field value can be corrupten when editing/saving entries.
• Formidable Forms - Incorrect field data sanitation.
• GravityPDF -File names no longer automatically prefixed with the entry ID. You can add the ID to the file name template of GravtiyPDF itself.
• WooCommerce Download integration - Downloads not starting correctly when file name contains a # character which breaks the download link.
• WooCommerce Upload integration - Orders could show the list of uploaded files incorrectly.

• Redesigned the Shortcode Builder and all admin pages.
• Gallery module now also support video files (mp4, m4v, ogg, ogv, webm).
• Remember last position opened in File Browser and Gallery modules.
• Remember video/audio position in the Media Player module.
• Shared links no longer automatically created for new uploaded files. You will have to set this explicit in the upload configuration if this functionality is needed.
• Lightbox now uses the full viewport.
• Copy functionality now allows you to copy files and folders to different locations.
• Folder thumbnails in Gallery module are now centered.
• Progress indicators in Upload Module queue now also display the filesize sent sofar.
• Media Player felt 'laggy' when the playlist contained 100+ items.
• WooCommerce Download integration - You can now select multiple files at once when inserting new downloadable files.
• WooCommerce Upload integration - Upload button text is now customizable.
• Many small CSS tweaks and improvements.

• ZipStream library to v2.2.1
• Tagify library to v4.16.4
• DataTables library to v1.12.1
• Chart.js library to v3.9.1
• Several other minor 3rd party libraries.

Changelog for the 1.x branch