Log in
Contact
Forum
replaceImage
- 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
- 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
replaceImage
PREMIUM
TRIAL / ADVANCED
Bulk processing. Replaces a placeholder within an image by a new image.
Description
public replaceImage (array $variables, array $options)
Parameters
variables
This is an array that each position sets a DOCX document. In this array, another array set the new contents.
options
The possible keys and values of this array are:
| Key | Type | Description |
|---|---|---|
| dpi | int | Dots per inch. This parameter is only taken into account if width or height are set to auto. |
| firstMatch | boolean | 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. |
| height | mixed | The value in cm (float) or 'auto' (use image size). |
| mime | string | Forces a mime (image/jpg, image/jpeg, image/png, image/gif, image/bmp, image/webp) |
| streamMode | bool | If true, uses src as stream. PHP 5.4 or greater needed to autodetect the mime type; otherwise set it using mime option. Default is false. |
| target | array | Possible values are: document, header, footer (all as default). |
| width | mixed | The value in cm (float) or 'auto' (use image size). |
Exceptions
Image does not exist.
Image format not supported.
getimagesizefromstring not available using streamMode and mime/height/width values are not set.
Code samples
Example #1
Release notes
- phpdocx 15.0:
- WebP images.
- phpdocx 13.0:
- optimized working with documents with many images.
- phpdocx 10.0:
- new method.