API Reference

Helper functions
object str_get_html ( string $content ) Creates a DOM object from a string.
object file_get_html ( string $filename ) Creates a DOM object from a file or a URL. DOM methods & properties stringplaintext Returns the contents extracted from HTML.
voidclear () Clean up memory.
voidload ( string $content ) Load contents from a string.
stringsave ( [string $filename] ) Dumps the internal DOM tree back into a string. If the $filename is set,result string will save to file.
voidload_file ( string $filename ) Load contents from a from a file or a URL.
voidset_callback ( string $function_name ) Set a callback function.
mixedfind ( string $selector [,int $index] ) Find elements by the CSS selector. Returns the Nth element object if index is set,otherwise return an array of object. Element methods & properties string[attribute] Read or write element's attribure value.
stringtag Read or write the tag name of element.
stringoutertext Read or write the outer HTML text of element.
stringinnertext Read or write the inner HTML text of element.
stringplaintext Read or write the plain text of element.
mixedfind ( string $selector [,int $index] ) Find children by the CSS selector. Returns the Nth element object if index is set,otherwise,return an array of object. DOM traversing mixed$e->children ( [int $index] ) Returns the Nth child object if index is set,otherwise return an array of children.
element$e->parent () Returns the parent of element.
element$e->first_child () Returns the first child of element,or null if not found.
element$e->last_child () Returns the last child of element,or null if not found.
element$e->next_sibling () Returns the next sibling of element,or null if not found.
element$e->prev_sibling () Returns the prevIoUs sibling of element,or null if not found.
Camel naming convertions You can also call methods with W3C STANDARD camel naming convertions.
string$e->getAttribute ( $name ) string$e->attribute
void$e->setAttribute ( $name,$value ) void$value = $e->attribute
bool$e->hasAttribute ( $name ) boolisset($e->attribute)
void$e->removeAttribute ( $name ) void$e->attribute = null
element$e->getElementById ( $id ) mixed$e->find ( "#$id",0 )
mixed$e->getElementsById ( $id [,$index] ) mixed$e->find ( "#$id" [,int $index] )
element$e->getElementByTagName ($name ) mixed$e->find ( $name,0 )
mixed$e->getElementsByTagName ( $name [,$index] ) mixed$e->find ( $name [,int $index] )
element$e->parentNode () element$e->parent ()
mixed$e->childNodes ( [$index] ) mixed$e->children ( [int $index] )
element$e->firstChild () element$e->first_child ()
element$e->lastChild () element$e->last_child ()
element$e->nextSibling () element$e->next_sibling ()
element$e->prevIoUsSibling () element$e->prev_sibling () // Create a DOM object from a string
$html = str_get_html('Hello!'); // Create a DOM object from a URL
$html = file_get_html('http://www.google.com/'); // Create a DOM object from a HTML file
$html = file_get_html('test.htm'); // Create a DOM object
$html = new simple_html_dom(); // Load HTML from a string
$html->load('Hello!'); // Load HTML from a URL
$html->load_file('http://www.google.com/'); // Load HTML from a HTML file
$html->load_file('test.htm');
// Find all anchors,returns a array of element objects
$ret = $html->find('a'); // Find (N)thanchor,returns element object or null if not found(zero based)
$ret = $html->find('a',0); // Find all