How to add a method to an existing class in PHP?

Question

I'm using WordPress as a CMS, and I want to extend one of its classes without having to inherit from another class; i.e. I simply want to "add" more methods to that class:

class A {

    function do_a() {
       echo 'a';
    }
}

then:

function insert_this_function_into_class_A() {
    echo 'b';
}

(some way of inserting the latter into A class)

and:

A::insert_this_function_into_class_A();  # b

Is this even possible in tenacious PHP?

Answer 1

If you only need to access the Public API of the class, you can use a Decorator:

class SomeClassDecorator
{
    protected $_instance;

    public function myMethod() {
        return strtoupper( $this->_instance->someMethod() );
    }

    public function __construct(SomeClass $instance) {
        $this->_instance = $instance;
    }

    public function __call($method, $args) {
        return call_user_func_array(array($this->_instance, $method), $args);
    }

    public function __get($key) {
        return $this->_instance->$key;
    }

    public function __set($key, $val) {
        return $this->_instance->$key = $val;
    }

    // can implement additional (magic) methods here ...
}

Then wrap the instance of SomeClass:

$decorator = new SomeClassDecorator(new SomeClass);

$decorator->foo = 'bar';       // sets $foo in SomeClass instance
echo $decorator->foo;          // returns 'bar'
echo $decorator->someMethod(); // forwards call to SomeClass instance
echo $decorator->myMethod();   // calls my custom methods in Decorator

If you need to have access to the protected API, you have to use inheritance. If you need to access the private API, you have to modify the class files. While the inheritance approach is fine, modifiying the class files might get you into trouble when updating (you will lose any patches made). But both is more feasible than using runkit.

Answer 2

An updated way for 2014 that copes with scope.

public function __call($method, $arguments) {
    return call_user_func_array(Closure::bind($this->$method, $this, get_called_class()), $arguments);
}

Eg:

class stdObject {
    public function __call($method, $arguments) {
        return call_user_func_array(Closure::bind($this->$method, $this, get_called_class()), $arguments);
    }
}

$obj = new stdObject();
$obj->test = function() {
    echo "<pre>" . print_r($this, true) . "</pre>";
};
$obj->test();

Answer 3

You can use the runkit extension for this, but you should really consider regular inheritance instead.

See runkit_method_add.

Answer 4

If the class in question implements __call magic, then it's possible, and quite easy. If you want to know how this works I suggest you read Extending objects with new methods at runtime.

Answer 5

No you can't dynamically change a class during runtime in PHP.

You can accomplish this by either extending the class using regular inheritance:

class Fancy extends NotSoFancy
{
    public function whatMakesItFancy() //can also be private/protected of course
    {
        //    
    }
}

Or you could edit the Wordpress source files.

I'd prefer the inheritance way. It's a lot easier to handle in the long run.