rename()

Rename a file or folder

rename()

This method is used to rename a file or folder.

OneDrive

Parameters

Name	Type	Description
$id	string	ID of the entry that should be updated.
$name	string	The new name of the entry.

Return

Name	Type	Description
$node	CachedNode	The 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');

// Patch the file or folder
$node = WPCP_ONEDRIVE_API::rename('01EXLSWHWMQZNDMLRG7NFIWAVYCFJAXP2R', 'Another picture.jpg');

Google Drive

Parameters

Name	Type	Description
$id	string	ID of the entry that should be updated.
$name	string	The new name of the entry.

Return

Name	Type	Description
$node	CachedNode	The object for the patched file.

Usage

WPCP_GDRIVE_API::set_account_by_id('201096615285735764133')

// Patch the file or folder
$node = WPCP_GDRIVE_API::rename('1wzWlDMsZkA4N5yEEAmMigp52u7M0Lk_7', 'Another picture.jpg');

Dropbox

Parameters

Name	Type	Description
$entry	Entry	The entry that should be updated.
$name	string	The new name of the entry.

Return

Name	Type	Description
$node	CachedNode	The object for the patched file.

Usage

WPCP_DROPBOX_API::set_account_by_id('dbid:AADSy6JxzbgqCs4A43CAAAfO9xvZwpcsLU');

// Get metadata for the file or folder
$entry = WPCP_DROPBOX_API::get_entry('id:4tUAwPCAdf0b0AAAAA_iw');

// Rename the file or folder
$entry = WPCP_DROPBOX_API::rename($entry, 'New name.jpg');

Box

Parameters

Name	Type	Description
$id	string	ID of the entry that should be updated.
$name	array	The new name of the entry.
$is_dir	bool	Is the entry a folder or a file?

Return

Name	Type	Description
$node	CachedNode	The object for the patched file.

Usage

WPCP_BOX_API::set_account_by_id('29232154182');

// Patch the file or folder
$node = WPCP_BOX_API::rename('51142665', 'Another picture.jpg', false);