func_get_args - PHP code example

php Function func_get_Args

Articles about php function func_get_args

The php func_get_args() function provides an easy way to get all the arguments that were passed into a given user-defined function. This can be useful in situations where the function is declared to take a fixed number of parameters but is called with a different number of parameters.

By default, php passes function arguments by value (the actual value of the argument is changed inside the function, but not outside) unless they are explicitly passed by reference. This allows for a lot of flexibility, but it also means that functions may be used in ways that would lead to a syntax error if they were written in another programming language.

For example, a function can use named parameters, but it cannot mix them with positional parameters. This is because the call-site cannot correctly infer the position of a parameter when it uses a name, but doesn't pass the same named parameters as its positional parameter. This is a case where a pattern like internal method chaining (a() calling b() directly) would suffer from Flaw: Class Does Too Much 1 because it combines two completely different responsibilities (formatting and processing the argument data).

The php func_get_args() can be used with a call-site that uses an associative array for its parameter list to allow a user-defined function to accept a variable-length argument list. However, be aware that if the associative array has non-numeric keys, this can cause a breaking change in future versions of PHP when they implement named parameters.

func_get_args example

class RedisCluster5Proxy extends \RedisCluster implements ResetInterface, LazyObjectInterface
{
    use LazyProxyTrait {
        resetLazyObject as reset;
    }

    private const LAZY_OBJECT_PROPERTY_SCOPES = [];

    public function __construct($name, $seeds = null, $timeout = null, $read_timeout = null, $persistent = null, $auth = null)
    {
        return ($this->lazyObjectState->realInstance ??= ($this->lazyObjectState->initializer)())->__construct(...\func_get_args());
    }

    public function _masters()
    {
        return ($this->lazyObjectState->realInstance ??= ($this->lazyObjectState->initializer)())->_masters(...\func_get_args());
    }

    public function _prefix($key)
    {
        return ($this->lazyObjectState->realInstance ??= ($this->lazyObjectState->initializer)())->_prefix(...\func_get_args());
    }

function wp_clear_scheduled_hook( $hook, $args = array(), $wp_error = false ) {
    /* * Backward compatibility. * Previously, this function took the arguments as discrete vars rather than an array like the rest of the API. */
    if ( ! is_array( $args ) ) {
        _deprecated_argument( __FUNCTION__, '3.0.0', __( 'This argument has changed to an array to match the behavior of the other cron functions.' ) );
        $args     = array_slice( func_get_args(), 1 ); // phpcs:ignore PHPCompatibility.FunctionUse.ArgumentFunctionsReportCurrentValue.NeedsInspection         $wp_error = false;
    }

    /** * Filter to preflight or hijack clearing a scheduled hook. * * Returning a non-null value will short-circuit the normal unscheduling * process, causing the function to return the filtered value instead. * * For plugins replacing wp-cron, return the number of events successfully * unscheduled (zero if no events were registered with the hook) or false * or a WP_Error if unscheduling one or more events fails. * * @since 5.1.0 * @since 5.7.0 The `$wp_error` parameter was added, and a `WP_Error` object can now be returned. * * @param null|int|false|WP_Error $pre Value to return instead. Default null to continue unscheduling the event. * @param string $hook Action hook, the execution of which will be unscheduled. * @param array $args Arguments to pass to the hook's callback function. * @param bool $wp_error Whether to return a WP_Error on failure. */

    /** * {@inheritdoc} */
    public function isValid(Request $request, array $captchaConfig): bool
    {
        if (!$request->get(self::CAPTCHA_REQUEST_PARAMETER)) {
            return false;
        }

        $captchaConfig = \func_get_args()[1] ?? [];

        $secretKey = !empty($captchaConfig['config']['secretKey']) ? $captchaConfig['config']['secretKey'] : null;

        if (!\is_string($secretKey)) {
            return false;
        }

        try {
            $response = $this->client->request('POST', self::GOOGLE_CAPTCHA_VERIFY_ENDPOINT, [
                'form_params' => [
                    'secret' => $secretKey,

/** * Constructor * * @param string|array $options OPTIONAL */
    public function __construct($options = null)
    {
        if ($options instanceof Zend_Config) {
            $options = $options->toArray();
        } else if (!is_array($options)) {
            $options = func_get_args();
            $temp    = array();
            if (!empty($options)) {
                $temp['encoding'] = array_shift($options);
            }
            $options = $temp;
        }

        if (!array_key_exists('encoding', $options) && function_exists('mb_internal_encoding')) {
            $options['encoding'] = mb_internal_encoding();
        }

        return $factory();
    }

    /** * Gets the public 'closure1' shared service. * * @return \Closure */
    protected static function getClosure1Service($container, $lazyLoad = true)
    {
        return $container->services['closure1'] = (new class(fn () => new \Symfony\Component\DependencyInjection\Tests\Compiler\Foo()) extends \Symfony\Component\DependencyInjection\Argument\LazyClosure { public function cloneFoo(?\stdClass $bar = null): \Symfony\Component\DependencyInjection\Tests\Compiler\Foo { return $this->service->cloneFoo(...\func_get_args()); } })->cloneFoo(...);
    }

    /** * Gets the public 'closure2' shared service. * * @return \Closure */
    protected static function getClosure2Service($container, $lazyLoad = true)
    {
        return $container->services['closure2'] = (new class(fn () => new \Symfony\Component\DependencyInjection\Tests\Compiler\FooVoid()) extends \Symfony\Component\DependencyInjection\Argument\LazyClosure { public function __invoke(string $name): void { $this->service->__invoke(...\func_get_args()); } })->__invoke(...);
    }
}

'foo' => true,
        ];
    }

    /** * Gets the public 'bar' shared autowired service. * * @return \Symfony\Component\DependencyInjection\Tests\Dumper\CallableAdapterConsumer */
    protected static function getBarService($container)
    {
        return $container->services['bar'] = new \Symfony\Component\DependencyInjection\Tests\Dumper\CallableAdapterConsumer(new class(fn () => new \Symfony\Component\DependencyInjection\Tests\Compiler\Foo()) extends \Symfony\Component\DependencyInjection\Argument\LazyClosure implements \Symfony\Component\DependencyInjection\Tests\Compiler\SingleMethodInterface { public function theMethod() { return $this->service->cloneFoo(...\func_get_args()); } });
    }
}

// ----- Set default values     $v_options = array();
    $v_options[PCLZIP_OPT_NO_COMPRESSION] = FALSE;

    // ----- Look for variable options arguments     $v_size = func_num_args();

    // ----- Look for arguments     if ($v_size > 1) {
      // ----- Get the arguments       $v_arg_list = func_get_args();

      // ----- Remove from the options list the first argument       array_shift($v_arg_list);
      $v_size--;

      // ----- Look for first arg       if ((is_integer($v_arg_list[0])) && ($v_arg_list[0] > 77000)) {

        // ----- Parse the options         $v_result = $this->privParseOptions($v_arg_list, $v_size, $v_options,
                                            array (PCLZIP_OPT_REMOVE_PATH => 'optional',

yield ['array-iterator', new \ArrayIterator([123], 1)];
        yield ['array-object-custom', new MyArrayObject([234])];

        $errorHandler = set_error_handler(static function Dint $errno, string $errstr) use (&$errorHandler) {
            if (\E_DEPRECATED === $errno && str_contains($errstr, 'implements the Serializable interface, which is deprecated. Implement __serialize() and __unserialize() instead')) {
                // We're testing if the component handles deprecated Serializable implementations well.                 // This kind of implementation triggers a deprecation warning since PHP 8.1 that we explicitly want to                 // ignore here. We probably need to reevaluate this piece of code for PHP 9.                 return true;
            }

            return $errorHandler ? $errorHandler(...\func_get_args()) : false;
        });

        try {
            $mySerializable = new MySerializable();
            $fooSerializable = new FooSerializable('bar');
        } finally {
            restore_error_handler();
        }

        yield ['serializable', [$mySerializable, $mySerializable]];
        yield ['foo-serializable', $fooSerializable];

        if ($this instanceof Enlight_Hook
          && !$this instanceof Enlight_Hook_Proxy
          && Shopware()->Hooks()->hasProxy($class)
        ) {
            throw new Enlight_Exception(
                'Class "' . \get_class($this) . '" has hooks, please use the instance method'
            );
        }
        if (method_exists($this, 'init')) {
            if (\func_num_args()) {
                \call_user_func_array([$this, 'init'], \func_get_args());
            } else {
                $this->init();
            }
        }
    }

    /** * Magic caller * * @param string $name * @param array $args * * @throws \Enlight_Exception */

/** * Sets filter options * * @param string|array|Zend_Config $options * @return void */
    public function __construct($options = null)
    {
        if ($options instanceof Zend_Config) {
            $options = $options->toArray();
        } else if (!is_array($options)) {
            $options          = func_get_args();
            $temp['charlist'] = array_shift($options);
            $options          = $temp;
        }

        if (array_key_exists('charlist', $options)) {
            $this->setCharList($options['charlist']);
        }
    }

    /** * Returns the charList option * * @return string|null */

    public function __construct($options = array())
    {
        if ($options instanceof Zend_Config) {
            $options = $options->toArray();
        } elseif (!is_array($options)) {
            $args = func_get_args();

            $options = array(
                'rootElement' => array_shift($args)
            );

            if (count($args)) {
                $options['elementMap'] = array_shift($args);
            }

            if (count($args)) {
                $options['encoding'] = array_shift($args);
            }

    public function find()
    {
        $this->_setupPrimaryKey();
        $args = func_get_args();
        $keyNames = array_values((array) $this->_primary);

        if (count($args) < count($keyNames)) {
            throw new Zend_Db_Table_Exception("Too few columns for the primary key");
        }

        if (count($args) > count($keyNames)) {
            throw new Zend_Db_Table_Exception("Too many columns for the primary key");
        }

        $whereList = array();

    public function __construct($options = array())
    {
        if ($options instanceof Zend_Config) {
            $options = $options->toArray();
        } else if (func_num_args() > 1) {
            $args               = func_get_args();
            $options            = array();
            $options['content'] = array_shift($args);

            if (!empty($args)) {
                $options['locale'] = array_shift($args);
            }

            if (!empty($args)) {
                $opt     = array_shift($args);
                $options = array_merge($opt, $options);
            }
        }

    protected function parseError($msg)
    {
        $args = func_get_args();

        if (count($args) > 1) {
            array_shift($args);
            $msg = vsprintf($msg, $args);
        }

        $line = $this->scanner->currentLine();
        $col = $this->scanner->columnOffset();
        $this->events->parseError($msg, $line, $col);

        return false;
    }

return false;
    }

    /** * Created the index alias * * @deprecated tag:v6.6.0 - reason:new-optional-parameter - Parameter $languageId will be removed. */
    public function getIndexName(EntityDefinition $definition/* , ?string $languageId = null */): string
    {
        $languageId = \func_get_args()[1] ?? '';

        if ($languageId === '') {
            return $this->prefix . '_' . $definition->getEntityName();
        }

        return $this->prefix . '_' . $definition->getEntityName() . '_' . $languageId;
    }

    public function allowIndexing(): bool
    {
        if (!$this->indexingEnabled) {