`exclude-functions` not working as expected

[saas786]

Hi,

I’m not sure if this is a bug or if I’m misunderstanding the intended behavior of exclude-functions.

I have the following file (function bodies stripped for simplicity):

<?php
use Hybrid\App;
use Olay\Tools\Media\Lazyload as MediaLazyload;

if ( ! function_exists( 'woocommerce_template_loop_product_thumbnail' ) ) {
    function woocommerce_template_loop_product_thumbnail() {
    }
}

if ( ! function_exists( 'woocommerce_review_display_gravatar' ) ) {
    function woocommerce_review_display_gravatar( $comment ) {
    }
}

---

Scoped Output

php-scoper inspect -c ./bin-dev/php-scoper/scoper.inc.php dist/inc/WooCommerce/functions-overrides.php

Scoped contents:

<?php

namespace Olay_Vendor;

use Olay_Vendor\Hybrid\App;
use Olay\Tools\Media\Lazyload as MediaLazyload;

if (!\function_exists('woocommerce_template_loop_product_thumbnail') && !\function_exists('Olay_Vendor\woocommerce_template_loop_product_thumbnail')) {
    function woocommerce_template_loop_product_thumbnail()
    {
    }
}

if (!\function_exists('woocommerce_review_display_gravatar') && !\function_exists('Olay_Vendor\woocommerce_review_display_gravatar')) {
    function woocommerce_review_display_gravatar($comment)
    {
    }
}

Symbols Registry:

Humbug\PhpScoper\Symbol\SymbolsRegistry {#182
  -recordedFunctions: array:2 [
    "woocommerce_template_loop_product_thumbnail" => array:2 [
      0 => "woocommerce_template_loop_product_thumbnail"
      1 => "Olay_Vendor\woocommerce_template_loop_product_thumbnail"
    ]
    "woocommerce_review_display_gravatar" => array:2 [
      0 => "woocommerce_review_display_gravatar"
      1 => "Olay_Vendor\woocommerce_review_display_gravatar"
    ]
  ]
  -recordedClasses: []
}

---

Even though I’ve excluded woocommerce_template_loop_product_thumbnail using exclude-functions, it still appears to be scoped.

Is this the expected behavior, or should the excluded function remain untouched?

---

[theofidry]

Hi @saas786, from https://github.com/humbug/php-scoper/blob/main/docs/configuration.md#excluded-symbols it is expected. Not ideal, but it is a known limitation.

[saas786]

I’m using:

$pattern = '/\s*&&\s*!\s*\\\\function_exists\s*\(\s*\'' . preg_quote( $prefix, '/' ) . '\\\\([^\']+)\'\s*\)/';
$content = preg_replace( $pattern, '', $content );

This successfully removes the extra prefixed function_exists checks.

Right now, I’m only applying it to a single file where I noticed the issue.
However, what about other cases where the same thing might be happening that I’m not aware of?

I wouldn’t mind adding some patcher logic in the config file, but I’d like to know more about this issue — ideally some documentation or a recommended way to handle it for a bulk fix or automated patch via the config file.

I’m sure you’ve already considered this scenario and might have some patchers available that we can use in such cases?

[theofidry]

It would be possible but I am not sure it's a good idea to encourage this practice. In the first place, exclude-functions (and any exclude-*) is meant to tell "this is a PHP native function" or equivalent, e.g. it comes from a third-party code that loads your code.

So declaring your own functions as excluded is a bit weird.