PHPWord

https://github.com/phpoffice/phpword
Admin
PHPWord is a pure PHP library for reading and writing word processing documents, supporting formats...
Tokens:235,241
Snippets:1,810
Trust Score:8.8
License:LGPL-3.0
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Install phpoffice/wmf for Windows metafiles

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/elements/image.md

Installs the optional phpoffice/wmf library required for WMF, EMF, and EMF+ support.

```sh
composer require phpoffice/wmf
```

--------------------------------

### Install dependencies with Composer

Source: https://github.com/phpoffice/phpword/blob/master/CONTRIBUTING.md

Run this command in the PHPWord directory to install project dependencies via Composer.

```bash
composer install
```

--------------------------------

### Image placeholder patterns and setImageValue example

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/template.md

Shows the supported search-pattern models for image placeholders and a PHP example using setImageValue with various options, including a closure for lazy generation.

```clean
${CompanyLogo}
${UserLogo:50:50} ${Name} - ${City} - ${Street}
```

```php
<?php

$templateProcessor = new TemplateProcessor('Template.docx');
$templateProcessor->setValue('Name', 'John Doe');
$templateProcessor->setValue(array('City', 'Street'), array('Detroit', '12th Street'));

$templateProcessor->setImageValue('CompanyLogo', 'path/to/company/logo.png');
$templateProcessor->setImageValue('UserLogo', array('path' => 'path/to/logo.png', 'width' => 100, 'height' => 100, 'ratio' => false));
$templateProcessor->setImageValue('FeatureImage', function () {
    // Closure will only be executed if the replacement tag is found in the template

    return array('path' => SlowFeatureImageGenerator::make(), 'width' => 100, 'height' => 100, 'ratio' => false);
});
```

--------------------------------

### Install PHPWord via Composer

Source: https://github.com/phpoffice/phpword/blob/master/README.md

Use Composer to install the latest stable version of PHPWord.

```sh
composer require phpoffice/phpword
```

--------------------------------

### Install PHPWord development version via Composer

Source: https://github.com/phpoffice/phpword/blob/master/README.md

Use Composer to install the latest unreleased version of PHPWord from the master branch.

```sh
composer require phpoffice/phpword:dev-master
```

--------------------------------

### Complete Ruby Element Setup with addRuby

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/elements/ruby.md

Creates a section, defines RubyProperties (alignment, font sizes, language), creates TextRuns for base and ruby text, and adds the ruby element to the section. Requires a RubyProperties object, a TextRun for base text, and a TextRun for ruby text.

```php
<?php
$phpWord = new PhpWord();

$section = $phpWord->addSection();
$properties = new RubyProperties();
$properties->setAlignment(RubyProperties::ALIGNMENT_RIGHT_VERTICAL);
$properties->setFontFaceSize(10);
$properties->setFontPointsAboveBaseText(4);
$properties->setFontSizeForBaseText(18);
$properties->setLanguageId('ja-JP');

$baseTextRun = new TextRun(null);
$baseTextRun->addText('私');
$rubyTextRun = new TextRun(null);
$rubyTextRun->addText('わたし');

$section->addRuby($baseTextRun, $rubyTextRun, $properties);
```

--------------------------------

### Basic PHPWord usage example

Source: https://github.com/phpoffice/phpword/blob/master/README.md

Create a new PHPWord document, add a section, add text with various font styles, and save the document as OOXML, ODF, and HTML files.

```php
<?php

// Creating the new document...
$phpWord = new \PhpOffice\PhpWord\PhpWord();

/* Note: any element you append to a document must reside inside of a Section. */

// Adding an empty Section to the document...
$section = $phpWord->addSection();
// Adding Text element to the Section having font styled by default...
$section->addText(
    '"Learn from yesterday, live for today, hope for tomorrow. '
        . 'The important thing is not to stop questioning." '
        . '(Albert Einstein)'
);

/*
 * Note: it's possible to customize font style of the Text element you add in three ways:
 * - inline;
 * - using named font style (new font style object will be implicitly created);
 * - using explicitly created font style object.
 */

// Adding Text element with font customized inline...
$section->addText(
    '"Great achievement is usually born of great sacrifice, '
        . 'and is never the result of selfishness." '
        . '(Napoleon Hill)',
    array('name' => 'Tahoma', 'size' => 10)
);

// Adding Text element with font customized using named font style...
$fontStyleName = 'oneUserDefinedStyle';
$phpWord->addFontStyle(
    $fontStyleName,
    array('name' => 'Tahoma', 'size' => 10, 'color' => '1B2232', 'bold' => true)
);
$section->addText(
    '"The greatest accomplishment is not in never falling, '
        . 'but in rising again after you fall." '
        . '(Vince Lombardi)',
    $fontStyleName
);

// Adding Text element with font customized using explicitly created font style object...
$fontStyle = new \PhpOffice\PhpWord\Style\Font();
$fontStyle->setBold(true);
$fontStyle->setName('Tahoma');
$fontStyle->setSize(13);
$myTextElement = $section->addText('"Believe you can and you\'re halfway there." (Theodor Roosevelt)');
$myTextElement->setFontStyle($fontStyle);

// Saving the document as OOXML file...
$objWriter = \PhpOffice\PhpWord\IOFactory::createWriter($phpWord, 'Word2007');
$objWriter->save('helloWorld.docx');

// Saving the document as ODF file...
$objWriter = \PhpOffice\PhpWord\IOFactory::createWriter($phpWord, 'ODText');
$objWriter->save('helloWorld.odt');

// Saving the document as HTML file...
$objWriter = \PhpOffice\PhpWord\IOFactory::createWriter($phpWord, 'HTML');
$objWriter->save('helloWorld.html');

/* Note: we skip RTF, because it's not XML-based and requires a different example. */
/* Note: we skip PDF, because "HTML-to-PDF" approach is used to create PDF documents. */
```

--------------------------------

### Set page numbering start

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/containers.md

Two methods to set the starting page number for a section using the pageNumberingStart style.

```php
<?php

// Method 1
$section = $phpWord->addSection(array('pageNumberingStart' => 1));

// Method 2
$section = $phpWord->addSection();
$section->getStyle()->setPageNumberingStart(1);
```

--------------------------------

### setMacroOpeningChars - Set custom opening macro

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/template.md

Defines a custom opening macro. The example sets '{#' as the opening search pattern.

```php
<?php

$templateProcessor->setMacroOpeningChars('{#');
```

--------------------------------

### Define section style array

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/containers.md

Example of a section style array with orientation, marginTop, and colsNum settings.

```php
<?php

$sectionStyle = array(
    'orientation' => 'landscape',
    'marginTop' => 600,
    'colsNum' => 2,
);
```

--------------------------------

### Set mirror margins with A4 landscape and A5 portrait section

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/introduction.md

Example for printing on A4 paper (landscape) folded into A5 pages (portrait). Requires setting both paper size and page size.

```php
<?php

use PhpOffice\PhpWord\Shared\Converter;

$phpWord->getSettings()->setMirrorMargins(true);
$phpWord->addSection([
    'paperSize' => 'A4',
    'orientation' => 'landscape',
    'pageSizeW' => Converter::cmToTwip(14.85),
    'pageSizeH' => Converter::cmToTwip(21),
]);
```

--------------------------------

### Add PHPWord to composer.json

Source: https://github.com/phpoffice/phpword/blob/master/docs/install.md

Add the phpoffice/phpword package to your composer.json to install via Composer. Use 'dev-master' as the version.

```json
{
    "require": {
        "phpoffice/phpword": "dev-master"
    }
}
```

--------------------------------

### setMacroChars - Set custom opening and closing macros

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/template.md

Defines both opening and closing macros at the same time. The example sets the search pattern like '{#search-pattern#}'.

```php
<?php

$templateProcessor->setMacroChars('{#', '#}');
```

--------------------------------

### Add Title with Ruby (Phonetic Guide) Text

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/elements/ruby.md

Creates a title style, defines RubyProperties, creates TextRuns for base and ruby text, then adds a title containing the ruby element. Requires adding an appropriate title style to the document.

```php
$phpWord = new PhpWord();
$fontStyle = new Font();
$fontStyle->setAllCaps(true);
$fontStyle->setBold(true);
$fontStyle->setSize(24);
$phpWord->addTitleStyle(1, ['name' => 'Arial', 'size' => 24, 'bold' => true, 'color' => '990000']);

$section = $phpWord->addSection();
$properties = new RubyProperties();
$properties->setAlignment(RubyProperties::ALIGNMENT_RIGHT_VERTICAL);
$properties->setFontFaceSize(10);
$properties->setFontPointsAboveBaseText(4);
$properties->setFontSizeForBaseText(18);
$properties->setLanguageId('ja-JP');

$baseTextRun = new TextRun(null);
$baseTextRun->addText('私');
$rubyTextRun = new TextRun(null);
$rubyTextRun->addText('わたし');

$textRun = new TextRun();
$textRun->addRuby($baseTextRun, $rubyTextRun, $properties);
$section->addTitle($textRun, 1);
```

--------------------------------

### Set footnote properties on a section

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/elements/note.md

Configure footnote numbering by setting FootnoteProperties on the section. Options include position, number format, start number, and restart behavior. Defaults are pageBottom, decimal, start at 1, and continuous.

```php
<?php

$fp = new \PhpOffice\PhpWord\ComplexType\FootnoteProperties();
//sets the position of the footnote (pageBottom (default), beneathText, sectEnd, docEnd)
$fp->setPos(\PhpOffice\PhpWord\ComplexType\FootnoteProperties::POSITION_BENEATH_TEXT);
//set the number format to use (decimal (default), upperRoman, upperLetter, ...)
$fp->setNumFmt(\PhpOffice\PhpWord\SimpleType\NumberFormat::LOWER_ROMAN);
//force starting at other than 1
$fp->setNumStart(2);
//when to restart counting (continuous (default), eachSect, eachPage)
$fp->setNumRestart(\PhpOffice\PhpWord\ComplexType\FootnoteProperties::RESTART_NUMBER_EACH_PAGE);
//And finaly, set it on the Section
$section->setFootnoteProperties($fp);
```

--------------------------------

### Set hyphenationZone using cmToTwip

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/introduction.md

Sets the hyphenation zone in twips. The example uses 1 cm converted to twips. Smaller zone means more hyphenation.

```php
<?php

$phpWord->getSettings()->setHyphenationZone(\PhpOffice\PhpWord\Shared\Converter::cmToTwip(1));
```

--------------------------------

### Set track changes on text elements

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/elements/trackchanges.md

Creates a new PHPWord document, adds a section and a text run, then adds text elements with change tracking. Uses setChangeInfo() for inserted and deleted changes, and setTrackChange() for an inserted change. The example shows how to specify author and timestamp for each change.

```php
<?php

$phpWord = new \PhpOffice\PhpWord\PhpWord();

// New portrait section
$section = $phpWord->addSection();
$textRun = $section->addTextRun();

$text = $textRun->addText('Hello World! Time to ');

$text = $textRun->addText('wake ', array('bold' => true));
$text->setChangeInfo(TrackChange::INSERTED, 'Fred', time() - 1800);

$text = $textRun->addText('up');
$text->setTrackChange(new TrackChange(TrackChange::INSERTED, 'Fred'));

$text = $textRun->addText('go to sleep');
$text->setChangeInfo(TrackChange::DELETED, 'Barney', new \DateTime('@' . (time() - 3600)));
```

--------------------------------

### Convert measurement units to twips

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/introduction.md

Use the Converter class to convert points, inches, and centimeters to twips for use in styles and section margins. The example sets a paragraph style with spaceAfter in points, and section margins in inches and centimeters.

```php
<?php

// Paragraph with 6 points space after
$phpWord->addParagraphStyle('My Style', array(
    'spaceAfter' => \PhpOffice\PhpWord\Shared\Converter::pointToTwip(6))
);

$section = $phpWord->addSection();
$sectionStyle = $section->getStyle();
// half inch left margin
$sectionStyle->setMarginLeft(\PhpOffice\PhpWord\Shared\Converter::inchToTwip(.5));
// 2 cm right margin
$sectionStyle->setMarginRight(\PhpOffice\PhpWord\Shared\Converter::cmToTwip(2));
```

--------------------------------

### Track changes on added text with setChanged

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/elements/text.md

Marks added text as INSERTED or DELETED by a specific user at a given time. The example sets the change type to INSERTED for user 'Fred' at the current time.

```php
<?php

$text = $section->addText('Hello World!');
$text->setChanged(\PhpOffice\PhpWord\Element\ChangedElement::TYPE_INSERTED, 'Fred', (new \DateTime()));
```

--------------------------------

### setComplexBlock - Replace macro with Table

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/template.md

Replaces a ${macro} with a ComplexType, such as a Table. The example builds a 2x3 table with green borders and sets it as a complex block.

```php
<?php

$table = new Table(array('borderSize' => 12, 'borderColor' => 'green', 'width' => 6000, 'unit' => TblWidth::TWIP));
$table->addRow();
$table->addCell(150)->addText('Cell A1');
$table->addCell(150)->addText('Cell A2');
$table->addCell(150)->addText('Cell A3');
$table->addRow();
$table->addCell(150)->addText('Cell B1');
$table->addCell(150)->addText('Cell B2');
$table->addCell(150)->addText('Cell B3');
$templateProcessor->setComplexBlock('table', $table);
```

--------------------------------

### Add a field using $section->addField()

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/elements/field.md

Shows the basic signature for adding a field to a section. The $fontStyle parameter refers to the Font style. See the Field class for available properties and options; custom options must start with a backslash.

```php
<?php

$section->addField($fieldType, [$properties], [$options], [$fieldText], [$fontStyle])

```

--------------------------------

### Add INDEX field with TextRun and options

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/elements/field.md

Demonstrates adding an XE field with a simple string or a formatted TextRun, then adding an INDEX field with options. Also shows adding a REF field to a bookmark with options. The INDEX field text includes a note to right-click to update.

```php
<?php

// the $fieldText can be either a simple string
$fieldText = 'The index value';

// or a 'TextRun', to be able to format the text you want in the index
$fieldText = new TextRun();
$fieldText->addText('My ');
$fieldText->addText('bold index', ['bold' => true]);
$fieldText->addText(' entry');
$section->addField('XE', array(), array(), $fieldText);

// this actually adds the index
$section->addField('INDEX', array(), array('\e "	" \h "A" \c "3"'), 'right click to update index');

// Adding reference to a bookmark
$fieldText->addField('REF', [
    'name' => 'bookmark'
], [
    'InsertParagraphNumberRelativeContext',
    'CreateHyperLink',
]);

```

--------------------------------

### Create WPS writer with IOFactory

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/writers.md

Creates a WPS writer and saves the document to sample.wps.

```php
<?php

$writer = IOFactory::createWriter($oPhpWord, 'WPS');
$writer->save(__DIR__ . '/sample.wps');
```

--------------------------------

### Create PDF writer with IOFactory

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/writers.md

Creates a PDF writer and saves the document to sample.pdf.

```php
<?php

$writer = IOFactory::createWriter($oPhpWord, 'PDF');
$writer->save(__DIR__ . '/sample.pdf');
```

--------------------------------

### addPreserveText

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/elements/preservetext.md

Example of using the addPreserveText method to add page numbers or page counts to headers or footers.

```APIDOC
## addPreserveText

### Description
Adds a page number or page count to headers or footers using the `addPreserveText` method.

### Method
`addPreserveText`

### Parameters
- **text** (string) - Required - The text to add, which may include placeholders like `{PAGE}` and `{NUMPAGES}`.

### Request Example
```php
$footer->addPreserveText('Page {PAGE} of {NUMPAGES}.');
```

### Response
No return value is documented.
```

--------------------------------

### Create HTML writer with IOFactory

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/writers.md

Creates an HTML writer and saves the document to sample.html.

```php
<?php

$writer = IOFactory::createWriter($oPhpWord, 'HTML');
$writer->save(__DIR__ . '/sample.html');
```

--------------------------------

### Read MsDoc file with IOFactory::createReader('MsDoc')

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/readers.md

Creates an MsDoc reader and loads a sample .doc file. The reader name is 'MsDoc'.

```php
<?php

$reader = IOFactory::createReader('MsDoc');
$reader->load(__DIR__ . '/sample.doc');
```

--------------------------------

### Adding images with styles, footer, textrun, and data

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/elements/image.md

Shows various ways to add images: with style options, in a footer, in a textrun with alt text, and from image data read via file_get_contents.

```php
<?php

$section = $phpWord->addSection();
$section->addImage(
    'mars.jpg',
    array(
        'width'         => 100,
        'height'        => 100,
        'marginTop'     => -1,
        'marginLeft'    => -1,
        'wrappingStyle' => 'behind'
    )
);
$footer = $section->addFooter();
$footer->addImage('http://example.com/image.php');
$textrun = $section->addTextRun();
$textrun->addImage('http://php.net/logo.jpg', null, false, null, 'PHP logo');
$source = file_get_contents('/path/to/my/images/earth.jpg');
$image = $textrun->addImage($source);
```

--------------------------------

### Read HTML file with IOFactory::createReader('HTML')

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/readers.md

Creates an HTML reader and loads a sample HTML file. The reader name is 'HTML'.

```php
<?php

$reader = IOFactory::createReader('HTML');
$reader->load(__DIR__ . '/sample.html');
```

--------------------------------

### setMacroClosingChars - Set custom closing macro

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/template.md

Defines a custom closing macro. The example sets '#}' as the closing search pattern.

```php
<?php

$templateProcessor->setMacroClosingChars('#}');
```

--------------------------------

### setComplexValue - Replace macro with TextRun

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/template.md

Replaces a ${macro} with a ComplexType, such as a TextRun. The example creates an inline text run with red italic text.

```php
<?php

$inline = new TextRun();
$inline->addText('by a red italic text', array('italic' => true, 'color' => 'red'));
$templateProcessor->setComplexValue('inline', $inline);
```

--------------------------------

### Download produced file automatically using php://output

Source: https://github.com/phpoffice/phpword/blob/master/docs/howto.md

Sets headers for file download and saves the document to php://output. The filename is 'HelloWorld.docx'.

```php
<?php

$phpWord = new \PhpOffice\PhpWord\PhpWord();
$section = $phpWord->addSection();
$section->addText('Hello World!');
$file = 'HelloWorld.docx';
header("Content-Description: File Transfer");
header('Content-Disposition: attachment; filename="' . $file . '"');
header('Content-Type: application/vnd.openxmlformats-officedocument.wordprocessingml.document');
header('Content-Transfer-Encoding: binary');
header('Cache-Control: must-revalidate, post-check=0, pre-check=0');
header('Expires: 0');
$xmlWriter = \PhpOffice\PhpWord\IOFactory::createWriter($phpWord, 'Word2007');
$xmlWriter->save("php://output");
```

--------------------------------

### Basic usage of addListItem and addListItemRun

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/elements/list.md

Shows the syntax for adding a simple list item with addListItem and a complex list item with addListItemRun. The $depth, $fontStyle, $listStyle, and $paragraphStyle parameters are optional.

```php
<?php

$section->addListItem($text, [$depth], [$fontStyle], [$listStyle], [$paragraphStyle]);
$listItemRun = $section->addListItemRun([$depth], [$listStyle], [$paragraphStyle])
```

--------------------------------

### setChartValue - Replace variable with chart

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/template.md

Replaces a variable with a chart. The example creates a doughnut chart with categories A-E and series data, then sets it for the 'myChart' variable.

```php
<?php

$categories = array('A', 'B', 'C', 'D', 'E');
$series1 = array(1, 3, 2, 5, 4);
$chart = new Chart('doughnut', $categories, $series1);
$templateProcessor->setChartValue('myChart', $chart);
```

--------------------------------

### Load PHPWord configuration from custom path

Source: https://github.com/phpoffice/phpword/blob/master/docs/install.md

Load configuration from a custom phpword.ini file by passing the file path to Settings::loadConfig(). Do not use the phpword.ini file in the vendor folder.

```php
<?php

Settings::loadConfig(__DIR__ . '/../../phpword.ini');

```

--------------------------------

### Create ODText writer with IOFactory

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/writers.md

Creates an ODText writer and saves the document to sample.docx.

```php
<?php

$writer = IOFactory::createWriter($oPhpWord, 'ODText');
$writer->save(__DIR__ . '/sample.docx');
```

--------------------------------

### Add text with addText and addTextRun

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/elements/text.md

Shows the syntax for adding simple text with addText and creating a text run with addTextRun. $text is the text to display, $fontStyle and $paragraphStyle are optional style arrays.

```php
<?php

$section->addText($text, [$fontStyle], [$paragraphStyle]);
$textrun = $section->addTextRun([$paragraphStyle]);

```

--------------------------------

### Span cell across columns with gridSpan

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/elements/table.md

Use the setGridSpan method on a cell's style to span the cell across multiple columns. The example sets a grid span of 5.

```php
<?php

$cell = $table->addCell(200);
$cell->getStyle()->setGridSpan(5);
```

--------------------------------

### Create RTF writer with IOFactory

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/writers.md

Creates an RTF writer and saves the document to sample.rtf.

```php
<?php

$writer = IOFactory::createWriter($oPhpWord, 'RTF');
$writer->save(__DIR__ . '/sample.rtf');
```

--------------------------------

### Read RTF file with IOFactory::createReader('RTF')

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/readers.md

Creates an RTF reader and loads a sample .rtf file. The reader name is 'RTF'.

```php
<?php

$reader = IOFactory::createReader('RTF');
$reader->load(__DIR__ . '/sample.rtf');
```

--------------------------------

### Create Word2007 writer with IOFactory

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/writers.md

Creates a Word2007 writer and saves the document to sample.docx.

```php
<?php

$writer = IOFactory::createWriter($oPhpWord, 'Word2007');
$writer->save(__DIR__ . '/sample.docx');
```

--------------------------------

### Run tests with coverage

Source: https://github.com/phpoffice/phpword/blob/master/CONTRIBUTING.md

Runs all tests and generates test coverage reports.

```bash
composer test
```

--------------------------------

### Configure PDF renderer in phpword.ini

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/writers.md

Configures the PDF renderer name and path in phpword.ini or phpword.ini.dist.

```ini
pdfRendererName       = MPDF    ;DomPDF, TCPDF, MPDF
pdfRendererPath       = /path/to/your/renderer/folder
```

--------------------------------

### Set Default Font Name, Color, and Size

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/introduction.md

Alters the default font settings for all text. The default is Arial 10 point in black (000000). This example sets the font name to Times New Roman, color to red (FF0000), and size to 12.

```php
<?php

$phpWord->setDefaultFontName('Times New Roman');
$phpWord->setDefaultFontColor('FF0000');
$phpWord->setDefaultFontSize(12);
```

--------------------------------

### Load PHPWord configuration

Source: https://github.com/phpoffice/phpword/blob/master/docs/install.md

Load configuration from phpword.ini by calling Settings::loadConfig() without arguments. This uses the default configuration file.

```php
<?php

Settings::loadConfig();

```

--------------------------------

### Read Word2007 file with IOFactory::createReader('Word2007')

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/readers.md

Creates a Word2007 reader and loads a sample .docx file. The reader name is 'Word2007'.

```php
<?php

$reader = IOFactory::createReader('Word2007');
$reader->load(__DIR__ . '/sample.docx');
```

--------------------------------

### Add a bookmark with $section->addBookmark

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/elements/bookmark.md

Adds a bookmark named 'introduction' to the current section. Use this to mark a position for fields and links to reference. The ODText writer serializes bookmarks as native ODF point bookmarks; bookmark ranges and cross-reference fields are separate features.

```php
<?php

$section->addBookmark('introduction');
```

--------------------------------

### Load a template file with TemplateProcessor

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/template.md

Creates a new TemplateProcessor instance to load a template file. The template can contain search-patterns (macros) that will be replaced.

```php
<?php

$templateProcessor = new TemplateProcessor('Template.docx');
```

--------------------------------

### Adding WMF and EMF images

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/elements/image.md

Adds Windows metafile images (WMF and EMF) to a section. These are stored as-is in Word2007 and ODText, but converted to PNG for HTML, PDF, and RTF writers.

```php
<?php

$section->addImage('/path/to/my/images/drawing.wmf');
$section->addImage('/path/to/my/images/chart.emf', ['width' => 300]);
```

--------------------------------

### Track revisions with options

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/introduction.md

Activates track changes and optionally disables move syntax and formatting tracking.

```php
<?php

$phpWord->getSettings()->setTrackRevisions(true);
$phpWord->getSettings()->setDoNotTrackMoves(true);
$phpWord->getSettings()->setDoNotTrackFormatting(true);
```

--------------------------------

### Enable even and odd headers

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/containers.md

Sets the evenAndOddHeaders setting to true, allowing different headers for even and odd pages.

```php
<?php

$phpWord->getSettings()->setEvenAndOddHeaders(true);
```

--------------------------------

### Read ODText file with IOFactory::createReader('ODText')

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/readers.md

Creates an ODText reader and loads a sample .odt file. The reader name is 'ODText'.

```php
<?php

$reader = IOFactory::createReader('ODText');
$reader->load(__DIR__ . '/sample.odt');
```

--------------------------------

### Enable mirror margins

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/introduction.md

Sets mirror margins for facing pages in double-sided documents.

```php
<?php

$phpWord->getSettings()->setMirrorMargins(true);
```

--------------------------------

### Add a formula with a fraction to a section

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/elements/formula.md

Creates a fraction element with a denominator of 2 and a numerator of π, adds it to a Math object, and then adds the formula to a section. Requires the PhpOffice\Math library and a valid $section object.

```php
<?php

use PhpOffice\Math\Element;
use PhpOffice\Math\Math;

$fraction = new Element\Fraction();
$fraction
    ->setDenominator(new Element\Numeric(2))
    ->setNumerator(new Element\Identifier('π'))
;

$math = new Math();
$math->add($fraction);

$formula = $section->addFormula($math);
```

--------------------------------

### Enable book-fold printing

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/introduction.md

Sets up documents to be printed as foldable pages.

```php
<?php

$phpWord->getSettings()->setBookFoldPrinting(true);
```

--------------------------------

### Add table, row, and cell

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/elements/table.md

Use the addTable, addRow, and addCell methods to create a table structure. The table style, row height, row style, cell width, and cell style are optional parameters.

```php
<?php

$table = $section->addTable([$tableStyle]);
$table->addRow([$height], [$rowStyle]);
$cell = $table->addCell($width, [$cellStyle]);
```

--------------------------------

### Set document information properties

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/introduction.md

Use the DocInfo object to set metadata like creator, company, title, description, category, last modified by, created and modified timestamps, subject, and keywords. The created and modified timestamps use mktime() to specify dates.

```php
<?php

$properties = $phpWord->getDocInfo();
$properties->setCreator('My name');
$properties->setCompany('My factory');
$properties->setTitle('My title');
$properties->setDescription('My description');
$properties->setCategory('My category');
$properties->setLastModifiedBy('My name');
$properties->setCreated(mktime(0, 0, 0, 3, 12, 2014));
$properties->setModified(mktime(0, 0, 0, 3, 14, 2014));
$properties->setSubject('My subject');
$properties->setKeywords('my, key, word');
```

--------------------------------

### Create numbered headings with multilevel numbering

Source: https://github.com/phpoffice/phpword/blob/master/docs/howto.md

Defines a numbering style 'hNum' with three levels and matches title styles using pStyle and numStyle. Then adds headings to a section.

```php
<?php

$phpWord->addNumberingStyle(
    'hNum',
    array('type' => 'multilevel', 'levels' => array(
        array('pStyle' => 'Heading1', 'format' => 'decimal', 'text' => '%1'),
        array('pStyle' => 'Heading2', 'format' => 'decimal', 'text' => '%1.%2'),
        array('pStyle' => 'Heading3', 'format' => 'decimal', 'text' => '%1.%2.%3'),
        )
    )
);
$phpWord->addTitleStyle(1, array('size' => 16), array('numStyle' => 'hNum', 'numLevel' => 0));
$phpWord->addTitleStyle(2, array('size' => 14), array('numStyle' => 'hNum', 'numLevel' => 1));
$phpWord->addTitleStyle(3, array('size' => 12), array('numStyle' => 'hNum', 'numLevel' => 2));

$section->addTitle('Heading 1', 1);
$section->addTitle('Heading 2', 2);
$section->addTitle('Heading 3', 3);
```

--------------------------------

### Add a footer to a section

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/containers.md

Creates a footer reference for a section. The result should be saved in a local object to add elements.

```php
<?php

$footer = $section->addFooter();
```

--------------------------------

### Set PDF renderer options with Settings

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/writers.md

Defines PDF renderer options such as default font before creating the writer.

```php
<?php

use PhpOffice\PhpWord\Settings;

Settings::setPdfRendererOptions([
    'font' => 'Arial'
]);

$writer = IOFactory::createWriter($oPhpWord, 'PDF');
$writer->save(__DIR__ . '/sample.pdf');
```

--------------------------------

### setMacroOpeningChars

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/template.md

Defines a custom opening macro for template replacement. The following will set `{#` as the opening search pattern.

```APIDOC
## setMacroOpeningChars

### Description
Defines a custom opening macro for template replacement. The following will set `{#` as the opening search pattern.

### Method
setMacroOpeningChars

### Parameters
- **openingChars** (string) - Required - The opening macro characters.

### Request Example
```php
$templateProcessor->setMacroOpeningChars('{#');
```
```

--------------------------------

### Add a line chart with categories and series

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/elements/chart.md

Creates a line chart with the given categories and series data. The $style parameter can be used to customize the chart appearance.

```php
<?php

$categories = array('A', 'B', 'C', 'D', 'E');
$series = array(1, 3, 2, 5, 4);
$chart = $section->addChart('line', $categories, $series, $style);
```

--------------------------------

### save - Save template and return file path

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/template.md

Saves the loaded template in the current directory and returns the file path.

```php
<?php

$filepath = $templateProcessor->save();
```

--------------------------------

### addTextRun

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/elements/text.md

Creates a complex paragraph that can contain text with different styles or other elements like images and links. Accepts an optional paragraph style parameter.

```APIDOC
## addTextRun

### Description
Creates a complex paragraph that can contain text with different styles or other elements like images and links. Accepts an optional paragraph style parameter.

### Method
addTextRun

### Parameters
- **$paragraphStyle** (mixed) - Optional - Paragraph style. See Styles > Paragraph.

### Request Example
```php
$textrun = $section->addTextRun([$paragraphStyle]);
```

### Response
Returns a text run object for further manipulation.
```

--------------------------------

### Set MPDF as PDF renderer

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/writers.md

Specifies MPDF as the PDF renderer and sets its path.

```php
Settings::setPdfRendererName(Settings::PDF_RENDERER_MPDF);
Settings::setPdfRendererPath(__DIR__ . '/../vendor/mpdf/mpdf');
```

--------------------------------

### Add a header to a section

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/containers.md

Creates a header reference for a section. The result should be saved in a local object to add elements.

```php
<?php

$header = $section->addHeader();
```

--------------------------------

### Add a text box with styling in PHPWord

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/elements/textbox.md

Creates a text box in a section with specified dimensions, background color, and border, then adds text content. The ODText writer serializes it as a native ODF drawing frame with a nested draw:text-box, preserving supported properties.

```php
$textBox = $section->addTextBox([
    'width' => 400,
    'height' => 150,
    'bgColor' => '#eeeeee',
    'borderSize' => 1,
    'borderColor' => '#333333',
]);
$textBox->addText('Text box content.');
```

--------------------------------

### addFootnote and addEndnote on TextRun

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/elements/note.md

Demonstrates adding footnotes and endnotes to a text run, with methods to add text, links, breaks, and images.

```APIDOC
## addFootnote and addEndnote on TextRun

### Description
Adds a footnote or endnote to a text run, allowing content such as text, links, breaks, and images to be added inside the note.

### Method
addFootnote, addEndnote

### Usage
```php
$textrun = $section->addTextRun();
$textrun->addText('Lead text.');
$footnote = $textrun->addFootnote();
$footnote->addText('Footnote text can have ');
$footnote->addLink('http://test.com', 'links');
$footnote->addText('.');
$footnote->addTextBreak();
$footnote->addText('And text break.');
$textrun->addText('Trailing text.');
$endnote = $textrun->addEndnote();
$endnote->addText('Endnote put at the end');
```

### Notes
- The `addFootnote` and `addEndnote` methods are available on text runs and text elements.
- On footnotes and endnotes, you can use `addText`, `addLink`, `addTextBreak`, `addImage`, and `addOLEObject`.
- The ODText writer serializes both note types as native ODF notes.
```

--------------------------------

### Set Zip Class to PclZip

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/introduction.md

Switches the ZIP handling class from the default Zip extension to the pure PHP PclZip library, which is included in PHPWord. Use this if the Zip extension is not available on your server.

```php
<?php

\PhpOffice\PhpWord\Settings::setZipClass(\PhpOffice\PhpWord\Settings::PCLZIP);
```

--------------------------------

### Add footnote and endnote to a text run

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/elements/note.md

Use addFootnote and addEndnote on a text run to insert notes. Supports addText, addLink, addTextBreak, addImage, and addOLEObject. Recommended for better layout.

```php
<?php

$textrun = $section->addTextRun();
$textrun->addText('Lead text.');
$footnote = $textrun->addFootnote();
$footnote->addText('Footnote text can have ');
$footnote->addLink('http://test.com', 'links');
$footnote->addText('.');
$footnote->addTextBreak();
$footnote->addText('And text break.');
$textrun->addText('Trailing text.');
$endnote = $textrun->addEndnote();
$endnote->addText('Endnote put at the end');
```

--------------------------------

### FootnoteProperties Configuration

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/elements/note.md

Shows how to configure footnote numbering and positioning using the FootnoteProperties complex type.

```APIDOC
## FootnoteProperties Configuration

### Description
Configures footnote position, number format, start number, and restart behavior on a section.

### Method
setFootnoteProperties

### Usage
```php
$fp = new \PhpOffice\PhpWord\ComplexType\FootnoteProperties();
//sets the position of the footnote (pageBottom (default), beneathText, sectEnd, docEnd)
$fp->setPos(\PhpOffice\PhpWord\ComplexType\FootnoteProperties::POSITION_BENEATH_TEXT);
//set the number format to use (decimal (default), upperRoman, upperLetter, ...)
$fp->setNumFmt(\PhpOffice\PhpWord\SimpleType\NumberFormat::LOWER_ROMAN);
//force starting at other than 1
$fp->setNumStart(2);
//when to restart counting (continuous (default), eachSect, eachPage)
$fp->setNumRestart(\PhpOffice\PhpWord\ComplexType\FootnoteProperties::RESTART_NUMBER_EACH_PAGE);
//And finaly, set it on the Section
$section->setFootnoteProperties($fp);
```

### Parameters
- **pos** (constant) - Optional - Position of the footnote. Possible values: `POSITION_PAGE_BOTTOM` (default), `POSITION_BENEATH_TEXT`, `POSITION_SECT_END`, `POSITION_DOC_END`.
- **numFmt** (constant) - Optional - Number format. Possible values: `NumberFormat::DECIMAL` (default), `NumberFormat::UPPER_ROMAN`, `NumberFormat::LOWER_ROMAN`, `NumberFormat::UPPER_LETTER`, etc.
- **numStart** (int) - Optional - Starting number for footnotes. Default is 1.
- **numRestart** (constant) - Optional - When to restart numbering. Possible values: `RESTART_NUMBER_CONTINUOUS` (default), `RESTART_NUMBER_EACH_SECT`, `RESTART_NUMBER_EACH_PAGE`.
```

--------------------------------

### Register PHPWord autoloader

Source: https://github.com/phpoffice/phpword/blob/master/docs/install.md

Manually include the Autoloader.php and register the autoloader after downloading and extracting the package.

```php
<?php

require_once 'path/to/PHPWord/src/PhpWord/Autoloader.php';
\PhpOffice\PhpWord\Autoloader::register();

```

--------------------------------

### cloneRow: Template row with placeholders

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/template.md

Shows the table row structure with placeholders ${userId}, ${userName}, and ${userAddress} that will be cloned by the cloneRow method.

```clean
+-----------+----------------+
| ${userId} | ${userName}    |
|           |----------------+
|           | ${userAddress} |
+-----------+----------------+
```

--------------------------------

### Add watermark with addWatermark method

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/elements/watermark.md

Creates a section, adds a header, and calls addWatermark with an image path and margin options. The ODText writer preserves the watermark in the ODF master page header.

```php
<?php

$section = $phpWord->addSection();
$header = $section->addHeader();
$header->addWatermark('resources/_earth.jpg', array('marginTop' => 200, 'marginLeft' => 55));
```

--------------------------------

### Template with macros

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/template.md

A template containing macros ${firstname} and ${lastname} that will be replaced by setValue.

```clean
Hello ${firstname} ${lastname}!
```

--------------------------------

### saveAs: Save template to a path

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/template.md

Saves a copy of the loaded template to the specified path. The path is provided as a string variable.

```php
<?php

$pathToSave = 'path/to/save/file.ext';
$templateProcessor->saveAs($pathToSave);
```

--------------------------------

### Result of cloning with replacement array

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/template.md

Output after cloning with the replacement array, showing the replaced values for each clone.

```clean

Customer: Batman
Address: Gotham City

Customer: Superman
Address: Metropolis

```

--------------------------------

### Set multiple values with setValues

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/template.md

Sets multiple macros at once by passing an array of key-value pairs to setValues.

```php
<?php

$templateProcessor->setValues(array('firstname' => 'John', 'lastname' => 'Doe'));
```

--------------------------------

### Set ZIP adapter for Word2007 writer

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/writers.md

Changes the ZIP adapter for the Word2007 writer to PclZipAdapter.

```php
<?php

use PhpOffice\Common\Adapter\Zip\PclZipAdapter;
use PhpOffice\Common\Adapter\Zip\ZipArchiveAdapter;

$writer = IOFactory::createWriter($oPhpWord, 'Word2007');
$writer->setZipAdapter(new PclZipAdapter());
$writer->save(__DIR__ . '/sample.docx');
```

--------------------------------

### save

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/template.md

Saves the loaded template within the current directory. Returns the file path of the saved document.

```APIDOC
## save

### Description
Saves the loaded template within the current directory. Returns the file path.

### Method
save

### Parameters
None documented.

### Request Example
```php
<?php

$filepath = $templateProcessor->save();
```

### Response
Returns the file path of the saved document.
```

--------------------------------

### addListItemRun

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/elements/list.md

Creates a complex list item that can contain texts with different styles or other elements like images or links.

```APIDOC
## addListItemRun

### Description
Creates a complex list item that can contain texts with different styles or other elements like images or links.

### Method
addListItemRun

### Parameters
- **$depth** (int) - Optional - Depth of list item.
- **$listStyle** (mixed) - Optional - List style of the current element TYPE_NUMBER, TYPE_ALPHANUM, TYPE_BULLET_FILLED, etc. See list of constants in PHPWord\Style\ListItem.
- **$paragraphStyle** (mixed) - Optional - See Styles > Paragraph.

### Request Example
```php
$listItemRun = $section->addListItemRun([$depth], [$listStyle], [$paragraphStyle]);
```

```

--------------------------------

### Result of cloning block 3 times

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/template.md

Output after cloning the block 3 times with macro renaming, showing customer_name#1, customer_address#1, etc.

```clean

Customer: ${customer_name#1}
Address: ${customer_address#1}

Customer: ${customer_name#2}
Address: ${customer_address#2}

Customer: ${customer_name#3}
Address: ${customer_address#3}

```

--------------------------------

### Define table style with addTableStyle

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/elements/table.md

Define a table style using addTableStyle, specifying border color, border size, and cell margin. Optionally, a first row style can be provided. Then apply the style by name when adding the table.

```php
<?php

$tableStyle = array(
    'borderColor' => '006699',
    'borderSize'  => 6,
    'cellMargin'  => 50
);
$firstRowStyle = array('bgColor' => '66BBFF');
$phpWord->addTableStyle('myTable', $tableStyle, $firstRowStyle);
$table = $section->addTable('myTable');
```

--------------------------------

### Add OLE Object with addOLEObject

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/elements/oleobject.md

Use this snippet to embed an OLE object (e.g., Excel or PowerPoint) into a section. The $src parameter is the path to the file, and $style is optional.

```php
<?php

$section->addOLEObject($src, [$style]);
```

--------------------------------

### applyXslStyleSheet - Apply XSL stylesheet to template parts

Source: https://github.com/phpoffice/phpword/blob/master/docs/usage/template.md

Applies an XSL stylesheet to the header, footer, and main parts of the template. Load the stylesheet into a DOMDocument and pass it to the method.

```php
<?php

$xslDomDocument = new \DOMDocument();
$xslDomDocument->load('/path/to/my/stylesheet.xsl');
$templateProcessor->applyXslStyleSheet($xslDomDocument);
```

--------------------------------

### Run code style fixer

Source: https://github.com/phpoffice/phpword/blob/master/CONTRIBUTING.md

Automatically fixes code to match PHP-FIG standards.

```bash
composer fix
```
Tokens:
Raw