Inserts a comment into the Word document.

public addComment ( array $options )

This method allows the insertion of a Word comment into the current Word document.

You may fully customize the comment content including all kind of elements like paragraphs of text with sophisticated formatting, images, links or even tables and HTML content.

If one wishes to insert a comment within a complex paragraph one should use this method in combination with the addText method.



An array with the available options.

The possible keys and values of this array are (required options are shown with yellow background):

key Type Description
textDocument mixed This can be a string of text or a WordFragment that will appear in the Word document highlighted or an array with the text and the formatting options (as in the addText method) or a Word fragment.
textComment mixed This is a string of text that will show up in the corresponding footnote or a WordFragment that may include a variety of elements.
textComments array Add multiple comments.
initials string The initial that will be shown in the comment balloon.
author string The name of the author of the comments.
date string A date string as the ones used for the strtotime PHP method.
completed bool False as default, sets the comment as completed. Compatible with MS Word 2013 or newer.
paraId string (HEX value) If null, auto generate it. Comment ID.
pStyle string Paragraph style. Default as CommentTextPHPDOCX.
rStyle string Character style. Default as CommentReferencePHPDOCX.
Code samples

Example #1

The resulting Word document looks like:

Example #2

The resulting Word document looks like:

Release notes
  • phpdocx 14.5:
    • internal IDs set using sequential unique values.
  • phpdocx 13.5:
    • WordFragments in textDocument.
    • pStyle and rStyle options.
  • phpdocx 12.5:
    • multiple comments in the same content.
  • phpdocx 12.0:
    • htmlspecialchars applied in textComment, initials and author options.
  • phpdocx 8.5:
    • completed option.