Navigation API - Revision history

Devdocsbot: Protected "Navigation API": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

2022-06-24T02:29:06Z

Protected "Navigation API": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

← Older revision		Revision as of 02:29, 24 June 2022
(No difference)

Devdocsbot: Update migration status and path

2022-06-24T02:27:26Z

Update migration status and path

← Older revision		Revision as of 02:27, 24 June 2022
Line 1:		Line 1:
			{{Template:Migrated\|newDocId=/docs/apis/core/navigation/}}
	==Overview==		==Overview==
	The Navigation API allows for the manipulation of the navigation system used in Moodle.		The Navigation API allows for the manipulation of the navigation system used in Moodle.

Mudrd8mz: Text replacement - "`" to ""`


2021-07-14T13:36:39Z
Text replacement - "<code php>" to "<syntaxhighlight lang="php">"

				
				
				
				
				
				← Older revision
				Revision as of 13:36, 14 July 2021
				
Line 35:
Line 35:



Nearly every page sets $PAGE->url through a call to '''$PAGE->set_url''' however not many explicitly set the context, course, or cm. When you call '''require_login''' with a course or cm it automatically calls the following: Nearly every page sets $PAGE->url through a call to '''$PAGE->set_url''' however not many explicitly set the context, course, or cm. When you call '''require_login''' with a course or cm it automatically calls the following:
<code php> <syntaxhighlight lang="php">
if ($cm) { if ($cm) {
     $PAGE->set_cm($cm, $course); // sets up global $COURSE      $PAGE->set_cm($cm, $course); // sets up global $COURSE
Line 62:
Line 62:
====Navigation==== ====Navigation====
This is extending the main navigation structure. This is extending the main navigation structure.
<code php> <syntaxhighlight lang="php">
$previewnode = $PAGE->navigation->add(get_string('preview'), new moodle_url('/a/link/if/you/want/one.php'), navigation_node::TYPE_CONTAINER); $previewnode = $PAGE->navigation->add(get_string('preview'), new moodle_url('/a/link/if/you/want/one.php'), navigation_node::TYPE_CONTAINER);
$thingnode = $previewnode->add(get_string('name of thing'), new moodle_url('/a/link/if/you/want/one.php')); $thingnode = $previewnode->add(get_string('name of thing'), new moodle_url('/a/link/if/you/want/one.php'));
Line 72:
Line 72:
Next extending the navigation for the course. Next extending the navigation for the course.
For this you will need to know the course id and have called require_login($courseorid); so that the navigation is loaded for the course. For this you will need to know the course id and have called require_login($courseorid); so that the navigation is loaded for the course.
<code php> <syntaxhighlight lang="php">
$coursenode = $PAGE->navigation->find($courseid, navigation_node::TYPE_COURSE); $coursenode = $PAGE->navigation->find($courseid, navigation_node::TYPE_COURSE);
$thingnode = $coursenode->add(get_string('Name of thing'), new moodle_url('/a/link/if/you/want/one.php')); $thingnode = $coursenode->add(get_string('Name of thing'), new moodle_url('/a/link/if/you/want/one.php'));
Line 83:
Line 83:
====Settings navigation==== ====Settings navigation====
Adding to the settings navigation is very similar to navigation Adding to the settings navigation is very similar to navigation
<code php> <syntaxhighlight lang="php">
$settingnode = $PAGE->settingsnav->add(get_string('setting'), new moodle_url('/a/link/if/you/want/one.php'), navigation_node::TYPE_CONTAINER); $settingnode = $PAGE->settingsnav->add(get_string('setting'), new moodle_url('/a/link/if/you/want/one.php'), navigation_node::TYPE_CONTAINER);
$thingnode = $settingnode->add(get_string('Name of thing'), new moodle_url('/a/link/if/you/want/one.php')); $thingnode = $settingnode->add(get_string('Name of thing'), new moodle_url('/a/link/if/you/want/one.php'));
Line 97:
Line 97:
An example of adding a navigation folder to a settings.php for a block with a link to the settings page and a external page is bellow. An example of adding a navigation folder to a settings.php for a block with a link to the settings page and a external page is bellow.



<code php> <syntaxhighlight lang="php">
<?php <?php



Line 125:
Line 125:
====Navbar==== ====Navbar====
This is extending the settings navigation. This is extending the settings navigation.
<code php> <syntaxhighlight lang="php">
$PAGE->navbar->ignore_active(); $PAGE->navbar->ignore_active();
$PAGE->navbar->add(get_string('preview'), new moodle_url('/a/link/if/you/want/one.php')); $PAGE->navbar->add(get_string('preview'), new moodle_url('/a/link/if/you/want/one.php'));
Line 139:
Line 139:
====Module==== ====Module====
Modules have two call-back methods, first to extend the navigation, and second to extend the settings. These call-backs get called when ever the user is viewing a page within the module and should only extend the navigation for the module. Modules have two call-back methods, first to extend the navigation, and second to extend the settings. These call-backs get called when ever the user is viewing a page within the module and should only extend the navigation for the module.
<code php> <syntaxhighlight lang="php">
function {modulename}_extend_navigation(${modulename}node, $course, $module, $cm) function {modulename}_extend_navigation(${modulename}node, $course, $module, $cm)
function {modulename}_extend_settings_navigation($settings, ${modulename}node) function {modulename}_extend_settings_navigation($settings, ${modulename}node)
Line 168:
Line 168:
====Local Plugins==== ====Local Plugins====
{{Moodle 2.9}}Local plugins have two call-back methods, first to extend the navigation, and second to extend the settings. {{Moodle 2.9}}Local plugins have two call-back methods, first to extend the navigation, and second to extend the settings.
<code php> <syntaxhighlight lang="php">
function local_{pluginname}_extend_navigation(global_navigation $nav) function local_{pluginname}_extend_navigation(global_navigation $nav)
function local_{pluginname}_extend_settings_navigation(settings_navigation $nav, context $context) function local_{pluginname}_extend_settings_navigation(settings_navigation $nav, context $context)
Line 175:
Line 175:
In versions before Moodle 2.9, the supported callbacks have <tt>_extends_</tt> (not imperative mood) in their names. This was a consistency bug fixed in MDL-49643. In versions before Moodle 2.9, the supported callbacks have <tt>_extends_</tt> (not imperative mood) in their names. This was a consistency bug fixed in MDL-49643.



<code php> <syntaxhighlight lang="php">
function local_{pluginname}_extends_navigation(global_navigation $nav) function local_{pluginname}_extends_navigation(global_navigation $nav)
function local_{pluginname}_extends_settings_navigation(settings_navigation $nav, context $context) function local_{pluginname}_extends_settings_navigation(settings_navigation $nav, context $context)
Line 184:
Line 184:
Any plugin implementing the following callback in lib.php can extend the course settings navigation. Prior to 3.0 only ''reports'' and ''admin tools'' could extend the course settings navigation. Any plugin implementing the following callback in lib.php can extend the course settings navigation. Prior to 3.0 only ''reports'' and ''admin tools'' could extend the course settings navigation.



<code php> <syntaxhighlight lang="php">
function <component>_extend_navigation_course(navigation_node $parentnode, stdClass $course, context_course $context); function <component>_extend_navigation_course(navigation_node $parentnode, stdClass $course, context_course $context);
</syntaxhighlight> </syntaxhighlight>
Line 192:
Line 192:
Any plugin implementing the following callback in lib.php can extend the user settings navigation. Prior to 3.0 only ''admin tools'' could extend the user settings navigation. Any plugin implementing the following callback in lib.php can extend the user settings navigation. Prior to 3.0 only ''admin tools'' could extend the user settings navigation.



<code php> <syntaxhighlight lang="php">
function <component>_extend_navigation_user_settings(navigation_node $parentnode, stdClass $user, context_user $context, stdClass $course, context_course $coursecontext); function <component>_extend_navigation_user_settings(navigation_node $parentnode, stdClass $user, context_user $context, stdClass $course, context_course $coursecontext);
</syntaxhighlight> </syntaxhighlight>
Line 200:
Line 200:
Any plugin implementing the following callback in lib.php can extend the category settings navigation. Any plugin implementing the following callback in lib.php can extend the category settings navigation.



<code php> <syntaxhighlight lang="php">
function <component>_extend_navigation_category_settings(navigation_node $parentnode, context_coursecat $context); function <component>_extend_navigation_category_settings(navigation_node $parentnode, context_coursecat $context);
</syntaxhighlight> </syntaxhighlight>
Line 208:
Line 208:
Any plugin implementing the following callback in lib.php can extend the frontpage settings navigation. Prior to 3.0 only ''admin tools'' could extend the frontpage settings navigation. Any plugin implementing the following callback in lib.php can extend the frontpage settings navigation. Prior to 3.0 only ''admin tools'' could extend the frontpage settings navigation.



<code php> <syntaxhighlight lang="php">
function <component>_extend_navigation_frontpage(navigation_node $parentnode, stdClass $course, context_course $context); function <component>_extend_navigation_frontpage(navigation_node $parentnode, stdClass $course, context_course $context);
</syntaxhighlight> </syntaxhighlight>
Line 215:
Line 215:
{{Moodle 3.1}} {{Moodle 3.1}}
Any plugin implementing the following callback in lib.php can extend the user profile navigation. Any plugin implementing the following callback in lib.php can extend the user profile navigation.
<code php> <syntaxhighlight lang="php">
function <component>_extend_navigation_user(navigation_node $parentnode, stdClass $user, context_user $context, stdClass $course, context_course $coursecontext); function <component>_extend_navigation_user(navigation_node $parentnode, stdClass $user, context_user $context, stdClass $course, context_course $coursecontext);
</syntaxhighlight> </syntaxhighlight>
Line 228:
Line 228:



The first thing to do here is check the URL you are setting for the page. It should match the URL your page has within the navigation. If it doesn't you have two options, first change your '''$PAGE->set_url''' call, or second override the URL the navigation is using to find the active node as shown below: The first thing to do here is check the URL you are setting for the page. It should match the URL your page has within the navigation. If it doesn't you have two options, first change your '''$PAGE->set_url''' call, or second override the URL the navigation is using to find the active node as shown below:
<code php> <syntaxhighlight lang="php">
navigation_node::override_active_url(new moodle_url('/your/url/here.php', array('param'=>'value'))); navigation_node::override_active_url(new moodle_url('/your/url/here.php', array('param'=>'value')));
</syntaxhighlight> </syntaxhighlight>
Line 236:
Line 236:
After creating a node and adding it to the navigation tree - you can set the property 'showinflatnavigation' to true in order for this node to be displayed in the flat navigation.   After creating a node and adding it to the navigation tree - you can set the property 'showinflatnavigation' to true in order for this node to be displayed in the flat navigation.  



<code php> <syntaxhighlight lang="php">
$node = navigation_node::create(...); $node = navigation_node::create(...);
$node->showinflatnavigation = true; $node->showinflatnavigation = true;

`Mudrd8mz: Text replacement - "`" to ""

2021-07-14T13:04:16Z

Text replacement - "</code>" to "</syntaxhighlight>"

← Older revision		Revision as of 13:04, 14 July 2021
Line 40:		Line 40:
	} else {		} else {
	$PAGE->set_course($course);// sets up global $COURSE		$PAGE->set_course($course);// sets up global $COURSE
	</~~code~~>		</syntaxhighlight>

	A page will only be required to explicitly set a context, course, or cm under one of these conditions:		A page will only be required to explicitly set a context, course, or cm under one of these conditions:
Line 66:		Line 66:
	$thingnode = $previewnode->add(get_string('name of thing'), new moodle_url('/a/link/if/you/want/one.php'));		$thingnode = $previewnode->add(get_string('name of thing'), new moodle_url('/a/link/if/you/want/one.php'));
	$thingnode->make_active();		$thingnode->make_active();
	</~~code~~>		</syntaxhighlight>
	The above lines of code adds a preview node to the bottom of the navigation and then adds a thingnode to the previewnode (adding a leaf to our tree).		The above lines of code adds a preview node to the bottom of the navigation and then adds a thingnode to the previewnode (adding a leaf to our tree).
	The final line of code makes the thingnode active so that the navbar finds it however if the URL you give it is the same as the url you set for the page it will automatically be marked active and you won't need this call.		The final line of code makes the thingnode active so that the navbar finds it however if the URL you give it is the same as the url you set for the page it will automatically be marked active and you won't need this call.
Line 76:		Line 76:
	$thingnode = $coursenode->add(get_string('Name of thing'), new moodle_url('/a/link/if/you/want/one.php'));		$thingnode = $coursenode->add(get_string('Name of thing'), new moodle_url('/a/link/if/you/want/one.php'));
	$thingnode->make_active();		$thingnode->make_active();
	</~~code~~>		</syntaxhighlight>
	The new bit of code here really is the first line which simply finds the course node, to do this we give it the course id and the node type in this case TYPE_COURSE.		The new bit of code here really is the first line which simply finds the course node, to do this we give it the course id and the node type in this case TYPE_COURSE.
	What we are doing here is relying on the navigation to generate the navigation up to the course and then just adding to the course.		What we are doing here is relying on the navigation to generate the navigation up to the course and then just adding to the course.
Line 87:		Line 87:
	$thingnode = $settingnode->add(get_string('Name of thing'), new moodle_url('/a/link/if/you/want/one.php'));		$thingnode = $settingnode->add(get_string('Name of thing'), new moodle_url('/a/link/if/you/want/one.php'));
	$thingnode->make_active();		$thingnode->make_active();
	</~~code~~>		</syntaxhighlight>

	====Add Settings folder to navigation====		====Add Settings folder to navigation====
Line 121:		Line 121:
	// Prevent Moodle from adding settings block in standard location.		// Prevent Moodle from adding settings block in standard location.
	$settings = null;		$settings = null;
	</~~code~~>		</syntaxhighlight>

	====Navbar====		====Navbar====
Line 129:		Line 129:
	$PAGE->navbar->add(get_string('preview'), new moodle_url('/a/link/if/you/want/one.php'));		$PAGE->navbar->add(get_string('preview'), new moodle_url('/a/link/if/you/want/one.php'));
	$PAGE->navbar->add(get_string('name of thing'), new moodle_url('/a/link/if/you/want/one.php'));		$PAGE->navbar->add(get_string('name of thing'), new moodle_url('/a/link/if/you/want/one.php'));
	</~~code~~>		</syntaxhighlight>
	The above code tells the navbar to ignore what ever the active page was and just use what you add, at which point we add two items as shown.		The above code tells the navbar to ignore what ever the active page was and just use what you add, at which point we add two items as shown.

Line 142:		Line 142:
	function {modulename}_extend_navigation(${modulename}node, $course, $module, $cm)		function {modulename}_extend_navigation(${modulename}node, $course, $module, $cm)
	function {modulename}_extend_settings_navigation($settings, ${modulename}node)		function {modulename}_extend_settings_navigation($settings, ${modulename}node)
	</~~code~~>		</syntaxhighlight>

	You may be required to add a node in a specified order within the menu navigation menus. To do this you need to examine the node object as given in the respective parameters in the functions above, then find the key of the childnode you wish to place the link before. For example, applying the code below will put a direct link to grade report.		You may be required to add a node in a specified order within the menu navigation menus. To do this you need to examine the node object as given in the respective parameters in the functions above, then find the key of the childnode you wish to place the link before. For example, applying the code below will put a direct link to grade report.
Line 157:		Line 157:
	}		}
	...		...
	</~~code~~>		</syntaxhighlight>


Line 171:		Line 171:
	function local_{pluginname}_extend_navigation(global_navigation $nav)		function local_{pluginname}_extend_navigation(global_navigation $nav)
	function local_{pluginname}_extend_settings_navigation(settings_navigation $nav, context $context)		function local_{pluginname}_extend_settings_navigation(settings_navigation $nav, context $context)
	</~~code~~>		</syntaxhighlight>

	In versions before Moodle 2.9, the supported callbacks have <tt>_extends_</tt> (not imperative mood) in their names. This was a consistency bug fixed in MDL-49643.		In versions before Moodle 2.9, the supported callbacks have <tt>_extends_</tt> (not imperative mood) in their names. This was a consistency bug fixed in MDL-49643.
Line 178:		Line 178:
	function local_{pluginname}_extends_navigation(global_navigation $nav)		function local_{pluginname}_extends_navigation(global_navigation $nav)
	function local_{pluginname}_extends_settings_navigation(settings_navigation $nav, context $context)		function local_{pluginname}_extends_settings_navigation(settings_navigation $nav, context $context)
	</~~code~~>		</syntaxhighlight>

	====Course settings====		====Course settings====
Line 186:		Line 186:
	<code php>		<code php>
	function <component>_extend_navigation_course(navigation_node $parentnode, stdClass $course, context_course $context);		function <component>_extend_navigation_course(navigation_node $parentnode, stdClass $course, context_course $context);
	</~~code~~>		</syntaxhighlight>

	====User settings====		====User settings====
Line 194:		Line 194:
	<code php>		<code php>
	function <component>_extend_navigation_user_settings(navigation_node $parentnode, stdClass $user, context_user $context, stdClass $course, context_course $coursecontext);		function <component>_extend_navigation_user_settings(navigation_node $parentnode, stdClass $user, context_user $context, stdClass $course, context_course $coursecontext);
	</~~code~~>		</syntaxhighlight>

	====Category settings====		====Category settings====
Line 202:		Line 202:
	<code php>		<code php>
	function <component>_extend_navigation_category_settings(navigation_node $parentnode, context_coursecat $context);		function <component>_extend_navigation_category_settings(navigation_node $parentnode, context_coursecat $context);
	</~~code~~>		</syntaxhighlight>

	====Frontpage settings====		====Frontpage settings====
Line 210:		Line 210:
	<code php>		<code php>
	function <component>_extend_navigation_frontpage(navigation_node $parentnode, stdClass $course, context_course $context);		function <component>_extend_navigation_frontpage(navigation_node $parentnode, stdClass $course, context_course $context);
	</~~code~~>		</syntaxhighlight>

	====User profile====		====User profile====
Line 217:		Line 217:
	<code php>		<code php>
	function <component>_extend_navigation_user(navigation_node $parentnode, stdClass $user, context_user $context, stdClass $course, context_course $coursecontext);		function <component>_extend_navigation_user(navigation_node $parentnode, stdClass $user, context_user $context, stdClass $course, context_course $coursecontext);
	</~~code~~>		</syntaxhighlight>

	=== Boost ===		=== Boost ===
Line 230:		Line 230:
	<code php>		<code php>
	navigation_node::override_active_url(new moodle_url('/your/url/here.php', array('param'=>'value')));		navigation_node::override_active_url(new moodle_url('/your/url/here.php', array('param'=>'value')));
	</~~code~~>		</syntaxhighlight>

	'''Q.''' How do I add a node to the "flat" navigation in the Boost theme for Moodle 3.2?		'''Q.''' How do I add a node to the "flat" navigation in the Boost theme for Moodle 3.2?
Line 240:		Line 240:
	$node->showinflatnavigation = true;		$node->showinflatnavigation = true;
	$navigation->add_node($node);		$navigation->add_node($node);
	</~~code~~>		</syntaxhighlight>

	This is highly discouraged because the number of nodes in this flat navigation has been deliberately restricted to a very small number of the most important links that are applicable to all user roles. Adding more links to this menu will make it harder to use, inconsistent for different users and inconsistent for different sites. Consider carefully if you really need to fill an additional 230x44 pixels of every single page in Moodle for every single user with a link to your thing. There are many other places to include links to your thing and most are automatically built from the navigation tree without forcing nodes to display in the flat navigation. E.g. settings menu of a course, profile page, preferences page, reports etc.		This is highly discouraged because the number of nodes in this flat navigation has been deliberately restricted to a very small number of the most important links that are applicable to all user roles. Adding more links to this menu will make it harder to use, inconsistent for different users and inconsistent for different sites. Consider carefully if you really need to fill an additional 230x44 pixels of every single page in Moodle for every single user with a link to your thing. There are many other places to include links to your thing and most are automatically built from the navigation tree without forcing nodes to display in the flat navigation. E.g. settings menu of a course, profile page, preferences page, reports etc.

Mudrd8mz: Text replacement - "`" to ""`


2021-07-14T13:02:52Z
Text replacement - "<code>" to "<syntaxhighlight lang="php">"

				
				
				
				
				
				← Older revision
				Revision as of 13:02, 14 July 2021
				
Line 145:
Line 145:



You may be required to add a node in a specified order within the menu navigation menus. To do this you need to examine the node object as given in the respective parameters in the functions above, then find the key of the childnode you wish to place the link before. For example, applying the code below will put a direct link to grade report.   You may be required to add a node in a specified order within the menu navigation menus. To do this you need to examine the node object as given in the respective parameters in the functions above, then find the key of the childnode you wish to place the link before. For example, applying the code below will put a direct link to grade report.  
<code> <syntaxhighlight lang="php">
function my_plugin_extend_settings_navigation($settingsnav, $context){ function my_plugin_extend_settings_navigation($settingsnav, $context){
     if(($context->contextlevel === 50) &&      if(($context->contextlevel === 50) &&



Mudrd8mz: /* How the navigation works */ Fix the confusing "or greater" expression
2020-09-02T10:04:26Z
How the navigation works:  Fix the confusing "or greater" expression

				
				
				
				
				
				← Older revision
				Revision as of 10:04, 2 September 2020
				
Line 30:
Line 30:
The main navigation structure can be accessed through '''$PAGE->navigation'''.  The navigation and settings are contextual in that they will relate to the page that the user is viewing. This is determined by other $PAGE object properties: The main navigation structure can be accessed through '''$PAGE->navigation'''.  The navigation and settings are contextual in that they will relate to the page that the user is viewing. This is determined by other $PAGE object properties:
* '''$PAGE->context''' is a Moodle context that immediately outlines the nature of the page the user is viewing. * '''$PAGE->context''' is a Moodle context that immediately outlines the nature of the page the user is viewing.
* '''$PAGE->course''' is the course the user is viewing.  This is essential if the context is CONTEXT_COURSE or greater.  However, it is also useful in other contexts such as CONTEXT_USER. * '''$PAGE->course''' is the course the user is viewing.  This is essential if the context is CONTEXT_COURSE or anything within it.  However, it is also useful in other contexts such as CONTEXT_USER.
* '''$PAGE->cm''' is the course module instance.  This is essential if the context is CONTEXT_MODULE or greater. * '''$PAGE->cm''' is the course module instance.  This is essential if the context is CONTEXT_MODULE.
* '''$PAGE->url''' is used to match the active navigation item.   * '''$PAGE->url''' is used to match the active navigation item.  






Moohipp at 14:36, 11 June 2018
2018-06-11T14:36:05Z


				
				
				
				
				
				← Older revision
				Revision as of 14:36, 11 June 2018
				
Line 143:
Line 143:
function {modulename}_extend_settings_navigation($settings, ${modulename}node) function {modulename}_extend_settings_navigation($settings, ${modulename}node)
</code> </code>

You may be required to add a node in a specified order within the menu navigation menus. To do this you need to examine the node object as given in the respective parameters in the functions above, then find the key of the childnode you wish to place the link before. For example, applying the code below will put a direct link to grade report. 
<code>
function my_plugin_extend_settings_navigation($settingsnav, $context){
    if(($context->contextlevel === 50) &&
        has_capability('gradereport/grader:view', $context)){
        $id = $context->instanceid;
        $urltext = get_string('gradereportlink', 'myplugin');
        $url = new moodle_url($CFG->wwwroot . '/grade/report/grader/index.php', array('id'=>$id));
        $coursesettingsnode = $settingsnav->find('courseadmin', null);   // 'courseadmin' is the menu key
        $node = $coursesettingsnode->create($urltext, $url, navigation_node::NODETYPE_LEAF, null, 'gradebook',  new pix_icon('i/report', 'grades'));
        $coursesettingsnode->add_node($node,  'gradebooksetup'); //'gradebooksetup' is an where you put the link before
    }
...
</code>




====Course Formats==== ====Course Formats====



Damyon: /* What the navigation is */
2017-09-06T05:16:44Z
What the navigation is

				
				
				
				
				
				← Older revision
				Revision as of 05:16, 6 September 2017
				
Line 13:
Line 13:
A conceptual view of the information architecture that sits behind the navigation tree is here: A conceptual view of the information architecture that sits behind the navigation tree is here:



[[File:Moodle Information Architecture.png|200px|thumb|center|Information Architecture]] [[File:Moodle-IA.png|200px|thumb|center|Information Architecture]]



This diagram represents the major entities and how they are related to each other. Examples are given of the type of functions available on each kind of entity. This diagram represents the major entities and how they are related to each other. Examples are given of the type of functions available on each kind of entity.



Damyon: /* What the navigation is */
2017-09-06T05:14:56Z
What the navigation is

				
				
				
				
				
				← Older revision
				Revision as of 05:14, 6 September 2017
				
Line 13:
Line 13:
A conceptual view of the information architecture that sits behind the navigation tree is here: A conceptual view of the information architecture that sits behind the navigation tree is here:



[[File:Moodle Information Architecture.png|600px|thumb|Information Architecture]] [[File:Moodle Information Architecture.png|200px|thumb|center|Information Architecture]]



This diagram represents the major entities and how they are related to each other. Examples are given of the type of functions available on each kind of entity. This diagram represents the major entities and how they are related to each other. Examples are given of the type of functions available on each kind of entity.





Damyon: /* What the navigation is */
2017-09-06T05:12:42Z
What the navigation is

				
				
				
				
				
				← Older revision
				Revision as of 05:12, 6 September 2017
				
Line 13:
Line 13:
A conceptual view of the information architecture that sits behind the navigation tree is here: A conceptual view of the information architecture that sits behind the navigation tree is here:



[[File:Moodle Information Architecture.png]] [[File:Moodle Information Architecture.png|600px|thumb|Information Architecture]]
 
This diagram represents the major entities and how they are related to each other. Examples are given of the type of functions available on each kind of entity.



==What the navigation is not== ==What the navigation is not==

← Older revision		Revision as of 13:36, 14 July 2021
Line 35:		Line 35:

	Nearly every page sets $PAGE->url through a call to '''$PAGE->set_url''' however not many explicitly set the context, course, or cm. When you call '''require_login''' with a course or cm it automatically calls the following:		Nearly every page sets $PAGE->url through a call to '''$PAGE->set_url''' however not many explicitly set the context, course, or cm. When you call '''require_login''' with a course or cm it automatically calls the following:
	<~~code~~ php>		<syntaxhighlight lang="php">
	if ($cm) {		if ($cm) {
	$PAGE->set_cm($cm, $course); // sets up global $COURSE		$PAGE->set_cm($cm, $course); // sets up global $COURSE
Line 62:		Line 62:
	====Navigation====		====Navigation====
	This is extending the main navigation structure.		This is extending the main navigation structure.
	<~~code~~ php>		<syntaxhighlight lang="php">
	$previewnode = $PAGE->navigation->add(get_string('preview'), new moodle_url('/a/link/if/you/want/one.php'), navigation_node::TYPE_CONTAINER);		$previewnode = $PAGE->navigation->add(get_string('preview'), new moodle_url('/a/link/if/you/want/one.php'), navigation_node::TYPE_CONTAINER);
	$thingnode = $previewnode->add(get_string('name of thing'), new moodle_url('/a/link/if/you/want/one.php'));		$thingnode = $previewnode->add(get_string('name of thing'), new moodle_url('/a/link/if/you/want/one.php'));
Line 72:		Line 72:
	Next extending the navigation for the course.		Next extending the navigation for the course.
	For this you will need to know the course id and have called require_login($courseorid); so that the navigation is loaded for the course.		For this you will need to know the course id and have called require_login($courseorid); so that the navigation is loaded for the course.
	<~~code~~ php>		<syntaxhighlight lang="php">
	$coursenode = $PAGE->navigation->find($courseid, navigation_node::TYPE_COURSE);		$coursenode = $PAGE->navigation->find($courseid, navigation_node::TYPE_COURSE);
	$thingnode = $coursenode->add(get_string('Name of thing'), new moodle_url('/a/link/if/you/want/one.php'));		$thingnode = $coursenode->add(get_string('Name of thing'), new moodle_url('/a/link/if/you/want/one.php'));
Line 83:		Line 83:
	====Settings navigation====		====Settings navigation====
	Adding to the settings navigation is very similar to navigation		Adding to the settings navigation is very similar to navigation
	<~~code~~ php>		<syntaxhighlight lang="php">
	$settingnode = $PAGE->settingsnav->add(get_string('setting'), new moodle_url('/a/link/if/you/want/one.php'), navigation_node::TYPE_CONTAINER);		$settingnode = $PAGE->settingsnav->add(get_string('setting'), new moodle_url('/a/link/if/you/want/one.php'), navigation_node::TYPE_CONTAINER);
	$thingnode = $settingnode->add(get_string('Name of thing'), new moodle_url('/a/link/if/you/want/one.php'));		$thingnode = $settingnode->add(get_string('Name of thing'), new moodle_url('/a/link/if/you/want/one.php'));
Line 97:		Line 97:
	An example of adding a navigation folder to a settings.php for a block with a link to the settings page and a external page is bellow.		An example of adding a navigation folder to a settings.php for a block with a link to the settings page and a external page is bellow.

	<~~code~~ php>		<syntaxhighlight lang="php">
	<?php		<?php

Line 125:		Line 125:
	====Navbar====		====Navbar====
	This is extending the settings navigation.		This is extending the settings navigation.
	<~~code~~ php>		<syntaxhighlight lang="php">
	$PAGE->navbar->ignore_active();		$PAGE->navbar->ignore_active();
	$PAGE->navbar->add(get_string('preview'), new moodle_url('/a/link/if/you/want/one.php'));		$PAGE->navbar->add(get_string('preview'), new moodle_url('/a/link/if/you/want/one.php'));
Line 139:		Line 139:
	====Module====		====Module====
	Modules have two call-back methods, first to extend the navigation, and second to extend the settings. These call-backs get called when ever the user is viewing a page within the module and should only extend the navigation for the module.		Modules have two call-back methods, first to extend the navigation, and second to extend the settings. These call-backs get called when ever the user is viewing a page within the module and should only extend the navigation for the module.
	<~~code~~ php>		<syntaxhighlight lang="php">
	function {modulename}_extend_navigation(${modulename}node, $course, $module, $cm)		function {modulename}_extend_navigation(${modulename}node, $course, $module, $cm)
	function {modulename}_extend_settings_navigation($settings, ${modulename}node)		function {modulename}_extend_settings_navigation($settings, ${modulename}node)
Line 168:		Line 168:
	====Local Plugins====		====Local Plugins====
	{{Moodle 2.9}}Local plugins have two call-back methods, first to extend the navigation, and second to extend the settings.		{{Moodle 2.9}}Local plugins have two call-back methods, first to extend the navigation, and second to extend the settings.
	<~~code~~ php>		<syntaxhighlight lang="php">
	function local_{pluginname}_extend_navigation(global_navigation $nav)		function local_{pluginname}_extend_navigation(global_navigation $nav)
	function local_{pluginname}_extend_settings_navigation(settings_navigation $nav, context $context)		function local_{pluginname}_extend_settings_navigation(settings_navigation $nav, context $context)
Line 175:		Line 175:
	In versions before Moodle 2.9, the supported callbacks have <tt>_extends_</tt> (not imperative mood) in their names. This was a consistency bug fixed in MDL-49643.		In versions before Moodle 2.9, the supported callbacks have <tt>_extends_</tt> (not imperative mood) in their names. This was a consistency bug fixed in MDL-49643.

	<~~code~~ php>		<syntaxhighlight lang="php">
	function local_{pluginname}_extends_navigation(global_navigation $nav)		function local_{pluginname}_extends_navigation(global_navigation $nav)
	function local_{pluginname}_extends_settings_navigation(settings_navigation $nav, context $context)		function local_{pluginname}_extends_settings_navigation(settings_navigation $nav, context $context)
Line 184:		Line 184:
	Any plugin implementing the following callback in lib.php can extend the course settings navigation. Prior to 3.0 only ''reports'' and ''admin tools'' could extend the course settings navigation.		Any plugin implementing the following callback in lib.php can extend the course settings navigation. Prior to 3.0 only ''reports'' and ''admin tools'' could extend the course settings navigation.

	<~~code~~ php>		<syntaxhighlight lang="php">
	function <component>_extend_navigation_course(navigation_node $parentnode, stdClass $course, context_course $context);		function <component>_extend_navigation_course(navigation_node $parentnode, stdClass $course, context_course $context);
	</syntaxhighlight>		</syntaxhighlight>
Line 192:		Line 192:
	Any plugin implementing the following callback in lib.php can extend the user settings navigation. Prior to 3.0 only ''admin tools'' could extend the user settings navigation.		Any plugin implementing the following callback in lib.php can extend the user settings navigation. Prior to 3.0 only ''admin tools'' could extend the user settings navigation.

	<~~code~~ php>		<syntaxhighlight lang="php">
	function <component>_extend_navigation_user_settings(navigation_node $parentnode, stdClass $user, context_user $context, stdClass $course, context_course $coursecontext);		function <component>_extend_navigation_user_settings(navigation_node $parentnode, stdClass $user, context_user $context, stdClass $course, context_course $coursecontext);
	</syntaxhighlight>		</syntaxhighlight>
Line 200:		Line 200:
	Any plugin implementing the following callback in lib.php can extend the category settings navigation.		Any plugin implementing the following callback in lib.php can extend the category settings navigation.

	<~~code~~ php>		<syntaxhighlight lang="php">
	function <component>_extend_navigation_category_settings(navigation_node $parentnode, context_coursecat $context);		function <component>_extend_navigation_category_settings(navigation_node $parentnode, context_coursecat $context);
	</syntaxhighlight>		</syntaxhighlight>
Line 208:		Line 208:
	Any plugin implementing the following callback in lib.php can extend the frontpage settings navigation. Prior to 3.0 only ''admin tools'' could extend the frontpage settings navigation.		Any plugin implementing the following callback in lib.php can extend the frontpage settings navigation. Prior to 3.0 only ''admin tools'' could extend the frontpage settings navigation.

	<~~code~~ php>		<syntaxhighlight lang="php">
	function <component>_extend_navigation_frontpage(navigation_node $parentnode, stdClass $course, context_course $context);		function <component>_extend_navigation_frontpage(navigation_node $parentnode, stdClass $course, context_course $context);
	</syntaxhighlight>		</syntaxhighlight>
Line 215:		Line 215:
	{{Moodle 3.1}}		{{Moodle 3.1}}
	Any plugin implementing the following callback in lib.php can extend the user profile navigation.		Any plugin implementing the following callback in lib.php can extend the user profile navigation.
	<~~code~~ php>		<syntaxhighlight lang="php">
	function <component>_extend_navigation_user(navigation_node $parentnode, stdClass $user, context_user $context, stdClass $course, context_course $coursecontext);		function <component>_extend_navigation_user(navigation_node $parentnode, stdClass $user, context_user $context, stdClass $course, context_course $coursecontext);
	</syntaxhighlight>		</syntaxhighlight>
Line 228:		Line 228:

	The first thing to do here is check the URL you are setting for the page. It should match the URL your page has within the navigation. If it doesn't you have two options, first change your '''$PAGE->set_url''' call, or second override the URL the navigation is using to find the active node as shown below:		The first thing to do here is check the URL you are setting for the page. It should match the URL your page has within the navigation. If it doesn't you have two options, first change your '''$PAGE->set_url''' call, or second override the URL the navigation is using to find the active node as shown below:
	<~~code~~ php>		<syntaxhighlight lang="php">
	navigation_node::override_active_url(new moodle_url('/your/url/here.php', array('param'=>'value')));		navigation_node::override_active_url(new moodle_url('/your/url/here.php', array('param'=>'value')));
	</syntaxhighlight>		</syntaxhighlight>
Line 236:		Line 236:
	After creating a node and adding it to the navigation tree - you can set the property 'showinflatnavigation' to true in order for this node to be displayed in the flat navigation.		After creating a node and adding it to the navigation tree - you can set the property 'showinflatnavigation' to true in order for this node to be displayed in the flat navigation.

	<~~code~~ php>		<syntaxhighlight lang="php">
	$node = navigation_node::create(...);		$node = navigation_node::create(...);
	$node->showinflatnavigation = true;		$node->showinflatnavigation = true;

← Older revision		Revision as of 13:02, 14 July 2021
Line 145:		Line 145:

	You may be required to add a node in a specified order within the menu navigation menus. To do this you need to examine the node object as given in the respective parameters in the functions above, then find the key of the childnode you wish to place the link before. For example, applying the code below will put a direct link to grade report.		You may be required to add a node in a specified order within the menu navigation menus. To do this you need to examine the node object as given in the respective parameters in the functions above, then find the key of the childnode you wish to place the link before. For example, applying the code below will put a direct link to grade report.
	<~~code~~>		<syntaxhighlight lang="php">
	function my_plugin_extend_settings_navigation($settingsnav, $context){		function my_plugin_extend_settings_navigation($settingsnav, $context){
	if(($context->contextlevel === 50) &&		if(($context->contextlevel === 50) &&

← Older revision		Revision as of 10:04, 2 September 2020
Line 30:		Line 30:
	The main navigation structure can be accessed through '''$PAGE->navigation'''. The navigation and settings are contextual in that they will relate to the page that the user is viewing. This is determined by other $PAGE object properties:		The main navigation structure can be accessed through '''$PAGE->navigation'''. The navigation and settings are contextual in that they will relate to the page that the user is viewing. This is determined by other $PAGE object properties:
	* '''$PAGE->context''' is a Moodle context that immediately outlines the nature of the page the user is viewing.		* '''$PAGE->context''' is a Moodle context that immediately outlines the nature of the page the user is viewing.
	* '''$PAGE->course''' is the course the user is viewing. This is essential if the context is CONTEXT_COURSE or ~~greater~~. However, it is also useful in other contexts such as CONTEXT_USER.		* '''$PAGE->course''' is the course the user is viewing. This is essential if the context is CONTEXT_COURSE or anything within it. However, it is also useful in other contexts such as CONTEXT_USER.
	* '''$PAGE->cm''' is the course module instance. This is essential if the context is CONTEXT_MODULE ~~or greater~~.		* '''$PAGE->cm''' is the course module instance. This is essential if the context is CONTEXT_MODULE.
	* '''$PAGE->url''' is used to match the active navigation item.		* '''$PAGE->url''' is used to match the active navigation item.

← Older revision		Revision as of 05:16, 6 September 2017
Line 13:		Line 13:
	A conceptual view of the information architecture that sits behind the navigation tree is here:		A conceptual view of the information architecture that sits behind the navigation tree is here:

	[[File:Moodle ~~Information Architecture~~.png\|200px\|thumb\|center\|Information Architecture]]		[[File:Moodle-IA.png\|200px\|thumb\|center\|Information Architecture]]

	This diagram represents the major entities and how they are related to each other. Examples are given of the type of functions available on each kind of entity.		This diagram represents the major entities and how they are related to each other. Examples are given of the type of functions available on each kind of entity.

← Older revision		Revision as of 05:14, 6 September 2017
Line 13:		Line 13:
	A conceptual view of the information architecture that sits behind the navigation tree is here:		A conceptual view of the information architecture that sits behind the navigation tree is here:

	[[File:Moodle Information Architecture.png\|~~600px~~\|thumb\|Information Architecture]]		[[File:Moodle Information Architecture.png\|200px\|thumb\|center\|Information Architecture]]

	This diagram represents the major entities and how they are related to each other. Examples are given of the type of functions available on each kind of entity.		This diagram represents the major entities and how they are related to each other. Examples are given of the type of functions available on each kind of entity.

← Older revision		Revision as of 05:12, 6 September 2017
Line 13:		Line 13:
	A conceptual view of the information architecture that sits behind the navigation tree is here:		A conceptual view of the information architecture that sits behind the navigation tree is here:

	[[File:Moodle Information Architecture.png]]		[[File:Moodle Information Architecture.png\|600px\|thumb\|Information Architecture]]

			This diagram represents the major entities and how they are related to each other. Examples are given of the type of functions available on each kind of entity.

	==What the navigation is not==		==What the navigation is not==

Navigation API - Revision history

Devdocsbot: Protected "Navigation API": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

Devdocsbot: Update migration status and path

Mudrd8mz: Text replacement - "" to ""

Mudrd8mz: Text replacement - "" to ""

Mudrd8mz: Text replacement - "" to ""

Mudrd8mz: /* How the navigation works */ Fix the confusing "or greater" expression

Moohipp at 14:36, 11 June 2018

Damyon: /* What the navigation is */

Damyon: /* What the navigation is */

Damyon: /* What the navigation is */

Mudrd8mz: Text replacement - "`" to ""`

`Mudrd8mz: Text replacement - "`" to ""

Mudrd8mz: Text replacement - "`" to ""`