wp_set_auth_cookie

Definition:
function wp_set_auth_cookie($user_id, $remember = false, $secure = '') {}

Sets the authentication cookies based User ID.
The $remember parameter increases the time that the cookie will be kept. The default the cookie is kept without remembering is two days. When $remember is set, the cookies will be kept for 14 days or two weeks.

Parameters

  • int $user_id: User ID
  • bool $remember: Whether to remember the user
  • $secure

Defined filters

  • auth_cookie_expiration
    apply_filters('auth_cookie_expiration', 1209600, $user_id, $remember)
  • auth_cookie_expiration
    apply_filters('auth_cookie_expiration', 172800, $user_id, $remember)
  • secure_auth_cookie
    apply_filters('secure_auth_cookie', $secure, $user_id)
  • secure_logged_in_cookie
    apply_filters('secure_logged_in_cookie', false, $user_id, $secure)

Defined actions

  • set_auth_cookie
    do_action('set_auth_cookie', $auth_cookie, $expire, $expiration, $user_id, $scheme);
  • set_logged_in_cookie
    do_action('set_logged_in_cookie', $logged_in_cookie, $expire, $expiration, $user_id, 'logged_in');

Source code

function wp_set_auth_cookie($user_id, $remember = false, $secure = '') {

	if ( $remember ) {

		$expiration = $expire = time() + apply_filters('auth_cookie_expiration', 1209600, $user_id, $remember);

	} else {

		$expiration = time() + apply_filters('auth_cookie_expiration', 172800, $user_id, $remember);

		$expire = 0;

	}



	if ( '' === $secure )

		$secure = is_ssl();



	$secure = apply_filters('secure_auth_cookie', $secure, $user_id);

	$secure_logged_in_cookie = apply_filters('secure_logged_in_cookie', false, $user_id, $secure);



	if ( $secure ) {

		$auth_cookie_name = SECURE_AUTH_COOKIE;

		$scheme = 'secure_auth';

	} else {

		$auth_cookie_name = AUTH_COOKIE;

		$scheme = 'auth';

	}



	$auth_cookie = wp_generate_auth_cookie($user_id, $expiration, $scheme);

	$logged_in_cookie = wp_generate_auth_cookie($user_id, $expiration, 'logged_in');



	do_action('set_auth_cookie', $auth_cookie, $expire, $expiration, $user_id, $scheme);

	do_action('set_logged_in_cookie', $logged_in_cookie, $expire, $expiration, $user_id, 'logged_in');



	setcookie($auth_cookie_name, $auth_cookie, $expire, PLUGINS_COOKIE_PATH, COOKIE_DOMAIN, $secure, true);

	setcookie($auth_cookie_name, $auth_cookie, $expire, ADMIN_COOKIE_PATH, COOKIE_DOMAIN, $secure, true);

	setcookie(LOGGED_IN_COOKIE, $logged_in_cookie, $expire, COOKIEPATH, COOKIE_DOMAIN, $secure_logged_in_cookie, true);

	if ( COOKIEPATH != SITECOOKIEPATH )

		setcookie(LOGGED_IN_COOKIE, $logged_in_cookie, $expire, SITECOOKIEPATH, COOKIE_DOMAIN, $secure_logged_in_cookie, true);

}

4099

wp_setup_nav_menu_item

Definition:
function wp_setup_nav_menu_item( $menu_item ) {}

Decorates a menu item object with the shared navigation menu item properties.
Properties:

Parameters

  • object $menu_item: The menu item to modify.

Return values

returns:The menu item with standard menu item properties.

Defined filters

  • nav_menu_attr_title
    apply_filters( 'nav_menu_attr_title', $menu_item->post_excerpt )
  • nav_menu_description
    apply_filters( 'nav_menu_description', wp_trim_words( $menu_item->post_content, 200 )
  • nav_menu_attr_title
    apply_filters( 'nav_menu_attr_title', '' )
  • nav_menu_description
    apply_filters( 'nav_menu_description', '' )
  • wp_setup_nav_menu_item
    apply_filters( 'wp_setup_nav_menu_item', $menu_item )

Source code

function wp_setup_nav_menu_item( $menu_item ) {

	if ( isset( $menu_item->post_type ) ) {

		if ( 'nav_menu_item' == $menu_item->post_type ) {

			$menu_item->db_id = (int) $menu_item->ID;

			$menu_item->menu_item_parent = empty( $menu_item->menu_item_parent ) ? get_post_meta( $menu_item->ID, '_menu_item_menu_item_parent', true ) : $menu_item->menu_item_parent;

			$menu_item->object_id = empty( $menu_item->object_id ) ? get_post_meta( $menu_item->ID, '_menu_item_object_id', true ) : $menu_item->object_id;

			$menu_item->object = empty( $menu_item->object ) ? get_post_meta( $menu_item->ID, '_menu_item_object', true ) : $menu_item->object;

			$menu_item->type = empty( $menu_item->type ) ? get_post_meta( $menu_item->ID, '_menu_item_type', true ) : $menu_item->type;



			if ( 'post_type' == $menu_item->type ) {

				$object = get_post_type_object( $menu_item->object );

				if ( $object ) {

					$menu_item->type_label = $object->labels->singular_name;

				} else {

					$menu_item->type_label = $menu_item->object;

					$menu_item->_invalid = true;

				}



				$menu_item->url = get_permalink( $menu_item->object_id );



				$original_object = get_post( $menu_item->object_id );

				$original_title = $original_object->post_title;

				$menu_item->title = '' == $menu_item->post_title ? $original_title : $menu_item->post_title;



			} elseif ( 'taxonomy' == $menu_item->type ) {

				$object = get_taxonomy( $menu_item->object );

				if ( $object ) {

					$menu_item->type_label = $object->labels->singular_name;

				} else {

					$menu_item->type_label = $menu_item->object;

					$menu_item->_invalid = true;

				}



				$term_url = get_term_link( (int) $menu_item->object_id, $menu_item->object );

				$menu_item->url = !is_wp_error( $term_url ) ? $term_url : '';



				$original_title = get_term_field( 'name', $menu_item->object_id, $menu_item->object, 'raw' );

				if ( is_wp_error( $original_title ) )

					$original_title = false;

				$menu_item->title = '' == $menu_item->post_title ? $original_title : $menu_item->post_title;



			} else {

				$menu_item->type_label = __('Custom');

				$menu_item->title = $menu_item->post_title;

				$menu_item->url = empty( $menu_item->url ) ? get_post_meta( $menu_item->ID, '_menu_item_url', true ) : $menu_item->url;

			}



			$menu_item->target = empty( $menu_item->target ) ? get_post_meta( $menu_item->ID, '_menu_item_target', true ) : $menu_item->target;



			$menu_item->attr_title = empty( $menu_item->attr_title ) ? apply_filters( 'nav_menu_attr_title', $menu_item->post_excerpt ) : $menu_item->attr_title;



			if ( empty( $menu_item->description ) )

				$menu_item->description = apply_filters( 'nav_menu_description',  wp_trim_words( $menu_item->post_content, 200 ) );



			$menu_item->classes = empty( $menu_item->classes ) ? (array) get_post_meta( $menu_item->ID, '_menu_item_classes', true ) : $menu_item->classes;

			$menu_item->xfn = empty( $menu_item->xfn ) ? get_post_meta( $menu_item->ID, '_menu_item_xfn', true ) : $menu_item->xfn;

		} else {

			$menu_item->db_id = 0;

			$menu_item->menu_item_parent = 0;

			$menu_item->object_id = (int) $menu_item->ID;

			$menu_item->type = 'post_type';



			$object = get_post_type_object( $menu_item->post_type );

			$menu_item->object = $object->name;

			$menu_item->type_label = $object->labels->singular_name;



			$menu_item->title = $menu_item->post_title;

			$menu_item->url = get_permalink( $menu_item->ID );

			$menu_item->target = '';



			$menu_item->attr_title = apply_filters( 'nav_menu_attr_title', '' );

			$menu_item->description = apply_filters( 'nav_menu_description', '' );

			$menu_item->classes = array();

			$menu_item->xfn = '';

		}

	} elseif ( isset( $menu_item->taxonomy ) ) {

		$menu_item->ID = $menu_item->term_id;

		$menu_item->db_id = 0;

		$menu_item->menu_item_parent = 0;

		$menu_item->object_id = (int) $menu_item->term_id;

		$menu_item->post_parent = (int) $menu_item->parent;

		$menu_item->type = 'taxonomy';



		$object = get_taxonomy( $menu_item->taxonomy );

		$menu_item->object = $object->name;

		$menu_item->type_label = $object->labels->singular_name;



		$menu_item->title = $menu_item->name;

		$menu_item->url = get_term_link( $menu_item, $menu_item->taxonomy );

		$menu_item->target = '';

		$menu_item->attr_title = '';

		$menu_item->description = get_term_field( 'description', $menu_item->term_id, $menu_item->taxonomy );

		$menu_item->classes = array();

		$menu_item->xfn = '';



	}



	return apply_filters( 'wp_setup_nav_menu_item', $menu_item );

}

4095

wp_setcookie

Definition:
function wp_setcookie($username, $password = '', $already_md5 = false, $home = '', $siteurl = '', $remember = false) {}

Sets a cookie for a user who just logged in. This function is deprecated.

Parameters

  • string $username: The user’s username
  • string $password: Optional. The user’s password
  • bool $already_md5: Optional. Whether the password has already been through MD5
  • string $home: Optional. Will be used instead of COOKIEPATH if set
  • string $siteurl: Optional. Will be used instead of SITECOOKIEPATH if set
  • bool $remember: Optional. Remember that the user is logged in

Source code

function wp_setcookie($username, $password = '', $already_md5 = false, $home = '', $siteurl = '', $remember = false) {

	_deprecated_function( __FUNCTION__, '2.5', 'wp_set_auth_cookie()' );

	$user = get_user_by('login', $username);

	wp_set_auth_cookie($user->ID, $remember);

}

4093

wp_script_is

Definition:
function wp_script_is( $handle, $list = 'queue' ) {}

Check whether script has been added to WordPress Scripts.
The values for list defaults to ‘queue’, which is the same as enqueue for scripts.

Parameters

  • string $handle: Handle used to add script.
  • string $list: Optional, defaults to ‘queue’. Others values are ‘registered’, ‘queue’, ‘done’, ‘to_do’

Source code

function wp_script_is( $handle, $list = 'queue' ) {

	global $wp_scripts;

	if ( ! is_a( $wp_scripts, 'WP_Scripts' ) ) {

		if ( ! did_action( 'init' ) )

			_doing_it_wrong( __FUNCTION__, sprintf( __( 'Scripts and styles should not be registered or enqueued until the %1$s, %2$s, or %3$s hooks.' ),

				'<code>wp_enqueue_scripts</code>', '<code>admin_enqueue_scripts</code>', '<code>init</code>' ), '3.3' );

		$wp_scripts = new WP_Scripts();

	}



	$query = $wp_scripts->query( $handle, $list );



	if ( is_object( $query ) )

		return true;



	return $query;

}

4091