<function>functionname</function> example





 
  func_name
  The func_name purpose
 

 
  &reftitle.description;
  
   
   thereturned typefunc_name
   
   param1typefirstparameter
   
   intsecondparameter
   
   
  
  
   The function description goes here.
  
 

 
  &reftitle.parameters;
  
   
    
     firstparameter
     
      
       Its description
      
     
    
    
     secondparameter
     
      
       Its description
      
     
    
   
  
 

 
  &reftitle.returnvalues;
  
   What this function returns, first on success, then failure.  If simply
   true on success and false on failure, just use &return.success; here.
  
 

 
  &reftitle.errors;
  
   When does this function issue E_* level errors, and/or throw exceptions.
  
 

 
  &reftitle.unicode;
  
   Information specific to unicode, from the PHP 6 changes.
  
 

 
  &reftitle.changelog;
  
   
    
     
      
       &Version;
       &Description;
      
     
     
      
       Enter the version of change here
       
        Describe the change
       
      
     
    
   
  
 

 
  &reftitle.examples;
  
   
    <function>functionname</function> example
    
      Any text that describes the purpose of the example, or what
      goes on in the example should be here. (Inside the  tag, not out).
    
    

]]>
    
    &example.outputs.similar;
    

    
   
  
 

 
  &reftitle.notes;
  
   
    Any notes that don't fit anywhere else should go here.
    90% of the time, notes, warnings or cautions are better placed in the
    parameters section. Consider that before using this section!
   
  
  ¬e.language-construct;
  ¬e.not-bin-safe;
  ¬e.registerglobals;
 

 
  &reftitle.seealso;
  
   
    somefunc
    another_func
    The something appendix