$object->delete

Name

$object->delete -- Delete a record

Synopsis

boolean $object->delete(void);

Description

Minimum version: Midgard 1.4 (Bifrost)

Is used to delete the record represented by the object. The object must first be instantiated by a call to either mgd_get_XXX or mgd_list_XXX.

Returns true if successfull. Returns false on failure.

Method available for: article, attachment, element, event, event_member, group, host, member, page, pageelement, pagelink, person, preference, sitegroup, snippet, snippetdir, style and topic records.

Example

<?php
  $article = mgd_get_article(123); # article with id 123 will be deleted soon.
  if($article->delete()) {
    echo "Deleted article.<br>\n";
  } else {
    echo "Failed to delete article.<br>\n";
    echo "Reason: " . mgd_errstr();
  }
?>