Log in
Contact
Forum
removeTemplateVariableImage
- addBibliography
- addBookmark
- addBreak
- addChart
- addCitation
- addComment
- addCrossReference
- addDateAndHour
- addEndnote
- addExternalFile
- addFootnote
- addFormElement
- addHeading
- addImage
- addLink
- addList
- addMathEquation
- addMergeField
- addOLE
- addOnlineVideo
- addPageNumber
- addShape
- addSimpleField
- addSource
- addStructuredDocumentTag
- addSVG
- addTab
- addTable
- addTableContents
- addTableFigures
- addText
- addTextBox
- addWordFragment
- addWordML
- embedHTML
- addBackgroundImage
- addFooter
- addFooterSection
- addHeader
- addHeaderSection
- addLineNumbering
- addMacroFromDoc
- addPageBorders
- addProperties
- addSection
- createDocx
- createDocxAndDownload
- createCharacterStyle
- createListStyle
- createParagraphStyle
- createTableStyle
- docxSettings
- embedFont
- importChartStyle
- importHeadersAndFooters
- importListStyle
- importStyles
- importStylesWordDefault
- modifyPageLayout
- parseStyles
- removeFooters
- removeHeaders
- setBackgroundColor
- 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
removeTemplateVariableImage
TRIAL / ADVANCED / PREMIUM
Removes a phpdocx placeholder image variable from the Word document.
Description
public function removeTemplateVariableImage(string $variableName [, $type = 'inline', $target = 'document', $options = array()])
This method allows to remove an placeholder image variable.
There are two options: just remove the placeholder image ($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 image 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 replace the first occurrence of the variable within the Word document. |
Code samples
Example #1
Release notes
- phpdocx 15.0:
- new method.