What are XML entities and how to define them?

XML entities are used to define reusable values ​​or special characters, avoid duplication and safely include special symbols. 1. Predefined entities represent reserved characters, such as , &, ", '; 2. General entities are used in document content, divided into internal and external; 3. Parameter entities are used in DTD, referenced with %, for modular DTD structure; 4. Entities need to be declared in the DTD, internal entities directly define values, and external entities refer to external files; 5. External entities have XXE security risks and need to be handled with caution.

XML entities are symbolic representations used to define reusable values ​​or special characters within an XML document. They help avoid repetition and allow safe inclusion of characters that might otherwise interfere with XML syntax.

Types of XML Entities

There are several types of entities in XML:

• Predefined entities : These represent special characters that have reserved meanings in XML. For example: for >, & for &, " for ", and ' for '.
• General entities : Used within the document content. They can be internal (defined directly) or external (referencing external files).
• Parameter entities : Used only within the Document Type Definition (DTD), typically to structure or reuse DTD components.

How to Define Entities

Entities are defined in the DTD section of an XML document, either internally or externally.

An internal entity holds a literal value defined inline:

 
  
]>
<note>
  <to>John</to>
  <from>&amp;company;</from>
  <message>Hello from &amp;company;!</message>
</note>

Here, is replaced wherever &company; is used.

An external entity references content from another file:

 
  
]>
<note>
  <to>Jane</to>
  &amp;terms;
</note>

This pulls content from the specified URL or file path.

Parameter entities are referenced within the DTD using % and are useful for modular DTDs:

 
  ">
  %authorInfo;
]>

Key Points to Remember

• Entity names are case-sensitive and must start with a letter.
• Use entities to simplify repeated text or safely include special characters.
• External entities can pose security risks (eg, XXE attacks), so they should be handled carefully in production systems.
• Entities must be declared in the DTD before they are used.

Basically, XML entities make documents cleaner and more maintainable when used appropriately, but require attention to syntax and security.

The above is the detailed content of What are XML entities and how to define them?. For more information, please follow other related articles on the PHP Chinese website!