A HitchHackers guide through WordPress

add_submenu_page

February 11, 2011 by Thorsten 0 Comments

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

Add a sub menu page

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

Parameters

string $parent_slug: The slug name for the parent menu (or the file name of a standard WordPress admin page)
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_submenu_page( $parent_slug, $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {

	global $submenu;

	global $menu;

	global $_wp_real_parent_file;

	global $_wp_submenu_nopriv;

	global $_registered_pages;

	global $_parent_pages;



	$menu_slug = plugin_basename( $menu_slug );

	$parent_slug = plugin_basename( $parent_slug);



	if ( isset( $_wp_real_parent_file[$parent_slug] ) )

		$parent_slug = $_wp_real_parent_file[$parent_slug];



	if ( !current_user_can( $capability ) ) {

		$_wp_submenu_nopriv[$parent_slug][$menu_slug] = true;

		return false;

	}



	// If the parent doesn't already have a submenu, add a link to the parent

	// as the first item in the submenu.  If the submenu file is the same as the

	// parent file someone is trying to link back to the parent manually.  In

	// this case, don't automatically add a link back to avoid duplication.

	if (!isset( $submenu[$parent_slug] ) && $menu_slug != $parent_slug  ) {

		foreach ( (array)$menu as $parent_menu ) {

			if ( $parent_menu[2] == $parent_slug && current_user_can( $parent_menu[1] ) )

				$submenu[$parent_slug][] = $parent_menu;

		}

	}



	$submenu[$parent_slug][] = array ( $menu_title, $capability, $menu_slug, $page_title );



	$hookname = get_plugin_page_hookname( $menu_slug, $parent_slug);

	if (!empty ( $function ) && !empty ( $hookname ))

		add_action( $hookname, $function );



	$_registered_pages[$hookname] = true;

	// backwards-compatibility for plugins using add_management page.  See wp-admin/admin.php for redirect from edit.php to tools.php

	if ( 'tools.php' == $parent_slug )

		$_registered_pages[get_plugin_page_hookname( $menu_slug, 'edit.php')] = true;



	// No parent as top level

	$_parent_pages[$menu_slug] = $parent_slug;



	return $hookname;

}

369

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

add_submenu_page, codex, id6ed24c26a3b0f0b015c3b6466903dd2b

add_site_option

February 11, 2011 by Thorsten 0 Comments

Definition:
function add_site_option( $option, $value ) {}

Add a new site option.

Existing options will not be updated. Note that prior to 3.3 this wasn’t the case.

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.

Return values

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

Defined filters

pre_add_site_option_$option
apply_filters( 'pre_add_site_option_' . $option, $value )

Source code

function add_site_option( $option, $value ) {

	global $wpdb;



	$value = apply_filters( 'pre_add_site_option_' . $option, $value );



	if ( !is_multisite() ) {

		$result = add_option( $option, $value );

	} else {

		$cache_key = "{$wpdb->siteid}:$option";



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

			return false;



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

		wp_cache_set( $cache_key, $value, 'site-options' );



		$_value = $value;

		$value = maybe_serialize( $value );

		$result = $wpdb->insert( $wpdb->sitemeta, array('site_id' => $wpdb->siteid, 'meta_key' => $option, 'meta_value' => $value ) );

		$value = $_value;

	}

367

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

add_site_option, ideb853dfc814fbfc8248b35ef2f9e0e3c, pre_add_site_option_$option

add_shortcode

February 11, 2011 by Thorsten 0 Comments

Definition:
function add_shortcode($tag, $func) {}

Add hook for shortcode tag.

There can only be one hook for each shortcode. Which means that if another plugin has a similar shortcode, it will override yours or yours will override theirs depending on which order the plugins are included and/or ran.

Parameters

string $tag: Shortcode tag to be searched in post content.
callable $func: Hook to run when shortcode is found.

Source code

function add_shortcode($tag, $func) {

	global $shortcode_tags;



	if ( is_callable($func) )

		$shortcode_tags[$tag] = $func;

}

365

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

add_shortcode, codex, id462a7f929ba7de8da3c18e8ef2ae3fbc

add_rewrite_tag

February 11, 2011 by Thorsten 0 Comments

Definition:
function add_rewrite_tag($tagname, $regex) {}

Add a new tag (like %postname%).

Warning: you must call this on init or earlier, otherwise the query var addition stuff won’t work.

Parameters

string $tagname
string $regex

Source code

function add_rewrite_tag($tagname, $regex) {

	//validation

	if ( strlen($tagname) < 3 || $tagname[0] != '%' || $tagname[strlen($tagname)-1] != '%' )

		return;



	$qv = trim($tagname, '%');



	global $wp_rewrite, $wp;

	$wp->add_query_var($qv);

	$wp_rewrite->add_rewrite_tag($tagname, $regex, $qv . '=');

}

363

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

add_rewrite_tag, id8e1382ec24424ad3fb22c79a57d7eb81

add_option_update_handler

February 11, 2011 by Thorsten 0 Comments

Definition:
function add_option_update_handler( $option_group, $option_name, $sanitize_callback = '' ) {}

Parameters

string $option_group: A settings group name. Should correspond to a whitelisted option key name. Default whitelisted option key names include “general,” “discussion,” and “reading,” among others.
string $option_name: The name of an option to sanitize and save.
unknown_type $sanitize_callback: A callback function that sanitizes the option’s value.

Source code

function add_option_update_handler( $option_group, $option_name, $sanitize_callback = '' ) {

	_deprecated_function( __FUNCTION__, '3.0', 'register_setting()' );

	return register_setting( $option_group, $option_name, $sanitize_callback );

}

361

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

add_option_update_handler, idae9dcd0df44d83689052180e8a64c95a

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.