Log in
Contact
Forum
removeTemplateVariable
- addBarcode
- addBibliography
- addBookmark
- addBreak
- addCaption
- addChart
- addCitation
- addComment
- addCrossReference
- addDateAndHour
- addDropCap
- addEndnote
- addExternalFile
- addFootnote
- addFormElement
- addHeading
- addImage
- addIndex
- addLink
- addList
- addMathEquation
- addMergeField
- addOLE
- addOnlineVideo
- addPageNumber
- addRuby
- addShape
- addSimpleField
- addSource
- addStructuredDocumentTag
- addSVG
- addTab
- addTable
- addTableAuthorities
- addTableContents
- addTableFigures
- addText
- addTextBox
- addWordFragment
- addWordML
- embedHTML
- markEntry
- addBackgroundImage
- addFooter
- addFooterSection
- addHeader
- addHeaderSection
- addLineNumbering
- addMacroFromDoc
- addPageBorders
- addProperties
- addSection
- createDocx
- createDocxAndDownload
- createCharacterStyle
- createListStyle
- createParagraphStyle
- createTableStyle
- docxSettings
- embedFont
- importChartStyle
- importHeadersAndFooters
- importListStyle
- importStyles
- importStylesWordDefault
- importTheme
- modifyPageLayout
- parseStyles
- removeFooters
- removeHeaders
- setBackgroundColor
- setCompatibilityMode
- setDecimalSymbol
- setDefaultFont
- setDocumentDefaultStyles
- setEncodeUTF8
- setLanguage
- setMarkAsFinal
- setRTL
- clearBlocks
- cloneBlock
- deleteBlock
- getTemplateVariables
- getTemplateVariablesType
- modifyInputFields
- modifyMergeFields
- processTemplate
- removeTemplateVariable
- removeTemplateVariableImage
- replaceBlock
- replaceListVariable
- replacePlaceholderImage
- replaceTableVariable
- replaceVariableByExternalFile
- replaceVariableByHTML
- replaceVariableByText
- replaceVariableByWordFragment
- replaceVariableByWordML
- setTemplateSymbol
- setTemplateBlockSymbol
- tickCheckboxes
removeTemplateVariable
TRIAL / ADVANCED / PREMIUM
Removes a phpdocx placeholder variable from the Word document.
Description
public removeTemplateVariable (string $variableName[, string $type[, string $target, [array $options = array()]]])
This method allows to remove an "unused" placeholder variable.
There are two options: just remove the placeholder variable ($type = 'inline') or remove the whole paragraph that contains it ($type = 'block').
Parameters
variableName
The name of the variable you want to remove.
type
It may be 'inline' if one wants just to remove the variable or 'block' (default value) if one wants also to remove the containing paragraph.
target
Possible values are: document (default value), header, footer, footnote, endnote or comment.
options
The possible keys and values of this array are:
| Key | Type | Description |
|---|---|---|
| firstMatch | bool | If the variable appears more than once within the Word document and firstMatch is set to true, phpdocx will only remove the first occurrence of the variable within the Word document. |
Code samples
Example #1
Release notes
- phpdocx 18.0:
- firstMatch option.