wp/tests/phpunit/tests/pluggable.php

<?php

/**
 * @group pluggable
 */
class Tests_Pluggable extends WP_UnitTestCase {

	/**
	 * Tests that the signatures of all functions in pluggable.php match their expected signature.
	 *
	 * @ticket 33654
	 * @ticket 33867
	 *
	 * @dataProvider get_defined_pluggable_functions
	 */
	public function test_pluggable_function_signatures_match( $function ) {

		$signatures = $this->get_pluggable_function_signatures();

		$this->assertTrue( function_exists( $function ) );
		$this->assertArrayHasKey( $function, $signatures );

		$function_ref = new ReflectionFunction( $function );
		$param_refs   = $function_ref->getParameters();

		$this->assertSame( count( $signatures[ $function ] ), count( $param_refs ) );

		$i = 0;

		foreach ( $signatures[ $function ] as $name => $value ) {

			$param_ref = $param_refs[ $i ];
			$msg       = 'Parameter: ' . $param_ref->getName();

			if ( is_numeric( $name ) ) {
				$name = $value;
				$this->assertFalse( $param_ref->isOptional(), $msg );
			} else {
				$this->assertTrue( $param_ref->isOptional(), $msg );
				$this->assertSame( $value, $param_ref->getDefaultValue(), $msg );
			}

			$this->assertSame( $name, $param_ref->getName(), $msg );

			$i++;

		}

	}

	/**
	 * Test the tests. Makes sure all the expected pluggable functions exist and that they live in pluggable.php.
	 *
	 * @ticket 33654
	 * @ticket 33867
	 */
	public function test_all_pluggable_functions_exist() {

		$defined  = wp_list_pluck( $this->get_defined_pluggable_functions(), 0 );
		$expected = $this->get_pluggable_function_signatures();

		foreach ( $expected as $function => $sig ) {
			$msg = 'Function: ' . $function . '()';
			$this->assertTrue( function_exists( $function ), $msg );
			$this->assertTrue( in_array( $function, $defined, true ), $msg );
		}

	}

	/**
	 * Data provider for our pluggable function signature tests.
	 *
	 * @return array Data provider array of pluggable function names.
	 */
	public function get_defined_pluggable_functions() {

		require_once ABSPATH . '/wp-admin/includes/upgrade.php';

		$test_functions = array(
			'install_network',
			'wp_install',
			'wp_install_defaults',
			'wp_new_blog_notification',
			'wp_upgrade',
			'install_global_terms',
		);
		$test_files     = array(
			'wp-includes/pluggable.php',
		);

		// Pluggable function signatures are not tested when an external object cache is in use. See #31491.
		if ( ! wp_using_ext_object_cache() ) {
			$test_files[] = 'wp-includes/cache.php';
		}

		$data = array();

		foreach ( $test_functions as $function ) {
			$data[] = array(
				$function,
			);
		}

		foreach ( $test_files as $file ) {
			preg_match_all( '#^\t?function (\w+)#m', file_get_contents( ABSPATH . '/' . $file ), $functions );

			foreach ( $functions[1] as $function ) {
				$data[] = array(
					$function,
				);
			}
		}

		return $data;

	}

	/**
	 * Expected pluggable function signatures.
	 *
	 * @return array Array of signatures keyed by their function name.
	 */
	public function get_pluggable_function_signatures() {

		$signatures = array(

			// wp-includes/pluggable.php:
			'wp_set_current_user'             => array(
				'id',
				'name' => '',
			),
			'wp_get_current_user'             => array(),
			'get_userdata'                    => array( 'user_id' ),
			'get_user_by'                     => array( 'field', 'value' ),
			'cache_users'                     => array( 'user_ids' ),
			'wp_mail'                         => array(
				'to',
				'subject',
				'message',
				'headers'     => '',
				'attachments' => array(),
			),
			'wp_authenticate'                 => array( 'username', 'password' ),
			'wp_logout'                       => array(),
			'wp_validate_auth_cookie'         => array(
				'cookie' => '',
				'scheme' => '',
			),
			'wp_generate_auth_cookie'         => array(
				'user_id',
				'expiration',
				'scheme' => 'auth',
				'token'  => '',
			),
			'wp_parse_auth_cookie'            => array(
				'cookie' => '',
				'scheme' => '',
			),
			'wp_set_auth_cookie'              => array(
				'user_id',
				'remember' => false,
				'secure'   => '',
				'token'    => '',
			),
			'wp_clear_auth_cookie'            => array(),
			'is_user_logged_in'               => array(),
			'auth_redirect'                   => array(),
			'check_admin_referer'             => array(
				'action'    => -1,
				'query_arg' => '_wpnonce',
			),
			'check_ajax_referer'              => array(
				'action'    => -1,
				'query_arg' => false,
				'die'       => true,
			),
			'wp_redirect'                     => array(
				'location',
				'status'        => 302,
				'x_redirect_by' => 'WordPress',
			),
			'wp_sanitize_redirect'            => array( 'location' ),
			'_wp_sanitize_utf8_in_redirect'   => array( 'matches' ),
			'wp_safe_redirect'                => array(
				'location',
				'status'        => 302,
				'x_redirect_by' => 'WordPress',
			),
			'wp_validate_redirect'            => array(
				'location',
				'default' => '',
			),
			'wp_notify_postauthor'            => array(
				'comment_id',
				'deprecated' => null,
			),
			'wp_notify_moderator'             => array( 'comment_id' ),
			'wp_password_change_notification' => array( 'user' ),
			'wp_new_user_notification'        => array(
				'user_id',
				'deprecated' => null,
				'notify'     => '',
			),
			'wp_nonce_tick'                   => array(),
			'wp_verify_nonce'                 => array(
				'nonce',
				'action' => -1,
			),
			'wp_create_nonce'                 => array( 'action' => -1 ),
			'wp_salt'                         => array( 'scheme' => 'auth' ),
			'wp_hash'                         => array(
				'data',
				'scheme' => 'auth',
			),
			'wp_hash_password'                => array( 'password' ),
			'wp_check_password'               => array(
				'password',
				'hash',
				'user_id' => '',
			),
			'wp_generate_password'            => array(
				'length'              => 12,
				'special_chars'       => true,
				'extra_special_chars' => false,
			),
			'wp_rand'                         => array(
				'min' => 0,
				'max' => 0,
			),
			'wp_set_password'                 => array( 'password', 'user_id' ),
			'get_avatar'                      => array(
				'id_or_email',
				'size'    => 96,
				'default' => '',
				'alt'     => '',
				'args'    => null,
			),
			'wp_text_diff'                    => array(
				'left_string',
				'right_string',
				'args' => null,
			),

			// wp-admin/includes/schema.php:
			'install_network'                 => array(),

			// wp-admin/includes/upgrade.php:
			'wp_install'                      => array(
				'blog_title',
				'user_name',
				'user_email',
				'public',
				'deprecated'    => '',
				'user_password' => '',
				'language'      => '',
			),
			'wp_install_defaults'             => array( 'user_id' ),
			'wp_new_blog_notification'        => array( 'blog_title', 'blog_url', 'user_id', 'password' ),
			'wp_upgrade'                      => array(),
			'install_global_terms'            => array(),
		);

		// Pluggable function signatures are not tested when an external object cache is in use. See #31491.
		if ( ! wp_using_ext_object_cache() ) {
			$signatures = array_merge(
				$signatures,
				array(

					// wp-includes/cache.php:
					'wp_cache_add'                       => array(
						'key',
						'data',
						'group'  => '',
						'expire' => 0,
					),
					'wp_cache_close'                     => array(),
					'wp_cache_decr'                      => array(
						'key',
						'offset' => 1,
						'group'  => '',
					),
					'wp_cache_delete'                    => array(
						'key',
						'group' => '',
					),
					'wp_cache_flush'                     => array(),
					'wp_cache_get'                       => array(
						'key',
						'group' => '',
						'force' => false,
						'found' => null,
					),
					'wp_cache_get_multiple'              => array(
						'keys',
						'group' => '',
						'force' => false,
					),
					'wp_cache_incr'                      => array(
						'key',
						'offset' => 1,
						'group'  => '',
					),
					'wp_cache_init'                      => array(),
					'wp_cache_replace'                   => array(
						'key',
						'data',
						'group'  => '',
						'expire' => 0,
					),
					'wp_cache_set'                       => array(
						'key',
						'data',
						'group'  => '',
						'expire' => 0,
					),
					'wp_cache_switch_to_blog'            => array( 'blog_id' ),
					'wp_cache_add_global_groups'         => array( 'groups' ),
					'wp_cache_add_non_persistent_groups' => array( 'groups' ),
					'wp_cache_reset'                     => array(),
				)
			);
		}

		return $signatures;
	}

}