PHP 7.0.6 Released

    xhprof_enable

    (PECL xhprof >= 0.9.0)

    xhprof_enable — Start xhprof profiler

    Description

    void xhprof_enable ([ int $flags = 0 [, array $options ]] )

    Start xhprof profiling.

    Parameters

    flags

    Optional flags to add additional information to the profiling. See the XHprof constants for further information about these flags, e.g., XHPROF_FLAGS_MEMORY to enable memory profiling.

    options

    An array of optional options, namely, the 'ignored_functions' option to pass in functions to be ignored during profiling.

    Return Values

    NULL

    Changelog

    Version Description
    0.9.2 The optional options parameter was added.

    Examples

    Example #1 xhprof_enable() examples

    <?php
    // 1. elapsed time + memory + CPU profiling; and ignore built-in (internal) functions
    xhprof_enable(XHPROF_FLAGS_NO_BUILTINS | XHPROF_FLAGS_CPU | XHPROF_FLAGS_MEMORY);

    // 2. elapsed time profiling; ignore call_user_func* during profiling
    xhprof_enable(
            0,
        array(    'ignored_functions' =>  array('call_user_func',
                                                'call_user_func_array')));
                                           
    // 3. elapsed time + memory profiling; ignore call_user_func* during profiling
    xhprof_enable(
            XHPROF_FLAGS_MEMORY,
        array(    'ignored_functions' =>  array('call_user_func',
                                                'call_user_func_array')));
    ?>

    See Also

    User Contributed Notes

    Vladimir Kovpak
    5 months ago
    <?php

    // You can optionally profile CPU time and/or memory usage:
    xhprof_enable(XHPROF_FLAGS_CPU + XHPROF_FLAGS_MEMORY);
    To Top