A HitchHackers guide through WordPress

add_pages_page

February 11, 2011 by Thorsten 0 Comments

Definition:
function add_pages_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {}

Add sub menu page to the pages main menu.

This function takes a capability which will be used to determine whether or not a page is included in the menu.

Parameters

string $page_title: The text to be displayed in the title tags of the page when the menu is selected
string $menu_title: The text to be used for the menu
string $capability: The capability required for this menu to be displayed to the user.
string $menu_slug: The slug name to refer to this menu by (should be unique for this menu)
callback $function: The function to be called to output the content for this page.

Return values

returns:The resulting page’s hook_suffix, or false if the user does not have the capability required.

Source code

function add_pages_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {

	return add_submenu_page( 'edit.php?post_type=page', $page_title, $menu_title, $capability, $menu_slug, $function );

}

273

/wp-admin/includes/plugin.php, Documentation, Files, Functions, Functions by letter a

add_pages_page, idc92d4de0a54b5db2e6426cb85a225716

add_option_whitelist

February 11, 2011 by Thorsten 0 Comments

Definition:
function add_option_whitelist( $new_options, $options = '' ) {}

Parameters

unknown_type $new_options
unknown_type $options

Source code

function add_option_whitelist( $new_options, $options = '' ) {

	if ( $options == '' )

		global $whitelist_options;

	else

		$whitelist_options = $options;



	foreach ( $new_options as $page => $keys ) {

		foreach ( $keys as $key ) {

			if ( !isset($whitelist_options[ $page ]) || !is_array($whitelist_options[ $page ]) ) {

				$whitelist_options[ $page ] = array();

				$whitelist_options[ $page ][] = $key;

			} else {

				$pos = array_search( $key, $whitelist_options[ $page ] );

				if ( $pos === false )

					$whitelist_options[ $page ][] = $key;

			}

		}

	}



	return $whitelist_options;

}

271

/wp-admin/includes/plugin.php, Documentation, Files, Functions, Functions by letter a

add_option_whitelist, id14385f3654666fc1cea3ac34e94186e8

add_options_page

February 11, 2011 by Thorsten 0 Comments

Definition:
function add_options_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {}

Add sub menu page to the options main menu.

This function takes a capability which will be used to determine whether or not a page is included in the menu.

Parameters

string $page_title: The text to be displayed in the title tags of the page when the menu is selected
string $menu_title: The text to be used for the menu
string $capability: The capability required for this menu to be displayed to the user.
string $menu_slug: The slug name to refer to this menu by (should be unique for this menu)
callback $function: The function to be called to output the content for this page.

Return values

returns:The resulting page’s hook_suffix, or false if the user does not have the capability required.

Source code

function add_options_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {

	return add_submenu_page( 'options-general.php', $page_title, $menu_title, $capability, $menu_slug, $function );

}

267

/wp-admin/includes/plugin.php, Documentation, Files, Functions, Functions by letter a

add_options_page, id2834734cb367d48ba8ddd310ac251be3

add_option

February 11, 2011 by Thorsten 0 Comments

Definition:
function add_option( $option, $value = '', $deprecated = '', $autoload = 'yes' ) {}

Add a new option.

You do not need to serialize values. If the value needs to be serialized, then it will be serialized before it is inserted into the database. Remember, resources can not be serialized or added as an option.

Parameters

string $option: Name of option to add. Expected to not be SQL-escaped.
mixed $value: Optional. Option value, can be anything. Expected to not be SQL-escaped.
mixed $deprecated: Optional. Description. Not used anymore.
bool $autoload: Optional. Default is enabled. Whether to load the option when WordPress starts up.

Return values

returns:False if option was not added and true if option was added.

Defined actions

add_option
do_action( 'add_option', $option, $_value );
add_option_{$option}
do_action( "add_option_{$option}", $option, $_value );
added_option
do_action( 'added_option', $option, $_value );

Source code

function add_option( $option, $value = '', $deprecated = '', $autoload = 'yes' ) {

	global $wpdb;



	if ( !empty( $deprecated ) )

		_deprecated_argument( __FUNCTION__, '2.3' );



	$option = trim($option);

	if ( empty($option) )

		return false;



	wp_protect_special_option( $option );



	if ( is_object($value) )

		$value = clone $value;



	$value = sanitize_option( $option, $value );



	// Make sure the option doesn't already exist. We can check the 'notoptions' cache before we ask for a db query

	$notoptions = wp_cache_get( 'notoptions', 'options' );

	if ( !is_array( $notoptions ) || !isset( $notoptions[$option] ) )

		if ( false !== get_option( $option ) )

			return false;



	$_value = $value;

	$value = maybe_serialize( $value );

	$autoload = ( 'no' === $autoload ) ? 'no' : 'yes';

	do_action( 'add_option', $option, $_value );

	if ( ! defined( 'WP_INSTALLING' ) ) {

		if ( 'yes' == $autoload ) {

			$alloptions = wp_load_alloptions();

			$alloptions[$option] = $value;

			wp_cache_set( 'alloptions', $alloptions, 'options' );

		} else {

			wp_cache_set( $option, $value, 'options' );

		}

	}



	// This option exists now

	$notoptions = wp_cache_get( 'notoptions', 'options' ); // yes, again... we need it to be fresh

	if ( is_array( $notoptions ) && isset( $notoptions[$option] ) ) {

		unset( $notoptions[$option] );

		wp_cache_set( 'notoptions', $notoptions, 'options' );

	}



	$result = $wpdb->query( $wpdb->prepare( "INSERT INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, %s) ON DUPLICATE KEY UPDATE `option_name` = VALUES(`option_name`), `option_value` = VALUES(`option_value`), `autoload` = VALUES(`autoload`)", $option, $value, $autoload ) );



	if ( $result ) {

		do_action( "add_option_{$option}", $option, $_value );

		do_action( 'added_option', $option, $_value );

		return true;

	}

265

/wp-includes/functions.php, Actions, Actions by letter a, Documentation, Files, Functions, Functions by letter a

added_option, add_option, add_option_{$option}, codex, id144b1cf337fc90cb0fbb5566f4f70d8d

add_new_user_to_blog

February 11, 2011 by Thorsten 0 Comments

Definition:
function add_new_user_to_blog( $user_id, $email, $meta ) {}

Add a newly created user to the appropriate blog

Parameters

int $user_id
string $email
array $meta

Source code

function add_new_user_to_blog( $user_id, $email, $meta ) {

	global $current_site;

	if ( !empty( $meta[ 'add_to_blog' ] ) ) {

		$blog_id = $meta[ 'add_to_blog' ];

		$role = $meta[ 'new_role' ];

		remove_user_from_blog($user_id, $current_site->blog_id); // remove user from main blog.

		add_user_to_blog( $blog_id, $user_id, $role );

		update_user_meta( $user_id, 'primary_blog', $blog_id );

	}

}

261

/wp-includes/ms-functions.php, Documentation, Files, Functions, Functions by letter a

add_new_user_to_blog, codex, id1549e16e93d0521d860e8ce67a92350d

Newer Entries

Older Entries

Ouch, we don’t have this here!

It seems that we do not have anything about this topic here, but you might want to do one of the following. If you were searching for a php function head over to the php manual and use one of their entry points

If you were searching for a WordPress related topic and did not find it here try one of the following options.

Use the search form in the navigation bar above
Use the WordPress search

If nothing like this helps try using Google or an other search engine

Google
Bing

Golden Q&A rules

Search first

Be sure that you first search in Google, the WordPress forums, Codex or this site ( using the form in the menu ). Sharing your previous results helps narrowing down the problem if you also tell us what you found and why it didn’t serve your needs.

Be specific

Give as much details about your problem as possible. Make sure to include examples, links and context related to your problem.

Be WordPress related

This site focuses on WordPress and related topics. Please make sure that your question is related to WordPress code, functionality or other related topics.

Be nice

Please keep in mind that this is a voluntary service. Answers might not always be correct or what you expect. Please be nice and let us know if any inappropriate answers come to your attention.