Composr API documentation
Back to top  

Functions

Add a bookmark.

add_bookmark(\MEMBER $member, string $folder, string $title, string $page_link) : \AUTO_LINK
package bookmarks

Parameters

$member

\MEMBER

Member who it will belong to

$folder

string

Folder (blank: root)

$title

string

Title/caption

$page_link

string

The page-link or URL

Returns

\AUTO_LINKThe ID

Get the form to add a bookmark / set breadcrumbs.

add_bookmark_form(mixed $post_url) : \Tempcode
package bookmarks

Parameters

$post_url

mixed

Where the form should go to

Returns

\TempcodeThe form

Script to make a bookmark add-form popup.

bookmarks_script() 
package bookmarks

Delete a bookmark.

delete_bookmark(\AUTO_LINK $id, \?MEMBER $member = null) 
package bookmarks

Parameters

$id

\AUTO_LINK

The ID

$member

\?MEMBER

Member who it belongs to (null: do not check)

Edit a bookmark.

edit_bookmark(\AUTO_LINK $id, \MEMBER $member, string $title, string $page_link) 
package bookmarks

Parameters

$id

\AUTO_LINK

The ID

$member

\MEMBER

Member who it belongs to

$title

string

Title/caption

$page_link

string

The page-link