PregReplace

Zend_Filter_PregReplace performs a search using regular expressions and replaces all found elements.

Supported options for Zend_Filter_PregReplace

The following options are supported for Zend_Filter_PregReplace:

  • match: The pattern which will be searched for.
  • replace: The string which is used as replacement for the matches.

Basic usage

To use this filter properly you must give two options:

The option match has to be given to set the pattern which will be searched for. It can be a string for a single pattern, or an array of strings for multiple pattern.

To set the pattern which will be used as replacement the option replace has to be used. It can be a string for a single pattern, or an array of strings for multiple pattern.

1
2
3
4
5
6
7
8
$filter = new Zend_Filter_PregReplace(array(
    'match'   => '/bob/',
    'replace' => 'john',
));
$input  = 'Hy bob!";

$filter->filter($input);
// returns 'Hy john!'

You can use getMatchPattern() and setMatchPattern() to set the matching pattern afterwards. To set the replacement pattern you can use getReplacement() and setReplacement().

1
2
3
4
5
6
7
$filter = new Zend_Filter_PregReplace();
$filter->setMatchPattern(array('bob', 'Hy'))
      ->setReplacement(array('john', 'Bye'));
$input  = 'Hy bob!";

$filter->filter($input);
// returns 'Bye john!'

For a more complex usage take a look into PHP‘s PCRE Pattern Chapter.

Project Versions

Table Of Contents

This Page

Note: You need to stay logged into your GitHub account to contribute to the documentation.

Edit this document

Edit this document

The source code of this file is hosted on GitHub. Everyone can update and fix errors in this document with few clicks - no downloads needed.

  1. Login with your GitHub account.
  2. Go to PregReplace on GitHub.
  3. Edit file contents using GitHub's text editor in your web browser
  4. Fill in the Commit message text box at the end of the page telling why you did the changes. Press Propose file change button next to it when done.
  5. On Send a pull request page you don't need to fill in text anymore. Just press Send pull request button.
  6. Your changes are now queued for review under project's Pull requests tab on GitHub.