str_replace - PHP code example

The php Function Str_Replace

A vital tool in any web developer's string manipulation arsenal, the php function str_replace offers an effective means of modifying text by locating and replacing designated substrings within larger strings. Its straightforward syntax and flexibility make it a valuable addition to any dynamic content manipulation workflow.

This article explores the php function str_replace, offering an in-depth examination of its key parameters and functionality. It will provide an understanding of how to utilize this versatile function across a variety of scenarios, including but not limited to, text formatting, content sanitization, and more.

The php function str_replace() takes three primary arguments: the search substring, the replacement string, and the source string on which these replacements are to be performed. An optional count parameter may also be passed, which stores the number of replacements made.

If the parameters search and replace are arrays, then it searches for each element in the search array against every occurrence of the string in the subject string. The replacements are then applied to each of the matching search elements. If the replace array has fewer elements than the search array, then an empty string is used as the replacement.

The php function str_replace() supports the use of arrays for both its search and replace parameters, allowing developers to designate multiple replacements in a single call. Its versatility allows it to be utilized for a range of applications, including but not limited to, text formatting, dynamic data processing, and content sanitization.

str_replace example

// To preserve BC and match \Behat\Mink\Element\Element::getText() include       // the page title.       $title_element = $this->find('css', 'title');
      if ($title_element) {
        $text = $title_element->getText() . ' ' . $text;
      }
      // To match what the user sees and \Behat\Mink\Element\Element::getText()       // decode HTML entities.       $text = html_entity_decode($text, ENT_QUOTES);
      // To match \Behat\Mink\Element\Element::getText() remove new lines and       // normalize spaces.       $text = str_replace("\n", ' ', $text);
      $text = preg_replace('/ {2,}/', ' ', $text);
      return trim($text);
    }

    // If using a real browser fallback to the \Behat\Mink\Element\Element     // implementation.     return parent::getText();
  }

  /** * {@inheritdoc} */

    $this->drupalGet('admin/structure/block');
    $this->clickLink('Disable');

    // Confirm that the block is now listed as disabled.     $this->assertSession()->statusMessageContains('The block settings have been updated.', 'status');

    // Confirm that the block instance title and markup are not displayed.     $this->drupalGet('node');
    $this->assertSession()->pageTextNotContains($block['settings[label]']);
    // Check for <div id="block-my-block-instance-name"> if the machine name     // is my_block_instance_name.     $xpath = $this->assertSession()->buildXPathQuery('//div[@id=:id]/*', [':id' => 'block-' . str_replace('_', '-', strtolower($block['id']))]);
    $this->assertSession()->elementNotExists('xpath', $xpath);

    $pages = [
      '',
      '<front>',
      '/valid-page',
      'user/login',
    ];
    // Test error when not including forward slash.     $this->drupalGet('admin/structure/block/manage/' . $block['id']);
    $this->submitForm(['visibility[request_path][pages]' => implode("\n", $pages)], 'Save block');

'bundle' => 'src/{$name}/'
    );

    /** * Format package name to CamelCase */
    public function inflectPackageVars(array $vars): array
    {
        $nameParts = explode('/', $vars['name']);
        foreach ($nameParts as &$value) {
            $value = strtolower($this->pregReplace('/(?<=\\w)([A-Z])/', '_\\1', $value));
            $value = str_replace(array('-', '_'), ' ', $value);
            $value = str_replace(' ', '', ucwords($value));
        }
        $vars['name'] = implode('/', $nameParts);
        return $vars;
    }
}

  protected function stringToHtml($text) {
    return '"' .
      str_replace(
        ["\n", ' '],
        ['\n', ' '],
        Html::escape($text)
      ) . '"';
  }

  /** * Helper function to test \Drupal\Core\Mail\MailFormatHelper::htmlToText(). * * @param string $html * The source HTML string to be converted. * @param string $text * The expected result of converting $html to text. * @param string $message * A text message to display in the assertion message. * @param array|null $allowed_tags * (optional) An array of allowed tags, or NULL to default to the full * set of tags supported by * \Drupal\Core\Mail\MailFormatHelper::htmlToText(). * * @internal */

return $ids;
    }

    public function getContainer(): ContainerInterface
    {
        return $this->container;
    }

    private function replaceIds(IdsCollection $ids, string $content): string
    {
        return (string) \preg_replace_callback('/"{.*}"/mU', function Darray $match) use ($ids) {
            $key = \str_replace(['"{', '}"'], '', (string) $match[0]);

            return '"' . $ids->create($key) . '"';
        }, $content);
    }

    /** * @param array<array<int, mixed>> $content */
    private function sync(array $content): void
    {
        $operations = [];

$toolInfo = array_merge($toolInfo, $options['tool_info']);
        }

        $dom = new \DOMDocument('1.0', 'utf-8');
        $dom->formatOutput = true;

        $xliff = $dom->appendChild($dom->createElement('xliff'));
        $xliff->setAttribute('version', '1.2');
        $xliff->setAttribute('xmlns', 'urn:oasis:names:tc:xliff:document:1.2');

        $xliffFile = $xliff->appendChild($dom->createElement('file'));
        $xliffFile->setAttribute('source-language', str_replace('_', '-', $defaultLocale));
        $xliffFile->setAttribute('target-language', str_replace('_', '-', $messages->getLocale()));
        $xliffFile->setAttribute('datatype', 'plaintext');
        $xliffFile->setAttribute('original', 'file.ext');

        $xliffHead = $xliffFile->appendChild($dom->createElement('header'));
        $xliffTool = $xliffHead->appendChild($dom->createElement('tool'));
        foreach ($toolInfo as $id => $value) {
            $xliffTool->setAttribute($id, $value);
        }

        if ($catalogueMetadata = $messages->getCatalogueMetadata('', $domain) ?? []) {

  protected function doRequest(string $url, array $options, bool $with_http_fallback): string {
    $data = '';
    try {
      $data = (string) $this->httpClient
        ->get($url, ['headers' => ['Accept' => 'text/xml']])
        ->getBody();
    }
    catch (TransferException $exception) {
      Error::logException($this->logger, $exception);
      if ($with_http_fallback && !str_contains($url, "http://")) {
        $url = str_replace('https://', 'http://', $url);
        return $this->doRequest($url, $options, FALSE);
      }
    }
    return $data;
  }

  /** * {@inheritdoc} */
  public function buildFetchUrl(array $project, $site_key = '') {
    $name = $project['name'];

        if (!$equalityValidation instanceof EqualTo) {
            return;
        }

        $compareValue = $data[$equalityValidation->propertyPath] ?? null;
        if ($data[$field] === $compareValue) {
            return;
        }

        $message = str_replace('{{ compared_value }}', $compareValue ?? '', (string) $equalityValidation->message);

        $violations = new ConstraintViolationList();
        $violations->add(new ConstraintViolation($message, $equalityValidation->message, [], '', $field, $data[$field]));

        throw new ConstraintViolationException($violations, $data);
    }

    private function getCustomerByEmail(string $email, SalesChannelContext $context): CustomerEntity
    {
        $criteria = new Criteria();
        $criteria->addFilter(new EqualsFilter('customer.active', 1));

    function form_open(string $action = '', $attributes = [], array $hidden = []): string
    {
        // If no action is provided then set to the current url         if (! $action) {
            $action = current_url(true);
        } // If an action is not a full URL then turn it into one         elseif (strpos($action, '://') === false) {
            // If an action has {locale}             if (strpos($action, '{locale}') !== false) {
                $action = str_replace('{locale}', Services::request()->getLocale(), $action);
            }

            $action = site_url($action);
        }

        if (is_array($attributes) && array_key_exists('csrf_id', $attributes)) {
            $csrfId = $attributes['csrf_id'];
            unset($attributes['csrf_id']);
        }

        $attributes = stringify_attributes($attributes);

$scheme = $this->getScheme($uri);

    if ($this->isValidScheme($scheme)) {
      $target = $this->getTarget($uri);

      if ($target !== FALSE) {

        if (!in_array($scheme, Settings::get('file_sa_core_2023_005_schemes', []))) {
          $class = $this->getClass($scheme);
          $is_local = is_subclass_of($class, LocalStream::class);
          if ($is_local) {
            $target = str_replace(DIRECTORY_SEPARATOR, '/', $target);
          }

          $parts = explode('/', $target);
          $normalized_parts = [];
          while ($parts) {
            $part = array_shift($parts);
            if ($part === '' || $part === '.') {
              continue;
            }
            elseif ($part === '..' && $is_local && $normalized_parts === []) {
              $normalized_parts[] = $part;

else if (Zend_Locale::isLocale($format, true, false)) {
            $locale = $format;
            $format = Zend_Locale_Data::getContent($format, 'currencynumber');
        }

        $original = $value;
        $value    = Zend_Locale_Format::toNumber($value, array('locale'        => $locale,
                                                               'number_format' => $format,
                                                               'precision'     => $options['precision']));

        if ($options['position'] !== self::STANDARD) {
            $value = str_replace('¤', '', $value);
            $space = '';
            if (iconv_strpos($value, ' ') !== false) {
                $value = str_replace(' ', '', $value);
                $space = ' ';
            }

            if ($options['position'] == self::LEFT) {
                $value = '¤' . $space . $value;
            } else {
                $value = $value . $space . '¤';
            }
        }

        );
        $message = str_replace(
            array(
                '###LINK###',
                '###EXPIRES###',
                '###CAUSE###',
                '###DETAILS###',
                '###SITEURL###',
                '###PAGEURL###',
                '###SUPPORT###',
                '###DEBUG###',
            ),
            array(

        $rawattr = $attr;
        $attr    = wp_parse_args( $attr, wp_embed_defaults( $url ) );

        $this->last_attr = $attr;

        /* * KSES converts & into & and we need to undo this. * See https://core.trac.wordpress.org/ticket/11311 */
        $url = str_replace( '&', '&', $url );

        // Look for known internal handlers.         $embed_handler_html = $this->get_embed_handler_html( $rawattr, $url );
        if ( false !== $embed_handler_html ) {
            return $embed_handler_html;
        }

        $post_id = ( ! empty( $post->ID ) ) ? $post->ID : null;

        // Potentially set by WP_Embed::cache_oembed().         if ( ! empty( $this->post_ID ) ) {

return (isset($GenreLookup[$genreid]) ? $GenreLookup[$genreid] : false);
    }

    /** * @param string $genre * @param bool $allowSCMPXextended * * @return string|false */
    public static function LookupGenreID($genre, $allowSCMPXextended=false) {
        $GenreLookup = self::ArrayOfGenres($allowSCMPXextended);
        $LowerCaseNoSpaceSearchTerm = strtolower(str_replace(' ', '', $genre));
        foreach ($GenreLookup as $key => $value) {
            if (strtolower(str_replace(' ', '', $value)) == $LowerCaseNoSpaceSearchTerm) {
                return $key;
            }
        }
        return false;
    }

    /** * @param string $OriginalGenre * * @return string|false */

    private function buildViolation(
        string $messageTemplate,
        array $parameters,
        ?string $propertyPath = null,
        ?array $invalidValue = null,
        ?string $code = null
    ): ConstraintViolationInterface {
        return new ConstraintViolation(
            str_replace(array_keys($parameters), array_values($parameters), $messageTemplate),
            $messageTemplate,
            $parameters,
            null,
            $propertyPath,
            $invalidValue,
            null,
            $code
        );
    }
}